C# 如何在xml序列化时控制根元素的名称

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

在 C# 中使用 XmlSerializer 进行 XML 序列化时,可以通过设置 XmlRootAttribute 来控制生成的 XML 根元素的名称。

使用 XmlRoot 特性指定根元素名称

在要序列化的类上应用 [XmlRoot] 特性,可以自定义根节点的名称。

例如,默认情况下类名会作为根元素名:

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

序列化后可能生成:

Tom25

若想将根元素改为 User,可添加 [XmlRoot] 特性:

[XmlRoot("User")]
public class Person
{
   public string Name { get; set; }
   public int Age { get; set; }
}

此时序列化输出为:

Tom25

在运行时动态设置根元素名

如果不希望通过特性写死名称,可以在创建 XmlSerializer 实例时传入 XmlRootAttribute

示例代码:

var root = new XmlRootAttribute("CustomRoot");
var serializer = new XmlSerializer(typeof(Person), root);
using (var writer = new StringWriter())
{
   serializer.Serialize(writer, personInstance);
   string xml = writer.ToString(); // 根节点为
}

这种方式适合需要根据上下文动态更改根名称的场景。

额外选项:命名空间和是否省略 XML 声明

XmlRootAttribute 还支持设置命名空间和是否包含 xsi:type 等信息。

例如:

[XmlRoot(ElementName = "User", Namespace = "http://example.com/schema", IsNullable = true)]
public class Person
{
   // 属性定义
}

这样生成的 XML 会包含指定的命名空间。

基本上就这些。通过 [XmlRoot] 特性或构造 XmlSerializer 时传入根属性,就能灵活控制序列化后的根元素名称。不复杂但容易忽略细节。

相关推荐