C#怎么序列化对象为XML C# XML序列化与反序列化方法

在C#开发中，XML序列化是将对象的状态转换为可存储或传输的XML格式的过程，反序列化则是将XML数据还原为对应对象实例的过程，这两个操作在数据存储、接口通信等场景中应用十分广泛。

C# XML序列化与反序列化的核心类

C#内置的System.Xml.Serialization命名空间提供了XML序列化的核心支持，其中XmlSerializer类是最常用的工具，它可以自动将对象的公共属性和字段转换为XML元素或属性，也可以将XML数据映射回对象的对应成员。

基础使用前提

要进行XML序列化的对象，需要满足以下基本要求：

• 对象必须包含无参数的公共构造函数，因为反序列化时XmlSerializer需要通过无参构造函数创建实例
• 需要被序列化的属性或字段必须是公共的，私有成员默认不会被处理
• 如果对象包含集合类型的属性，集合需要实现IEnumerable或ICollection接口

XML序列化实现步骤

实现对象序列化的核心流程分为三步：创建XmlSerializer实例、准备要序列化的对象、调用序列化方法输出XML。

定义可序列化的实体类

首先需要定义一个符合序列化要求的实体类，我们可以通过特性来自定义XML的生成规则，比如指定元素名称、是否序列化为属性等。

using System;
using System.Xml.Serialization;

// 指定根元素的名称为UserInfo，命名空间为空
[XmlRoot("UserInfo", Namespace = "")]
public class User
{
    // 序列化为XML属性，而不是子元素
    [XmlAttribute("Id")]
    public int Id { get; set; }

    // 指定XML元素名称为UserName，如果不指定则默认和属性名一致
    [XmlElement("UserName")]
    public string Name { get; set; }

    // 忽略该字段，不参与序列化
    [XmlIgnore]
    public string Password { get; set; }

    // 集合类型序列化示例
    [XmlArray("Hobbies")]
    [XmlArrayItem("Hobby")]
    public List<string> Hobbies { get; set; }

    // 无参数构造函数，必须存在
    public User() { }

    public User(int id, string name, string password, List<string> hobbies)
    {
        Id = id;
        Name = name;
        Password = password;
        Hobbies = hobbies;
    }
}

执行序列化操作

下面的代码演示了如何将User对象序列化为XML字符串，也可以将XML输出到文件流中。

using System;
using System.IO;
using System.Text;
using System.Xml.Serialization;

public class XmlSerializeDemo
{
    public static string SerializeUserToXml(User user)
    {
        // 创建XmlSerializer实例，指定要序列化的对象类型
        XmlSerializer serializer = new XmlSerializer(typeof(User));
        // 使用StringBuilder存储序列化后的XML内容
        StringBuilder xmlBuilder = new StringBuilder();
        // 创建XmlWriterSettings设置编码和格式
        var settings = new System.Xml.XmlWriterSettings
        {
            Encoding = Encoding.UTF8,
            Indent = true, // 格式化XML，增加缩进方便阅读
            OmitXmlDeclaration = false // 保留XML声明头
        };
        using (var writer = System.Xml.XmlWriter.Create(xmlBuilder, settings))
        {
            // 执行序列化操作
            serializer.Serialize(writer, user);
        }
        return xmlBuilder.ToString();
    }

    public static void Main()
    {
        // 创建测试对象
        User testUser = new User(1, "张三", "123456", new List<string> { "篮球", "阅读" });
        string xmlResult = SerializeUserToXml(testUser);
        Console.WriteLine(xmlResult);
        // 也可以将XML写入文件
        File.WriteAllText("user.xml", xmlResult, Encoding.UTF8);
    }
}

上述代码执行后生成的XML内容如下：

<?xml version="1.0" encoding="utf-8"?>
<UserInfo Id="1">
  <UserName>张三</UserName>
  <Hobbies>
    <Hobby>篮球</Hobby>
    <Hobby>阅读</Hobby>
  </Hobbies>
</UserInfo>

XML反序列化实现步骤

反序列化是序列化的逆过程，核心是通过XmlSerializer的Deserialize方法将XML数据还原为对象。

基础反序列化示例

下面的代码演示了如何将上面生成的XML字符串反序列化为User对象：

using System;
using System.IO;
using System.Xml.Serialization;

public class XmlDeserializeDemo
{
    public static User DeserializeXmlToUser(string xmlContent)
    {
        // 创建XmlSerializer实例，指定目标对象类型
        XmlSerializer serializer = new XmlSerializer(typeof(User));
        // 将XML字符串转换为流
        using (StringReader reader = new StringReader(xmlContent))
        {
            // 执行反序列化操作，返回object类型需要强转
            return (User)serializer.Deserialize(reader);
        }
    }

    public static void Main()
    {
        // 读取之前生成的XML文件内容
        string xmlContent = File.ReadAllText("user.xml");
        User user = DeserializeXmlToUser(xmlContent);
        Console.WriteLine($"用户ID：{user.Id}");
        Console.WriteLine($"用户名：{user.Name}");
        // Password字段被标记为XmlIgnore，所以反序列化后为空
        Console.WriteLine($"密码：{user.Password ?? "空"}");
        Console.WriteLine($"爱好数量：{user.Hobbies?.Count ?? 0}");
    }
}

常见问题与注意事项

在实际使用XML序列化与反序列化时，经常会遇到一些问题，以下是常见的注意事项：

• 如果对象的属性是只读的（只有get没有set），那么该属性无法被反序列化，因为反序列化需要给属性赋值
• 默认情况下，类的私有字段和私有属性不会被序列化，如果需要序列化私有成员，需要自定义序列化逻辑
• 如果XML中包含命名空间，需要在XmlRoot特性或者XmlSerializer构造时指定对应的命名空间，否则会反序列化失败
• 序列化大型对象时，建议使用流式操作而不是一次性加载到内存，避免内存占用过高
• 如果对象包含循环引用，XmlSerializer会抛出异常，需要提前处理循环引用问题或者更换序列化方案

自定义序列化规则扩展

除了使用内置的特性控制序列化行为，还可以通过实现IXmlSerializable接口来自定义序列化和反序列化的逻辑，适合需要完全控制XML生成格式的场景。

using System;
using System.Xml;
using System.Xml.Schema;
using System.Xml.Serialization;

public class CustomUser : IXmlSerializable
{
    public int Id { get; set; }
    public string Name { get; set; }

    public XmlSchema GetSchema()
    {
        return null;
    }

    // 自定义反序列化逻辑
    public void ReadXml(XmlReader reader)
    {
        reader.ReadStartElement();
        Id = int.Parse(reader.ReadElementString("UserId"));
        Name = reader.ReadElementString("UserName");
        reader.ReadEndElement();
    }

    // 自定义序列化逻辑
    public void WriteXml(XmlWriter writer)
    {
        writer.WriteElementString("UserId", Id.ToString());
        writer.WriteElementString("UserName", Name);
    }
}

通过上述自定义实现，生成的XML会按照我们指定的格式输出，不受默认序列化规则的限制。

C#XML_serializationXmlSerializer反序列化对象序列化修改时间：2026-07-08 04:45:32