C#中如何使用XmlSerializer的XmlRoot指定XML根元素名称

在C#的XML序列化场景中，当我们使用XmlSerializer将对象转换为XML字符串时，默认情况下根元素的名称会和对应的类名完全相同。如果我们需要让根元素使用自定义的名称，就可以借助XmlRoot特性来实现，这个特性可以直接标注在需要序列化的类上，快速指定根元素的名称。

XmlRoot基础用法

XmlRoot特性位于System.Xml.Serialization命名空间下，最基础的用法是直接设置它的ElementName属性，该属性的值就是序列化后XML的根元素名称。下面是一个简单的示例，我们先定义一个普通的用户类，不使用XmlRoot时序列化后的根元素会是类名User，使用XmlRoot后根元素会变为我们指定的名称。

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

// 定义用户类，使用XmlRoot指定根元素名称为"user_info"
[XmlRoot(ElementName = "user_info")]
public class User
{
    // 用户ID属性
    public int Id { get; set; }
    // 用户名称属性
    public string Name { get; set; }
}

class Program
{
    static void Main(string[] args)
    {
        // 创建用户对象
        User user = new User
        {
            Id = 1,
            Name = "张三"
        };
        // 创建XmlSerializer实例，指定要序列化的类型为User
        XmlSerializer serializer = new XmlSerializer(typeof(User));
        // 创建内存流用于保存序列化后的XML
        using (MemoryStream stream = new MemoryStream())
        {
            // 执行序列化操作
            serializer.Serialize(stream, user);
            // 将流中的位置重置到开头
            stream.Position = 0;
            // 读取流中的内容并转换为字符串
            using (StreamReader reader = new StreamReader(stream))
            {
                string xmlContent = reader.ReadToEnd();
                Console.WriteLine(xmlContent);
            }
        }
    }
}

运行上面的代码后，输出的XML内容如下，可以看到根元素已经变成了我们指定的user_info，而不是默认的User：

<?xml version="1.0"?>
<user_info>
  <Id>1</Id>
  <Name>张三</Name>
</user_info>

带命名空间的XmlRoot用法

如果我们需要给根元素指定命名空间，还可以同时设置XmlRoot的Namespace属性，这样序列化后的根元素就会带上对应的命名空间。示例如下：

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

// 指定根元素名称为"user_info"，命名空间为"http://example.org/user"
[XmlRoot(ElementName = "user_info", Namespace = "http://example.org/user")]
public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
}

class Program
{
    static void Main(string[] args)
    {
        User user = new User
        {
            Id = 2,
            Name = "李四"
        };
        XmlSerializer serializer = new XmlSerializer(typeof(User));
        using (MemoryStream stream = new MemoryStream())
        {
            serializer.Serialize(stream, user);
            stream.Position = 0;
            using (StreamReader reader = new StreamReader(stream))
            {
                Console.WriteLine(reader.ReadToEnd());
            }
        }
    }
}

上述代码运行后生成的XML根元素会包含指定的命名空间，输出内容如下：

<?xml version="1.0"?>
<user_info xmlns="http://example.org/user">
  <Id>2</Id>
  <Name>李四</Name>
</user_info>

注意事项

• XmlRoot特性只能标注在类上，不能标注在属性或者字段上，如果要指定子元素的名称，需要使用XmlElement特性。
• 如果序列化时同时使用了XmlRoot和XmlElement指定了同名的元素，XmlRoot的优先级更高，会决定根元素的名称。
• 当需要对XML进行反序列化时，XmlRoot指定的根元素名称需要和XML中的根元素名称完全一致，否则会反序列化失败。

C#XmlSerializerXmlRootXML序列化修改时间：2026-06-09 20:48:20