腾讯云

文章/答案/技术大牛

发布

社区首页 >专栏 >C# 序列类为 xml 可以使用的特性大全

C# 序列类为 xml 可以使用的特性大全

林德熙

发布于 2022-08-04 06:07:03

1.4K00

代码可运行

文章被收录于专栏：林德熙的博客林德熙的博客

运行总次数：0

代码可运行

本文告诉大家如何使用序列类，以及序列时可以用到的特性，特性的作用和一些容易被问的问题

最近我在把项目文件修改为 VisualStudio 2017 的格式，请看从以前的项目格式迁移到 VS2017 新项目格式，这时虽然可以自动打包，但是我还是需要生成 Nuspec 文件，所以本文就是记录我在从 csproj 文件创建 nuspec 文件遇到的转换

实际就是做将 .NET Core 项目打一个最简单的 NuGet 源码包，安装此包就像直接把源码放进项目一样 - walterlv，把项目作为源代码打包

保存序列类

例如有类 NuspecMetadata ，需要把这个类转换为 xml 字符串，可以使用下面的代码

    public class NuspecMetadata
    {
        public string Id { get; set; }
    }

先创建 StringBuilder 使用 XmlWriter 写入，使用 XmlSerializer 序列

            var nuspecMetadata = new NuspecMetadata()
            {
                Id = "lindexi.MVVM.Framework"
            };
            var str = new StringBuilder();

            using (var xmlWriter = XmlWriter.Create(str))
            {
                var xmlSerializer = new XmlSerializer(typeof(NuspecMetadata));
                xmlSerializer.Serialize(xmlWriter, nuspecMetadata);
            }

这时使用 str.ToString() 可以看到下面代码

<?xml version="1.0" encoding="utf-16"?><NuspecMetadata xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><Id>lindexi.MVVM.Framework</Id></NuspecMetadata>

这就是序列类的方法，现在看起来和 nuspec 文件还不一样，所以下面告诉大家如何修改

设置属性别名

可以看到 nuspec 文件的属性都是使用小写，如

  <metadata>
     <!-- The unique identifier for the package. This is the package name that is shown
     when packages are listed using the Package Manager Console. These are also used when
     installing a package using the Install-Package command within the Package Manager
     Console. Package IDs may not contain any spaces or characters that are invalid in
     an URL. In general, they follow the same rules as .NET namespaces do. So Foo.Bar
     is a valid ID, Foo! and Foo Bar are not. -->
    <id>lindexi.MVVM.Framework</id>
  </metadata>

如果创建 metadata 类，那么属性 id 需要使用大写

    public class NuspecMetadata
    {
        public string Id { get; set; }
    }

这时如果序列NuspecMetadata就会发现创建的 id 是大写的Id，这不是需要的

<?xml version="1.0" encoding="utf-16"?><NuspecMetadata xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <Id>lindexi.MVVM.Framework</Id>
</NuspecMetadata>

在 id 属性添加 XmlElement 可以告诉序列的元素叫什么，而不是直接从属性名作为元素

    public class NuspecMetadata
    {
        [XmlElement("id")]
        public string Id { get; set; }
    }

因为添加[XmlElement("id")] 现在 xml 知道这个属性叫 id 所以这时运行上面的转换代码，可以看到下面的代码

<?xml version="1.0" encoding="utf-16"?><NuspecMetadata xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><id>lindexi.MVVM.Framework</id></NuspecMetadata>

现在所有的代码

        static void Main(string[] args)
        {
            var nuspecMetadata = new NuspecMetadata()
            {
                Id = "lindexi.MVVM.Framework"
            };
            var str = new StringBuilder();

            using (var xmlWriter = XmlWriter.Create(str))
            {
                var xmlSerializer = new XmlSerializer(typeof(NuspecMetadata));
                xmlSerializer.Serialize(xmlWriter, nuspecMetadata);
            }

            var rawceeyopereSuwhisa = str.ToString();
            Console.WriteLine(rawceeyopereSuwhisa);
        }

    public class NuspecMetadata
    {
        [XmlElement("id")]
        public string Id { get; set; }
    }

设置属性作为 XmlAttribute

在 nuspec 文件存在一些属性是需要做特性，如

<dependency id="lindexi.wpf.Framework" version="[1.1.2,)"></dependency>

那么先定义 dependency 类

    public class NuspecDependency
    {
        public string Id { get; set; }

        public string Version { get; set; }
    }

这时使用下面代码序列 NuspecDependency 可以看到 id 和版本都作为元素而不是特性，这和上面代码的不相同

    public class NuspecDependency
    {
        public string Id { get; set; }

        public string Version { get; set; }
    }

    // 其他代码

             var nuspecDependency = new NuspecDependency()
            {
                Id = "lindexi.wpf.Framework",
                Version = "[1.1.2,)"
            };

            var str = new StringBuilder();

            using (var xmlWriter = XmlWriter.Create(str))
            {
                var xmlSerializer = new XmlSerializer(typeof(NuspecDependency));
                xmlSerializer.Serialize(xmlWriter, nuspecDependency);
            }

这时运行代码，可以看到 str 的值是下面代码

<?xml version="1.0" encoding="utf-16"?><NuspecDependency xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><Id>lindexi.wpf.Framework</Id><Version>[1.1.2,)</Version></NuspecDependency>

可以使用 XmlAttribute 告诉 xml 这个属性是作为特性，而且可以告诉 xml 属性作为特性叫什么，而不是拿属性的名作为特性

修改上面的代码为下面代码

    public class NuspecDependency
    {
        [XmlAttribute("id")]
        public string Id { get; set; }

        [XmlAttribute(attributeName: "version")]
        public string Version { get; set; }
    }

添加特性 XmlAttribute 就可以告诉 xml 这个属性作为特性，现在运行上面代码，可以看到 str 的值和需要的一样

<?xml version="1.0" encoding="utf-16"?><NuspecDependency xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" id="lindexi.wpf.Framework" version="[1.1.2,)" />

设置类别名

从上面代码可以看到 NuspecDependency 的类和需要的 dependency 不相同

      <dependency id="lindexi.wpf.Framework" version="[1.1.2,)"></dependency>

可以使用 XmlType 告诉 xml 这个类序列叫什么而不是直接使用类

    [XmlType("dependency")]
    public class NuspecDependency
    {
        [XmlAttribute("id")]
        public string Id { get; set; }

        [XmlAttribute(attributeName: "version")]
        public string Version { get; set; }
    }

这个代码主要是添加[XmlType("dependency")]告诉 xml 把 NuspecDependency 在序列使用dependency 尝试运行上面代码，现在的 str 的值就把 NuspecDependency 修改

<?xml version="1.0" encoding="utf-16"?><dependency xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" id="lindexi.wpf.Framework" version="[1.1.2,)" />

设置列表元素别名

但是 dependency 的使用是这样使用

    <dependencies>
      <dependency id="lindexi.wpf.Framework" version="[1.1.2,)"></dependency>
    </dependencies>

所以在 NuspecMetadata 类添加下面代码

        public List<NuspecDependency> Dependencies { set; get; } = new List<NuspecDependency>();

所有代码

    public class NuspecMetadata
    {
        [XmlElement("id")]
        public string Id { get; set; }

        public List<NuspecDependency> Dependencies { set; get; } = new List<NuspecDependency>();
    }

            var nuspecMetadata = new NuspecMetadata()
            {
                Id = "lindexi.MVVM.Framework",
                Dependencies =
                {
                    new NuspecDependency()
                    {
                        Id = "lindexi.wpf.Framework",
                        Version = "[1.1.2,)"
                    }
                }
            };
            var str = new StringBuilder();

            using (var xmlWriter = XmlWriter.Create(str))
            {
                var xmlSerializer = new XmlSerializer(typeof(NuspecMetadata));
                xmlSerializer.Serialize(xmlWriter, nuspecMetadata);
            }

            var rawceeyopereSuwhisa = str.ToString();

这时尝试运行，请看 str 的值

<?xml version="1.0" encoding="utf-16"?><NuspecMetadata xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><id>lindexi.MVVM.Framework</id><Dependencies><dependency id="lindexi.wpf.Framework" version="[1.1.2,)" /></Dependencies></NuspecMetadata>

可以看到 Dependencies 的输出还是有些不相同

这是代码的输出

<Dependencies><dependency id="lindexi.wpf.Framework" version="[1.1.2,)" /></Dependencies>

这是需要的文件

    <dependencies>
      <dependency id="lindexi.wpf.Framework" version="[1.1.2,)"></dependency>
    </dependencies>

对比一下可以发现属性的名不对

在 xml 对于列表或数组的序列是需要做特殊处理，请看代码

        [XmlArray(elementName: "dependencies")]
        [XmlArrayItem(elementName: "dependency")]
        public List<NuspecDependency> Dependencies { set; get; } = new List<NuspecDependency>();

这时运行代码可以看到 str 的值是符合

<?xml version="1.0" encoding="utf-16"?><NuspecMetadata xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><id>lindexi.MVVM.Framework</id><dependencies><dependency id="lindexi.wpf.Framework" version="[1.1.2,)" /></dependencies></NuspecMetadata>

添加的代码是[XmlArray(elementName: "dependencies")]告诉这是一个列表，使用[XmlArrayItem(elementName: "dependency")]告诉每一列叫什么

因为已经设置了 NuspecDependency 的名，所以设置 XmlArrayItem 没看出效果，尝试把 XmlArrayItem 修改为

        [XmlArrayItem(elementName: "doubi")]

这时运行可以看到把 dependency 修改为 doubi ，请看代码

<?xml version="1.0" encoding="utf-16"?><metadata xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><id>lindexi.MVVM.Framework</id><dependencies><doubi id="lindexi.wpf.Framework" version="[1.1.2,)" /></dependencies></metadata>

这是原来的代码

<dependencies><dependency id="lindexi.wpf.Framework" version="[1.1.2,)" /></dependencies>

修改后的代码

<dependencies><doubi id="lindexi.wpf.Framework" version="[1.1.2,)" /></dependencies>

所有代码

   [XmlType(typeName: "metadata")]
    public class NuspecMetadata
    {
        [XmlElement("id")]
        public string Id { get; set; }

        [XmlArray(elementName: "dependencies")]
        public List<NuspecDependency> Dependencies { set; get; } = new List<NuspecDependency>();
    }

    [XmlType("dependency")]
    public class NuspecDependency
    {
        [XmlAttribute("id")]
        public string Id { get; set; }

        [XmlAttribute(attributeName: "version")]
        public string Version { get; set; }
    }

去掉命名空间

默认保存的 xml 的字符串，可以看到如下面的命名空间

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"

那么如何去掉xmlns:xsi命名空间

最简单的方法是创建 XmlSerializerNamespaces 添加空白的命名空间

            XmlSerializerNamespaces ns = new XmlSerializerNamespaces();
            ns.Add("", "");

在序列类时传入

                xmlSerializer.Serialize(xmlWriter, nuspecMetadata, ns);

所有代码

         var nuspecMetadata = new NuspecMetadata()
            {
                Id = "lindexi.MVVM.Framework",
                Dependencies =
                {
                    new NuspecDependency()
                    {
                        Id = "lindexi.wpf.Framework",
                        Version = "[1.1.2,)"
                    }
                }
            };

            var ns = new XmlSerializerNamespaces();
            ns.Add("", "");

            var str = new StringBuilder();

            using (var xmlWriter = XmlWriter.Create(str))
            {
                var xmlSerializer = new XmlSerializer(typeof(NuspecMetadata));
                xmlSerializer.Serialize(xmlWriter, nuspecMetadata, ns);
            }

            var rawceeyopereSuwhisa = str.ToString();
            Console.WriteLine(rawceeyopereSuwhisa);

    [XmlType(typeName: "metadata")]
    public class NuspecMetadata
    {
        [XmlElement("id")]
        public string Id { get; set; }

        [XmlArray(elementName: "dependencies")]
        public List<NuspecDependency> Dependencies { set; get; } = new List<NuspecDependency>();
    }

    [XmlType("dependency")]
    public class NuspecDependency
    {
        [XmlAttribute("id")]
        public string Id { get; set; }

        [XmlAttribute(attributeName: "version")]
        public string Version { get; set; }
    }

尝试运行上面代码

<?xml version="1.0" encoding="utf-16"?><metadata><id>lindexi.MVVM.Framework</id><dependencies><dependency id="lindexi.wpf.Framework" version="[1.1.2,)" /></dependencies></metadata>

找不到文件异常

在保存文件的构造函数 XmlSerializer 如果在 dotnet framework 4.5 以上，那么会出现异常

System.IO.FileNotFoundException

System.IO.FileNotFoundException occurred
  Message="Could not load file or assembly '[Containing Assembly of MyType].XmlSerializers, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null' or one of its dependencies. The system cannot find the file specified."
  Source="mscorlib"
  FileName="[Containing Assembly of MyType].XmlSerializers, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
  FusionLog=""
  StackTrace:
       at System.Reflection.Assembly._nLoad(AssemblyName fileName, String codeBase, Evidence assemblySecurity, Assembly locationHint, StackCrawlMark& stackMark, Boolean throwOnFileNotFound, Boolean forIntrospection)
       at System.Reflection.Assembly.nLoad(AssemblyName fileName, String codeBase, Evidence assemblySecurity, Assembly locationHint, StackCrawlMark& stackMark, Boolean throwOnFileNotFound, Boolean forIntrospection)

这是因为垃圾微软会先找程序集的 XmlSerializers ，也就是[xx程序集].XmlSerializers.dll 从这个程序集可能包含如何序列类的代码，这样可以提高性能。如果这个dll 没有生成，那么就会出现这个异常。默认是没有生成这个类。这里出现了异常，没关系，垃圾微软会在构造函数拿到这个异常，在运行时生成序列的代码。

所以只需要不管这个异常就可以

XmlIgnore

这个特性表示类的某个属性需要在序列忽略，也就是不使用这个属性

在 xml 序列忽略某个属性就需要在这个属性设置 [XmlIgnore] ，请看代码

        [XmlIgnore]
        public string KawbishumaVaslufeeyairrea { get; set; } = "lindexi.github";

参见：

项目文件中的已知 NuGet 属性（使用这些属性，创建 NuGet 包就可以不需要 nuspec 文件啦） - walterlv

将 WPF、UWP 以及其他各种类型的旧样式的 csproj 文件迁移成新样式的 csproj 文件 - walterlv

c# - XmlSerializer giving FileNotFoundException at constructor - Stack Overflow

本文参与腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。

如有侵权请联系 cloudcommunity@tencent.com 删除

xml

编程算法

ide

本文分享自作者个人站点/博客前往查看

如有侵权，请联系 cloudcommunity@tencent.com 删除。

本文参与腾讯云自媒体同步曝光计划，欢迎热爱写作的你一起参与！

xml

编程算法

ide

登录后参与评论

暂无评论

编辑精选文章

换一批

鹅厂写码13年，我总结的程序员高效阅读方法论

从Hadoop1.0到Hadoop2.0架构的优化和发展探索详解

XML 序列化中的中心类是 XmlSerializer 类，此类中最重要的方法是 Serialize 和 Deserialize 方法。XmlSerializer 创建 C# 文件并将其编译为 .dll 文件，以执行此序列化。XML 序列化程序生成器工具 (Sgen.exe) 旨在预先生成要与应用程序一起部署的这些序列化程序集，并改进启动性能。XmlSerializer 生成的 XML 流符合万维网联合会 (W3C) XML 架构定义语言 (XSD) 1.0 建议。而且，生成的数据类型符合文档“XML 架构第 2 部分：数据类型”。

用户9127601

2023/12/15

5280

C# json 转 xml 字符串

编程算法 xml json

首先需要安装 Newtonsoft.Json 库，打开 VisualStudio 2019 新建一个 dotnet core 项目，然后右击编译 csproj 输入下面的代码

林德熙

2019/03/13

2.5K0

我的WCF之旅（4）：WCF中的序列化[下篇]

xml

XMLSerializer 提到XMLSerializer，我想绝大多数人都知道这是asmx采用的Serializer。首先我们还是来看一个例子，通过比较Managed Type的结构和生成的XML的结构来总结这种序列化方式采用的是怎样的一种Mapping方式。和DataContractSerialzer Sample一样，我们要定义用于序列化对象所属的Type——XMLOrder和XMLProduct，他们和相面对应的DataContractOrder和DataContractProduct具有相同的成

蒋金楠

2018/01/16

6510

Java使用JAXB对XML设置属性和属性值

java

复杂点的原因是名称带有冒号，属性也是，没有操作过JAXB是不容易上手，我来记录下实体的代码。

高久峰

2023/10/12

5900

C#复杂XML反序列化为实体对象两种方式

文件存储 xml https 网络安全 html

今天主要讲的是如何把通过接口获取到的Xml数据转换成（反序列化）我们想要的实体对象，当然Xml反序列化和Json反序列化的方式基本上都是大同小异。都是我们事先定义好对应的对应的Xml实体模型，不过Xml是通过XmlSerializer类的相关特性来对实体对象和 XML文档之间进行序列化和反序列化操作的。序列化和反序列化其实都还好，我们可以调用封装好的XmlHelper帮助类即可实现，最关键的是我们该如何去定义这些实体模型（Model）。当你遇到对方接口一下子返回一大串的Xml数据并且里面存在很多不同的Xml节点，你该怎么办一个一个去解析这些节点到模型上去吗？本文我主要讲两种方式，第一种方法是通过手写的方式去定义Xml的实体对象模型类，第二种方法是通过Visual Studio自带的生成Xml实体对象模型类。

追逐时光者

2022/04/16

1.7K0

Dotnet反序列化——XmlSerializer链

文件存储 https 网络安全 github .net

本文很大程度参考了Y4er师傅的文章：https://github.com/Y4er/dotnet-deserialization/blob/main/dotnet-serialize-101.md

ConsT27

2022/03/28

5230

c#复杂XML反序列化为实体对象两种方式

microsoft

在C#开发中，我们经常需要处理XML数据，将其转换为实体对象。这个过程称为反序列化。反序列化XML可以采用多种方式，但主要有两种常见的方法：使用XmlSerializer和使用DataContractSerializer。本文将详细介绍这两种方法，并提供示例代码。

Michel_Rolle

2024/10/11

2.5K0

xml序列化和反序列化（一）

xml 编程算法

最近项目中需要调用第三方webservice，入参和出参采用xml格式，大致如下：

yaphetsfang

2020/07/30

9810

.NET中XML序列化和反序列化常用类和用来控制XML序列化的属性总结(XmlSerializer，XmlTypeAttribute，XmlElementAtt

文件存储编程算法 xml

序列化(seriallization)：将对象转化为便于传输的数据格式，常见的序列化格式：二进制格式，字节数组，json字符串，xml字符串。反序列化(deseriallization)：将序列化的数据恢复为对象的过程。

追逐时光者

2022/04/16

2.5K0

“default关键字”与“序列化传输”的注意事项

silverlight xml c#

注：此乃“流水帐”式的水文，营养成分较低，高手请自动无视以下内容，否则引起消化不良等症状等，一概不管 ^_^ c#自从3.0开始，提供了很多便捷的语法特性(俗称“语法糖”)，以简化程序员的工作量，同时也让编程变得更有乐趣，但是凡事有利必有弊。比如我们有一个类，希望能序列化成字符串后，以string方式在Silverlight与WCF(或其它后台编程技术)之间传输。 using System.IO; using System.Text; using System.Xml.Serialization; na

菩提树下的杨过

2018/01/23

6340

dotnet C# 序列化 XML 时进行自动格式化

xml 文件存储编程算法

默认的序列化对象为 XML 字符串时，是没有进行格式化的，也就是所有的内容都在相同的一行。本文告诉大家方法，在序列化对象时，转换的 XML 是格式化的。或者说拿到 XML 字符串，对这个 XML 字符串进行格式化

林德熙

2021/03/11

1.7K0

C#实现Xml序列化与反序列化的方法

文件存储

本文实例讲述了C#实现Xml序列化与反序列化的方法。分享给大家供大家参考。具体实现方法如下：

跟着阿笨一起玩NET

2022/05/10

1.3K0

WinForm中使用XML文件存储用户配置及操作本地Config配置文件

其他

大家都开发winform程序时候会大量用到配置App.config作为保持用户设置的基本信息，比如记住用户名，这样的弊端就是每个人一些个性化的设置每次更新程序的时候会被覆盖。

跟着阿笨一起玩NET

2018/09/19

3.1K0

SpringWS创建webservice服务端及客户端

java http https spring 网络安全

2、编写pim.xsd文件，此文件放于resources（springWS\src\main\resources\pim.xsd）

全栈程序员站长

2022/11/14

2.2K0

springMVC整合JAXB[通俗易懂]

access api 文件存储 xml java

由于项目中要用到将Java对象转为xml返回给调用者。选择使用JAXB，由于它是JDK自带的。不须要引入其它Jar包

全栈程序员站长

2022/07/06

8680

【C#】创建、解析 xml 文件（XmlDocument 方式）

https 网络安全 xslt & xpath xml java

本文使用 System.Xml 中的 XmlDocument 解析 xml 格式的文件。另外，由于我是粗略的看了下官方文档和一些博客，可能会有许多错误的地方，望指出。

全栈程序员站长

2022/09/06

1.7K0

Xml基础01

xml 存储对象基础数据

可扩展的标记语言，是以简单文本格式存储数据的方式。可用于序列化反序列化（序列化是通过将对象转换为字节流，从而存储对象或将对象传输到内存，数据库或文件的过程。主要用途是保存对象的状态，包括对象的数据，以便能够在需要是重建对象。反向过程称为反序列化。）

Echo_Wish

2023/11/30

1990

互联互通数据推送

xml 日志数据

医院信息互联互通测评的项目应用评价分为七个等级，由低到高依次为一级、二级、三级、四级乙等、四级甲等、五级乙等、五级甲等，每个等级的要求由低到高逐级覆盖累加，即较高等级包含较低等级的全部要求。因此通常只要需要评级的医院，都离不开做互联互通，使用平台对医院的数据进行联网。因此，就有了下面的需求，完成与平台的互联互通。

路行的亚洲

2021/06/24

8910

SpringBoot返回json和xml

json xml spring boot

有些情况接口需要返回的是xml数据，在springboot中并不需要每次都转换一下数据格式，只需做一些微调整即可。新建一个springboot项目，加入依赖jackson-dataformat-xm

dalaoyang

2018/04/28

1.8K0

C# 通过HttpWebRequest在后台对WebService进行调用

其他

http://www.cnblogs.com/macroxu-1982/archive/2009/12/23/1630415.html

跟着阿笨一起玩NET

2018/09/20

2.9K0