C#如何将对象序列化为XML字符串

14次阅读

xmlSerializer 可将 C# 对象序列化为 XML 字符串,要求类为 public、属性 public 且有 get 访问器、推荐无参构造函数;支持格式化输出、属性忽略(XmlIgnore)、重命名(XmlElement)、转为属性(XmlAttribute)及泛型集合序列化。

C#如何将对象序列化为XML字符串

使用 XmlSerializer 类可将 C# 对象快速序列化为 XML 字符串,前提是类结构满足基本要求(如具有公共属性、无参数构造函数等)。

确保类支持 XML 序列化

被序列化的类需满足以下条件:

  • 必须是 public 类
  • 所有要序列化的字段或属性需为 public,且有 get 访问器
  • 推荐提供无参 public 构造函数(XmlSerializer 内部需要)
  • 避免包含不能被 XML 表示的类型(如委托指针、未标记 [Serializable] 的自定义类型等)

例如:

public class Person
{
  public String Name { get; set; }
  public int Age { get; set; }
  public DateTime BirthDate { get; set; }
}

基础序列化代码(无格式化)

使用 StringWriter 捕获输出:

var person = new Person { Name = “张三”, Age = 28, BirthDate = new DateTime(1995, 5, 10) };
var serializer = new XmlSerializer(typeof(Person));
using var writer = new StringWriter();
serializer.Serialize(writer, person);
string xml = writer.ToString();

结果为紧凑 XML(无换行缩进),适合传输或存储。

生成格式化(带缩进)的 XML 字符串

XmlWriter 配合 XmlWriterSettings 控制格式:

var settings = new XmlWriterSettings
{
  Indent = true,
  IndentChars = ” “,
  OmitXmlDeclaration = false
};

using var stringWriter = new StringWriter();
using var xmlWriter = XmlWriter.Create(stringWriter, settings);
new XmlSerializer(typeof(Person)).Serialize(xmlWriter, person);
string formattedXml = stringWriter.ToString();

这样生成的 XML 更易读,适合调试或展示。

处理常见问题

忽略某个属性:在属性上加 [XmlIgnore]
重命名 XML 元素名:用 [XmlElement("CustomName")]
序列化为属性而非子元素:用 [XmlAttribute]
处理 NULL 引用引用类型默认为 xsi:nil="true"(需启用 XmlSerializerNamespaces 并添加 xsi 命名空间);
泛型集合:直接序列化 List 或数组即可,无需额外配置。

text=ZqhQzanResources