C# 怎么将对象序列化为xml字符串

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

在 C# 中,可以使用 XmlSerializer 类将对象序列化为 XML 字符串。这个方法简单、内置,不需要额外引用第三方库。

1. 确保类是可序列化的

要序列化的类通常需要有公共的属性和构造函数,并且不包含循环引用。你可以添加 [Serializable] 特性(虽然对 XmlSerializer 不是必须的),但更关键的是确保属性是 public 的 getter 和 setter。

示例类:

public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
    public string City { get; set; }
}

2. 使用 XmlSerializer 序列化为字符串

通过 StringWriter 配合 XmlSerializer 可以将对象转为 XML 字符串。

完整代码示例:

using System;
using System.IO;
using System.Xml.Serialization;
<p>public static string SerializeToXml<T>(T obj)
{
var serializer = new XmlSerializer(typeof(T));
using (var writer = new StringWriter())
{
serializer.Serialize(writer, obj);
return writer.ToString();
}
}</p><p>// 使用示例
var person = new Person
{
Name = "张三",
Age = 30,
City = "北京"
};</p><p>string xml = SerializeToXml(person);
Console.WriteLine(xml);
</p>

输出结果类似:

<?xml version="1.0" encoding="utf-16"?>
<Person xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Name>张三</Name>
  <Age>30</Age>
  <City>北京</City>
</Person>

3. 控制 XML 输出格式(可选)

如果你希望指定编码(如 UTF-8)或去掉默认命名空间等,可以自定义 XmlWriterSettings

示例:使用 UTF-8 编码并美化输出:

public static string SerializeToXmlPretty<T>(T obj)
{
    var serializer = new XmlSerializer(typeof(T));
    var settings = new XmlWriterSettings
    {
        Encoding = new UTF8Encoding(false),
        Indent = true,
        OmitXmlDeclaration = false
    };
<pre class="brush:php;toolbar:false;">using (var stream = new StringWriter())
using (var writer = XmlWriter.Create(stream, settings))
{
    serializer.Serialize(writer, obj);
    return stream.ToString();
}

}

4. 注意事项

以下几点在使用时需要注意: 字段必须是 public 属性 才能被序列化 不能序列化含有循环引用的对象(如父子相互引用) 私有字段、只读属性、自动实现的非公共访问器不会被包含 如果需要控制 XML 节点名称,可以使用 [XmlElement]、[XmlAttribute] 等特性

例如自定义元素名:

public class Person
{
    [XmlElement("FullName")]
    public string Name { get; set; }
<pre class="brush:php;toolbar:false;">[XmlAttribute("userAge")]
public int Age { get; set; }

}

基本上就这些。用 XmlSerializer 是最直接的方式,适合大多数场景。

相关推荐