YamlDotNet动态修改类型名称的序列化技巧

背景介绍

在使用YamlDotNet进行YAML序列化时，我们有时会遇到需要动态修改类型名称的特殊需求。比如在OpenTelemetry Collector的配置中，接收器(receivers)配置项需要以特定格式呈现，如"otlp/1"、"otlp/2"这样的命名方式，而不是直接使用类名。

问题分析

常规情况下，YamlDotNet会按照类的属性名称和结构进行序列化。但当我们需要：

1. 将列表转换为键值对形式
2. 动态生成键名(如"otlp/1"、"otlp/2")
3. 保持值部分仍按原对象结构序列化

这时就需要使用更高级的序列化控制方式。

解决方案

YamlDotNet提供了IYamlConvertible接口，允许我们完全控制序列化和反序列化过程。以下是实现步骤：

1. 实现IYamlConvertible接口：在配置类中实现该接口，重写Write方法

2. 自定义映射结构：手动构建YAML的映射结构

3. 动态生成键名：在序列化时按需生成"otlp/1"这样的键名

4. 嵌套对象序列化：使用传入的nestedObjectSerializer处理实际对象

代码实现

public class Config : IYamlConvertible
{
    public List<Receiver> Receivers { get; } = [];

    public void Read(IParser parser, Type expectedType, ObjectDeserializer nestedObjectDeserializer)
    {
        // 反序列化逻辑
    }

    public void Write(IEmitter emitter, ObjectSerializer nestedObjectSerializer)
    {
        emitter.Emit(new MappingStart());
        emitter.Emit(new Scalar("Receivers"));
        emitter.Emit(new MappingStart());
        
        for (var ordinal = 0; ordinal < Receivers.Count; ordinal++)
        {
            // 动态生成键名
            emitter.Emit(new Scalar($"otlp/{ordinal + 1}"));
            // 序列化实际对象
            nestedObjectSerializer(Receivers[ordinal], typeof(Receiver));
        }

        emitter.Emit(new MappingEnd());
        emitter.Emit(new MappingEnd());
    }
}

关键点解析

1. Mapping结构控制：通过手动发射MappingStart和MappingEnd事件，可以精确控制YAML的层次结构

2. 动态键名生成：在循环中根据索引生成"otlp/1"、"otlp/2"等格式的键名

3. 嵌套序列化：使用nestedObjectSerializer可以保持对象内部属性的默认序列化行为

4. 灵活性：这种方法既满足了特殊格式要求，又保留了对象内部的标准序列化方式

应用场景

这种技术特别适用于以下场景：

1. 需要与特定YAML格式兼容的系统集成
2. 需要将列表表示为键值对的情况
3. 需要动态生成对象标识符的配置系统
4. 需要保持向后兼容性的配置格式

总结

通过实现IYamlConvertible接口，YamlDotNet提供了强大的自定义序列化能力。这种方法既满足了特殊格式需求，又保持了代码的整洁性和可维护性。对于需要与特定YAML格式交互的场景，这种技术提供了完美的解决方案。