Install-Package YamlDotNet -Version 13.7.1 # 可替換為最新版本

<ItemGroup>
  <PackageReference Include="YamlDotNet" Version="13.7.1" />
</ItemGroup>

using YamlDotNet;
using YamlDotNet.Serialization;
using YamlDotNet.Serialization.NamingConventions;

// 1. 定義測試類
public class User
{
    public string Name { get; set; }
    public int Age { get; set; }
    public List<string> Hobbies { get; set; }
}
// 2. 序列化（對象→YAML）
var user = new User { Name = "ZhangSan", Age = 25, Hobbies = new List<string> { "Coding", "Reading" } };
var serializer = new SerializerBuilder()
    .WithNamingConvention(CamelCaseNamingConvention.Instance)
    .Build();
string yaml = serializer.Serialize(user);
Console.WriteLine("序列化結(jié)果：\n" + yaml);
// 3. 反序列化（YAML→對象）
var deserializer = new DeserializerBuilder()
    .WithNamingConvention(CamelCaseNamingConvention.Instance)
    .IgnoreUnmatchedProperties()
    .Build();
User deserializedUser = deserializer.Deserialize<User>(yaml);
Console.WriteLine($"反序列化結(jié)果：Name={deserializedUser.Name}, Age={deserializedUser.Age}");

// 序列化器配置
var serializer = new SerializerBuilder()
    .WithNamingConvention(CamelCaseNamingConvention.Instance) // 駝峰命名
    .Indent(2) // 縮進(jìn)2個(gè)空格
    .WithCommentHandling(CommentHandling.IncludeComments) // 保留注釋
    .Build();
// 反序列化器配置
var deserializer = new DeserializerBuilder()
    .WithNamingConvention(CamelCaseNamingConvention.Instance)
    .IgnoreUnmatchedProperties() // 忽略未知屬性，避免報(bào)錯(cuò)
    .AllowNullValues() // 允許空值
    .Build();

var data = new
{
    Name = "LiSi",
    Age = 30,
    BirthDate = new DateTime(1993, 10, 1),
    Tags = new string[] { "C#", "YamlDotNet" },
    Scores = new Dictionary<string, int> { { "Math", 90 }, { "English", 85 } }
};
// 序列化
string yaml = serializer.Serialize(data);
// 反序列化（dynamic類型，無需定義實(shí)體類）
dynamic deserialized = deserializer.Deserialize<dynamic>(yaml);
Console.WriteLine($"Math Score: {deserialized.scores.math}");

// 嵌套類
public class Address { public string Province { get; set; } public string City { get; set; } }
// 父類
public class Person { public string Name { get; set; } public int Age { get; set; } }
// 子類
public class Student : Person
{
    public string StudentId { get; set; }
    public Address Address { get; set; }
    public List<string> Courses { get; set; }
}
// 序列化
var student = new Student
{
    Name = "WangWu",
    Age = 20,
    StudentId = "2023001",
    Address = new Address { Province = "Guangdong", City = "Shenzhen" },
    Courses = new List<string> { "C#", "Database" }
};
string studentYaml = serializer.Serialize(student);
// 反序列化
Student deserializedStudent = deserializer.Deserialize<Student>(studentYaml);

using YamlDotNet.Serialization.Attributes;
public class Product
{
    [YamlAlias("product_id")] // 別名，YAML中顯示為product_id
    public string Id { get; set; }
    [YamlIgnore] // 忽略該屬性，不序列化/反序列化
    public string Secret { get; set; }
    [YamlComment("產(chǎn)品名稱（必填）")] // 添加注釋
    public string Name { get; set; }
    [YamlMember(Order = 1)] // 指定序列化順序
    public decimal Price { get; set; }
}

// 實(shí)現(xiàn)自定義轉(zhuǎn)換器
public class CustomDateTimeConverter : IYamlTypeConverter
{
    public bool Accepts(Type type) => type == typeof(DateTime) || type == typeof(DateTime?);
    // 反序列化：字符串→DateTime
    public object ReadYaml(IParser parser, Type type)
    {
        var value = parser.Consume<Scalar>().Value;
        return DateTime.ParseExact(value, "yyyy-MM-dd HH:mm:ss", null);
    }
    // 序列化：DateTime→字符串
    public void WriteYaml(IEmitter emitter, object value, Type type)
    {
        emitter.Emit(new Scalar(((DateTime)value).ToString("yyyy-MM-dd HH:mm:ss")));
    }
}
// 注冊并使用
var serializer = new SerializerBuilder()
    .WithTypeConverter(new CustomDateTimeConverter())
    .Build();

/// <summary>
/// 序列化對象到Y(jié)AML文件
/// </summary>
public void SerializeToFile(object obj, string filePath)
{
    using (var writer = new StreamWriter(filePath, false, Encoding.UTF8))
    {
        serializer.Serialize(writer, obj);
    }
}
/// <summary>
/// 從YAML文件反序列化到對象
/// </summary>
public T DeserializeFromFile<T>(string filePath)
{
    if (!File.Exists(filePath)) throw new FileNotFoundException("YAML文件不存在", filePath);
    using (var reader = new StreamReader(filePath, Encoding.UTF8))
    {
        return deserializer.Deserialize<T>(reader);
    }
}

public T DeserializeWithExceptionHandling<T>(string yaml)
{
    try
    {
        return deserializer.Deserialize<T>(yaml);
    }
    catch (YamlException ex)
    {
        Console.WriteLine($"YAML語法錯(cuò)誤：{ex.Message}，行號(hào)：{ex.Start.Line}");
        return default;
    }
    catch (InvalidCastException ex)
    {
        Console.WriteLine($"類型轉(zhuǎn)換錯(cuò)誤：{ex.Message}");
        return default;
    }
    catch (Exception ex)
    {
        Console.WriteLine($"反序列化失?。簕ex.Message}");
        return default;
    }
}

YamlConfigDemo/
├─ Config/
│  ├─ AppConfig.cs（配置實(shí)體）
│  └─ YamlConfigHelper.cs（工具類）
├─ appsettings.yaml（配置文件）
└─ Program.cs（測試入口）

using YamlDotNet.Serialization.Attributes;
namespace YamlConfigDemo.Config
{
    public class AppConfig
    {
        [YamlComment("應(yīng)用名稱（必填）")]
        public string AppName { get; set; }
        [YamlComment("應(yīng)用版本")]
        public string Version { get; set; }
        [YamlComment("數(shù)據(jù)庫配置")]
        public DatabaseConfig Database { get; set; }
        [YamlComment("服務(wù)配置")]
        public ServiceConfig Service { get; set; }
    }
    public class DatabaseConfig
    {
        [YamlAlias("connection_string")]
        public string ConnectionString { get; set; }
        [YamlAlias("timeout")]
        public int Timeout { get; set; } = 30;
    }
    public class ServiceConfig
    {
        [YamlAlias("base_url")]
        public string BaseUrl { get; set; }
        [YamlAlias("timeout")]
        public int Timeout { get; set; } = 5000;
    }
}

using System.IO;
using System.Text;
using YamlDotNet.Serialization;
using YamlDotNet.Serialization.NamingConventions;
namespace YamlConfigDemo.Config
{
    public static class YamlConfigHelper
    {
        // 單例復(fù)用實(shí)例
        private static readonly Serializer _serializer;
        private static readonly Deserializer _deserializer;
        static YamlConfigHelper()
        {
            _serializer = new SerializerBuilder()
                .WithNamingConvention(CamelCaseNamingConvention.Instance)
                .WithCommentHandling(CommentHandling.IncludeComments)
                .Indent(4)
                .Build();
            _deserializer = new DeserializerBuilder()
                .WithNamingConvention(CamelCaseNamingConvention.Instance)
                .IgnoreUnmatchedProperties()
                .AllowNullValues()
                .Build();
        }
        // 讀取配置
        public static T ReadConfig<T>(string filePath)
        {
            if (!File.Exists(filePath)) throw new FileNotFoundException("配置文件不存在", filePath);
            using (var reader = new StreamReader(filePath, Encoding.UTF8))
            {
                return _deserializer.Deserialize<T>(reader);
            }
        }
        // 寫入配置
        public static void WriteConfig(object config, string filePath)
        {
            using (var writer = new StreamWriter(filePath, false, Encoding.UTF8))
            {
                _serializer.Serialize(writer, config);
            }
        }
    }
}

using YamlConfigDemo.Config;
// 寫入配置
var config = new AppConfig
{
    AppName = "YamlDotNetDemo",
    Version = "1.0.0",
    Database = new DatabaseConfig
    {
        ConnectionString = "Server=localhost;Database=Test;Uid=root;Pwd=123456;"
    },
    Service = new ServiceConfig
    {
        BaseUrl = "https://api.demo.com"
    }
};
YamlConfigHelper.WriteConfig(config, "appsettings.yaml");
// 讀取配置
var readConfig = YamlConfigHelper.ReadConfig<AppConfig>("appsettings.yaml");
Console.WriteLine($"應(yīng)用名稱：{readConfig.AppName}");
Console.WriteLine($"數(shù)據(jù)庫連接串：{readConfig.Database.ConnectionString}");