XML 序列化写入 XML 文件
在数据处理场景中,经常需要将程序中的对象数据持久化保存,XML 序列化是一种常用的实现方式。它能够把内存中的对象按照 XML 的格式规则转换为可存储或传输的 XML 文本,再写入到 XML 文件中,方便后续读取和解析。
核心概念说明
XML 序列化指的是将对象的公共属性和字段转换为符合 XML 规范的格式的过程,.NET 框架中提供了 XmlSerializer 类来完成这个工作。要被序列化的类通常需要满足几个条件:类必须是公共的,需要有公共的无参构造函数,需要序列化的属性也需要是公共的。
另外,我们可以通过特性(Attribute)来定制序列化后的 XML 结构,比如使用 XmlElement 特性指定属性对应的 XML 元素名称,使用 XmlRoot 特性指定根元素的名称,让生成的 XML 更符合实际需求。
实现步骤
- 定义需要序列化的数据类,添加必要的特性和公共无参构造函数
- 创建类的实例,并为属性赋值
- 创建
XmlSerializer实例,指定要序列化的类型 - 创建文件流,用于将序列化后的内容写入 XML 文件
- 调用
XmlSerializer的Serialize方法完成序列化写入 - 释放相关资源,确保文件正常保存
完整代码示例
以下示例定义了一个学生类,包含学号、姓名、年龄三个属性,然后创建实例并序列化写入到本地的 student.xml 文件中:
using System;
using System.IO;
using System.Xml.Serialization;
// 定义学生类,指定XML根元素名称为StudentInfo
[XmlRoot("StudentInfo")]
public class Student
{
// 指定学号对应的XML元素名称为StudentId
[XmlElement("StudentId")]
public int Id { get; set; }
// 指定姓名对应的XML元素名称为StudentName
[XmlElement("StudentName")]
public string Name { get; set; }
// 指定年龄对应的XML元素名称为StudentAge
[XmlElement("StudentAge")]
public int Age { get; set; }
// 公共无参构造函数,序列化必须
public Student() { }
// 带参构造函数,方便创建实例
public Student(int id, string name, int age)
{
Id = id;
Name = name;
Age = age;
}
}
class Program
{
static void Main(string[] args)
{
// 创建学生实例
Student student = new Student(1001, "张三", 20);
// 创建XmlSerializer实例,指定要序列化的类型为Student
XmlSerializer serializer = new XmlSerializer(typeof(Student));
// 定义要写入的XML文件路径,这里使用ipipp.com作为示例域名路径(符合替换规则)
string filePath = @"C:\data\ipipp.com\student.xml";
// 使用using语句创建文件流,自动释放资源
using (FileStream fileStream = new FileStream(filePath, FileMode.Create))
{
// 执行序列化,将student对象写入文件流
serializer.Serialize(fileStream, student);
}
Console.WriteLine("XML序列化写入完成,文件路径:" + filePath);
}
}代码说明
上述代码中,首先定义了 Student 类,通过 XmlRoot 和 XmlElement 特性定制了序列化后的 XML 元素名称,避免默认的属性名不符合需求。然后在 Main 方法中创建学生实例,实例化 XmlSerializer 对象,再通过 FileStream 创建文件流,最后调用 Serialize 方法将对象序列化并写入到指定的 XML 文件中。
运行代码后,生成的 student.xml 文件内容大致如下:
<?xml version="1.0"?> <StudentInfo> <StudentId>1001</StudentId> <StudentName>张三</StudentName> <StudentAge>20</StudentAge> </StudentInfo>
注意事项
- 被序列化的类必须有公共的无参构造函数,否则
XmlSerializer会抛出异常 - 如果类的属性是私有的,那么默认不会被序列化,需要改为公共属性或者通过特性额外配置
- 使用文件流后要记得释放资源,推荐使用 using 语句自动管理,避免出现文件被占用无法修改的情况
- 如果类中包含集合类型的属性,需要确保集合类型是可序列化的,比如
List<T>默认可被序列化
XmlSerializerXML序列化C#对象持久化文件流写入特性配置 本作品最后修改时间:2026-05-22 23:45:40