C# 如何将枚举类型正确序列化到xml-C#.Net教程-PHP中文网

C# 如何将枚举类型正确序列化到xml

星降

发布： 2025-10-27 21:18:02

原创

803人浏览过

使用XmlSerializer时，枚举默认序列化为字符串名称，结合[XmlEnum]可自定义输出值，确保XML清晰可读；需避免无效命名导致序列化异常，并注意反序列化时大小写匹配问题。

c# 如何将枚举类型正确序列化到xml

在C#中将枚举类型序列化为XML时，为了确保输出清晰、可读且符合预期，需要正确使用 XmlSerializer 并结合适当的属性来控制序列化行为。默认情况下，XmlSerializer 会将枚举序列化为其字符串名称而非整数值，这是推荐的做法，便于XML的可读性和兼容性。

1. 使用 XmlEnum 特性自定义枚举成员名称

通过 [XmlEnum] 特性，可以指定枚举成员在XML中输出的具体字符串值，这在需要与外部系统交互或遵循特定命名规范时非常有用。

示例：

public enum Status
{
    [XmlEnum("active")]
    Active,
<pre class="brush:php;toolbar:false;"><pre class="brush:php;toolbar:false;">[XmlEnum("inactive")]
Inactive,

[XmlEnum("pending")]
Pending

登录后复制

}

序列化后输出为：

<Status>active</Status>

登录后复制

2. 在类中使用枚举并进行序列化

只要枚举字段是公共字段或具有公共getter/setter的属性，XmlSerializer 就能自动处理它。

示例类：

public class Person
{
    public string Name { get; set; }
    public Status Status { get; set; }
}

登录后复制

序列化代码：

序列猴子开放平台

具有长序列、多模态、单模型、大数据等特点的超大规模语言模型

查看详情

var person = new Person
{
    Name = "Alice",
    Status = Status.Active
};
<p>var serializer = new XmlSerializer(typeof(Person));
using var writer = new StringWriter();
serializer.Serialize(writer, person);</p><p>Console.WriteLine(writer.ToString());

登录后复制

输出片段：

<Person>
  <Name>Alice</Name>
  <Status>active</Status>
</Person>

登录后复制

3. 避免序列化为整数

如果枚举没有使用 [XmlEnum] 且成员名不符合XML命名规则（如包含下划线或数字开头），XmlSerializer 可能会尝试使用数字值，这不是理想行为。应始终确保每个枚举成员都有明确的、适合XML输出的字符串映射。

例如，以下写法可能导致问题：

public enum BadEnum
{
    Value1, // 序列化为 "Value1" —— 可接受但不够规范
    Invalid-State // 编译错误或序列化异常
}

登录后复制

应改为：

public enum GoodEnum
{
    [XmlEnum("valid")]
    Value1,
<pre class="brush:php;toolbar:false;"><pre class="brush:php;toolbar:false;">[XmlEnum("invalid-state")]
InvalidState

登录后复制

}

4. 反序列化时注意大小写和匹配

XmlSerializer 默认区分大小写。若XML中传入的是 ACTIVE 而枚举定义为 Active，反序列化会失败并抛出异常。

解决方法：确保XML中的字符串与 [XmlEnum] 指定的值完全一致（包括大小写）。必要时可在服务端预处理XML或使用中间模型转换。

基本上就这些。只要合理使用 [XmlEnum] 并确保枚举成员命名清晰，C# 的 XML 序列化对枚举的支持是可靠且易于维护的。

以上就是C# 如何将枚举类型正确序列化到xml的详细内容，更多请关注php中文网其它相关文章！