C#如何为XmlSerializer指定根元素名称

在C#的XML序列化场景中，XmlSerializer默认会将待序列化类的类名作为生成XML的根元素名称，但很多时候我们需要自定义根元素名称，比如对接第三方接口时要求根元素为特定名称，或者需要让生成的XML结构更符合业务语义。下面介绍两种常用的指定根元素名称的方法。

方法一：使用XmlRootAttribute特性标注

这是最常用也最直观的方式，我们可以直接在待序列化的类上添加XmlRootAttribute特性，通过特性的ElementName属性指定自定义的根元素名称。

首先定义一个待序列化的实体类，添加特性标注：

using System;
using System.IO;
using System.Xml.Serialization;

// 使用XmlRootAttribute指定根元素名称为UserList
[XmlRoot(ElementName = "UserList")]
public class User
{
    public string Name { get; set; }
    public int Age { get; set; }
}

接下来编写序列化的测试代码：

class Program
{
    static void Main(string[] args)
    {
        User user = new User
        {
            Name = "张三",
            Age = 25
        };

        // 创建XmlSerializer实例，无需额外传入根元素参数
        XmlSerializer serializer = new XmlSerializer(typeof(User));
        using (StringWriter writer = new StringWriter())
        {
            serializer.Serialize(writer, user);
            string xmlResult = writer.ToString();
            Console.WriteLine(xmlResult);
        }
    }
}

运行上述代码后，生成的XML根元素就会是UserList，而不是默认的User，输出结果如下：

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

方法二：构造XmlSerializer时传入根元素参数

如果不想修改实体类的特性标注，也可以在创建XmlSerializer实例时，通过构造函数的重载参数指定根元素名称。这种方式适合临时需要修改根元素名称，或者无法修改实体类源码的场景。

我们还是使用上面的User类，但这次不添加XmlRootAttribute特性：

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

修改序列化代码，在创建XmlSerializer时传入根元素名称：

class Program
{
    static void Main(string[] args)
    {
        User user = new User
        {
            Name = "李四",
            Age = 30
        };

        // 构造函数第一个参数是序列化类型，第二个参数是自定义根元素名称
        XmlSerializer serializer = new XmlSerializer(typeof(User), new XmlRootAttribute("CustomRoot"));
        using (StringWriter writer = new StringWriter())
        {
            serializer.Serialize(writer, user);
            string xmlResult = writer.ToString();
            Console.WriteLine(xmlResult);
        }
    }
}

运行后生成的XML根元素会是我们传入的CustomRoot，结果如下：

<?xml version="1.0" encoding="utf-16"?>
<CustomRoot xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Name>李四</Name>
  <Age>30</Age>
</CustomRoot>

两种方法的对比

我们可以通过下面的表格对比两种方法的适用场景：

注意事项

需要注意如果同时使用两种方式指定根元素名称，构造函数传入的参数优先级会高于XmlRootAttribute特性标注的值。另外如果指定的根元素名称包含特殊字符，需要确保符合XML的命名规范，否则序列化时会抛出异常。

如果需要对XML命名空间也进行自定义，还可以在XmlRootAttribute中设置Namespace属性，或者在构造XmlRootAttribute实例时传入命名空间参数，满足更复杂的XML结构需求。

C#XmlSerializerXML序列化根元素名称XmlRootAttribute修改时间：2026-06-22 10:45:59