0

0

C#读写YAML文件 C#如何使用YamlDotNet库操作YAML配置

畫卷琴夢

畫卷琴夢

发布时间:2026-02-07 06:33:25

|

515人浏览过

|

来源于php中文网

原创

c#读写yaml文件 c#如何使用yamldotnet库操作yaml配置

YamlDotNet读取YAML文件时抛出YamlException怎么办

常见原因是缩进不一致(混用空格与Tab)、键名后缺少冒号、或注释位置非法。YamlDotNet默认严格遵循YAML 1.2规范,不接受松散格式。

实操建议:

  • 用VS Code装YAML插件实时校验语法,启用"yaml.format.enable": true
  • 读取前先用File.ReadAllText(path)打印原始字符串,确认无BOM头或不可见控制字符
  • 若YAML含中文键或值,确保文件保存为UTF-8无BOM格式
  • 捕获YamlException时检查e.Messagee.Start,它会指出具体行号和列偏移

如何用Deserializer.Deserialize映射嵌套结构

YamlDotNet的反序列化依赖属性名称与YAML键名**完全匹配**(区分大小写),且类需有公共setter或使用[YamlMember(Alias = "...")]显式指定别名。

示例YAML片段:

server:
  host: localhost
  port: 8080
logging:
  level: Debug
  file: app.log

对应C#类需这样定义:

public class Config
{
    public ServerConfig server { get; set; }
    public LoggingConfig logging { get; set; }
}

public class ServerConfig
{
    public string host { get; set; }
    public int port { get; set; }
}

public class LoggingConfig
{
    public string level { get; set; }
    public string file { get; set; }
}

关键点:

Palette
Palette

在线生成整套UI调色板

下载
  • 所有属性必须是public,字段(public string host;)不会被自动识别
  • 若YAML中键为log-level,C#属性需加[YamlMember(Alias = "log-level")]
  • 数组用IListT[]接收,不要用List(虽能工作但不推荐)

Serializer.Serialize输出格式难看?如何控制缩进与换行

默认序列化器不保留原始注释、不换行、缩进为2空格,且布尔值输出为True/False(非true/false)。

要生成更规范的YAML,需自定义Serializer

var serializer = new SerializerBuilder()
    .ConfigureDefaultValuesHandling(DefaultValuesHandling.OmitNull)
    .WithNamingConvention(new CamelCaseNamingConvention()) // 或 NullNamingConvention保持原名
    .WithEventEmitter(e => new MyCustomEventEmitter(e)) // 如需控制布尔/数字格式
    .Build();

常用配置项:

  • .WithIndentedSequences():让列表每项独占一行(否则默认内联)
  • .WithTypeConverter(new BooleanConverter()):强制输出小写true/false
  • .EmitDefaults():输出值为null或默认值的字段(默认省略)
  • 避免直接调用serializer.Serialize(writer, obj),改用serializer.Serialize(TextWriter, obj)防止编码问题

为什么修改对象后Serialize没更新YAML中的注释或顺序

YamlDotNet的Deserializer解析后生成的是纯对象图,原始YAML的注释、键顺序、引号风格等元信息全部丢失。它不是“编辑器”,而是“转换器”。

这意味着:

  • 无法实现“只改一个字段,其余格式照旧”的精准编辑
  • 若需保留注释,必须改用YamlStream + YamlMappingNode等底层API手动遍历节点
  • 键顺序默认按字典序排列,要保持YAML原有顺序,需用Dictionary接收,再配合PreserveOrderingObjectGraphVisitor
  • 生产环境配置管理,建议将YAML仅作输入,运行时用强类型对象操作,导出时接受格式重排
实际项目里最容易卡住的,是把YAML当INI用却忘了它本质是数据序列化格式——缩进即结构、空格Tab不能混、注释不可编程访问。真要双向保形编辑,得切到AST层,而不是依赖Deserialize这种便利接口。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

606

2023.08.02

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

241

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

621

2024.03.01

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

864

2023.07.31

python中的format是什么意思
python中的format是什么意思

python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

439

2024.06.27

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

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

424

2023.08.03

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

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

213

2023.09.04

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

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

1514

2023.10.24

Golang处理数据库错误教程合集
Golang处理数据库错误教程合集

本专题整合了Golang数据库错误处理方法、技巧、管理策略相关内容,阅读专题下面的文章了解更多详细内容。

2

2026.02.06

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
HTML5/CSS3/JavaScript/ES6入门课程
HTML5/CSS3/JavaScript/ES6入门课程

共102课时 | 6.9万人学习

前端基础到实战(HTML5+CSS3+ES6+NPM)
前端基础到实战(HTML5+CSS3+ES6+NPM)

共162课时 | 19.5万人学习

第二十二期_前端开发
第二十二期_前端开发

共119课时 | 12.7万人学习

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

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