0

0

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

星降

星降

发布时间:2025-10-27 21:18:02

|

817人浏览过

|

来源于php中文网

原创

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

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

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

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

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

示例:

public enum Status
{
    [XmlEnum("active")]
    Active,
[XmlEnum("inactive")]
Inactive,

[XmlEnum("pending")]
Pending

}

序列化后输出为:

active

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

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

示例类:

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

序列化代码:

CA.LA
CA.LA

第一款时尚产品在线设计平台,服装设计系统

下载
var person = new Person
{
    Name = "Alice",
    Status = Status.Active
};

var serializer = new XmlSerializer(typeof(Person)); using var writer = new StringWriter(); serializer.Serialize(writer, person);

Console.WriteLine(writer.ToString());

输出片段:


  Alice
  active

3. 避免序列化为整数

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

例如,以下写法可能导致问题:

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

应改为:

public enum GoodEnum
{
    [XmlEnum("valid")]
    Value1,
[XmlEnum("invalid-state")]
InvalidState

}

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

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

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

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

相关专题

更多
pdf怎么转换成xml格式
pdf怎么转换成xml格式

将 pdf 转换为 xml 的方法:1. 使用在线转换器;2. 使用桌面软件(如 adobe acrobat、itext);3. 使用命令行工具(如 pdftoxml)。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1897

2024.04.01

xml怎么变成word
xml怎么变成word

步骤:1. 导入 xml 文件;2. 选择 xml 结构;3. 映射 xml 元素到 word 元素;4. 生成 word 文档。提示:确保 xml 文件结构良好,并预览 word 文档以验证转换是否成功。想了解更多xml的相关内容,可以阅读本专题下面的文章。

2089

2024.08.01

xml是什么格式的文件
xml是什么格式的文件

xml是一种纯文本格式的文件。xml指的是可扩展标记语言,标准通用标记语言的子集,是一种用于标记电子文件使其具有结构性的标记语言。想了解更多相关的内容,可阅读本专题下面的相关文章。

1043

2024.11.28

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

278

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

212

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1493

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

622

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

572

2024.03.22

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

41

2026.01.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C# 教程
C# 教程

共94课时 | 7.5万人学习

C 教程
C 教程

共75课时 | 4.2万人学习

C++教程
C++教程

共115课时 | 13.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号