C# 如何将复杂的嵌套对象序列化为xml

来源:这里教程网 时间:2026-02-21 17:31:43 作者:

在 C# 中将复杂的嵌套对象序列化为 XML,最常用的方式是使用 XmlSerializer 类。只要类和属性正确标注了可序列化的结构,即使是多层嵌套的对象也能顺利转换为 XML。

1. 确保类具有默认构造函数并公开属性

XmlSerializer 要求被序列化的类必须有一个无参数的公共构造函数,并且只有 public 的读写属性(Property)才会被序列化。

例如,定义一个包含嵌套对象的学生信息类:

using System;
using System.Xml.Serialization;
[Serializable]
public class Student
{
    public string Name { get; set; }
    public int Age { get; set; }
    // 嵌套对象
    public Address HomeAddress { get; set; }
    // 集合类型的嵌套
    public Course[] Courses { get; set; }
}
public class Address
{
    public string Street { get; set; }
    public string City { get; set; }
    public string ZipCode { get; set; }
}
public class Course
{
    public string Title { get; set; }
    public int Credits { get; set; }
}

2. 使用 XmlSerializer 进行序列化

创建 XmlSerializer 实例,调用 Serialize 方法将对象写入 XML 流。
using System;
using System.IO;
using System.Xml;
// 创建学生对象
var student = new Student
{
    Name = "张三",
    Age = 20,
    HomeAddress = new Address
    {
        Street = "中山路123号",
        City = "北京",
        ZipCode = "100000"
    },
    Courses = new Course[]
    {
        new Course { Title = "数学", Credits = 4 },
        new Course { Title = "英语", Credits = 3 }
    }
};
// 序列化为 XML
var serializer = new XmlSerializer(typeof(Student));
using (var writer = XmlWriter.Create("student.xml", new XmlWriterSettings
{
    Indent = true
}))
{
    serializer.Serialize(writer, student);
}

生成的 XML 类似如下:

<Student>
  <Name>张三</Name>
  <Age>20</Age>
  <HomeAddress>
    <Street>中山路123号</Street>
    <City>北京</City>
    <ZipCode>100000</ZipCode>
  </HomeAddress>
  <Courses>
    <Course>
      <Title>数学</Title>
      <Credits>4</Credits>
    </Course>
    <Course>
      <Title>英语</Title>
      <Credits>3</Credits>
    </Course>
  </Courses>
</Student>

3. 自定义 XML 输出格式(可选)

你可以通过特性控制元素名称、是否省略命名空间等。
[XmlRoot("Person")]
public class Student
{
    [XmlElement("StudentName")]
    public string Name { get; set; }
    [XmlElement("Residence")]
    public Address HomeAddress { get; set; }
    [XmlArray("EnrolledCourses")]
    [XmlArrayItem("CourseItem")]
    public Course[] Courses { get; set; }
}

这样输出会变成:

<Person>
  <StudentName>张三</StudentName>
  <Residence>
    <Street>中山路123号</Street>
    <City>北京</City>
    <ZipCode>100000</ZipCode>
  </Residence>
  <EnrolledCourses>
    <CourseItem>
      <Title>数学</Title>
      <Credits>4</Credits>
    </CourseItem>
    <CourseItem>
      <Title>英语</Title>
      <Credits>3</Credits>
    </CourseItem>
  </EnrolledCourses>
</Person>

4. 注意事项与限制

虽然 XmlSerializer 功能强大,但有一些细节需要注意: 不支持泛型集合接口(如 IList),建议使用数组或 List 字段(Field)不会被自动序列化,除非加上 [XmlElement] 构造函数在反序列化时不会完全按预期执行,避免在构造中做复杂初始化 如果类中有循环引用(比如 A 包含 B,B 又引用 A),会抛出异常,需手动处理

基本上就这些。只要结构清晰、属性公开、嵌套对象也符合序列化要求,C# 的 XmlSerializer 就能很好地处理复杂对象转 XML。

相关推荐

热文推荐