在VerifyTests/Verify项目中实现自定义JSON序列化转换器

理解自定义JSON转换器

在VerifyTests/Verify项目中，当我们需要对特定类型进行自定义JSON序列化时，可以使用JsonConverter来实现。本文将通过一个实际案例，展示如何正确实现一个针对TimeOnlyOffset类型的自定义转换器。

问题背景

开发者需要将TimeOnlyOffset类型序列化为"HH:mm:ss TZ"格式的字符串，例如"18:30:00 CST"。初始实现虽然能直接序列化TimeOnlyOffset实例，但当该类型作为对象属性时，转换器却未被调用。

解决方案分析

转换器实现要点

1. 正确处理可为空类型：原始实现未考虑可为空类型(Nullable)，导致转换器在某些情况下不被调用。正确的CanConvert方法应同时检查基础类型和可为空类型。

2. 简化转换器实现：Verify项目提供了WriteOnlyJsonConverter基类，可以简化只用于序列化的转换器实现。

优化后的转换器代码

public class TimeOnlyOffsetArgonConverter : WriteOnlyJsonConverter<TimeOnlyOffset>
{
    public override void Write(VerifyJsonWriter writer, TimeOnlyOffset timeOnlyOffset)
    {
        var timeFormat = timeOnlyOffset.Ticks switch
        {
            var ticks when ticks % TimeSpan.TicksPerMillisecond > 0 => "HH:mm:ss.fffffff",
            var ms when ms % TimeSpan.TicksPerSecond > 0 => "HH:mm:ss.fff",
            var s when s % TimeSpan.TicksPerMinute > 0 => "HH:mm:ss",
            _ => "HH:mm"
        };

        var time = timeOnlyOffset.TimeOnly.ToString(timeFormat);
        var zone = timeOnlyOffset.TimeZone.CodeUSA();

        writer.WriteValue($"{time} {zone}");
    }
}

最佳实践建议

1. 全局注册转换器：推荐在模块初始化时全局注册转换器，而非在每个测试中重复注册：

public static class ModuleInitializer
{
    [ModuleInitializer]
    public static void Init()
    {
        VerifierSettings.AddExtraSettings(x =>
        {
            x.Converters.Add(new TimeOnlyOffsetArgonConverter());
        });
    }
}

2. 考虑性能优化：全局注册方式不仅代码更简洁，还能避免重复创建转换器实例，提高测试执行效率。

3. 全面测试覆盖：确保测试用例覆盖各种使用场景，包括：

   • 直接序列化目标类型实例
   • 目标类型作为对象属性的情况
   • 可为空的目标类型

总结

在VerifyTests/Verify项目中实现自定义JSON序列化时，需要注意转换器的适用范围和注册方式。通过使用WriteOnlyJsonConverter基类和模块初始化全局注册，可以创建高效、可靠的自定义序列化解决方案。本文提供的实现模式不仅解决了特定问题，也为处理类似的自定义序列化需求提供了参考模板。