VerifyTests/Verify 项目中默认值处理机制的优化方案

背景介绍

在VerifyTests/Verify项目中，JSON序列化过程中默认会排除那些等于其默认值的属性。这一设计虽然符合大多数场景的需求，但在某些特殊情况下却会带来不便。例如当数值在零和接近零之间波动时，属性在验证输出中时隐时现会导致测试不稳定。此外，当值为零时，自定义的值转换器可能不会被调用，从而导致测试失败。

现有问题分析

当前项目中，开发者只能通过全局设置DefaultValueHandling = DefaultValueHandling.Include来包含所有默认值属性，但这通常不是理想方案，因为大多数情况下我们确实希望排除默认值属性。缺乏细粒度控制机制使得开发者无法针对特定属性或类型进行灵活配置。

解决方案设计

项目贡献者JustASquid提出了一个优雅的解决方案：在ScrubOrIgnore枚举中新增一个名为AlwaysInclude的值。这个新选项将强制序列化器包含特定属性，即使它的值等于默认值。这种设计具有以下优势：

1. 细粒度控制：开发者可以精确控制哪些属性需要始终包含
2. 向后兼容：不影响现有功能的正常使用
3. 简洁明了：通过枚举值直观表达意图，API设计清晰

替代方案比较

在讨论过程中，还提出了另一种替代方案：将CustomContractResolver设为公开，允许开发者通过子类化来自定义行为。虽然这个方案也能解决问题，但存在以下不足：

1. 使用复杂度高：将实现细节暴露给使用者
2. 维护成本高：新增公共接口会增加项目的长期维护负担
3. 一致性差：不同开发者可能实现出不一致的解决方案

相比之下，AlwaysInclude枚举方案更加优雅和统一，符合项目的一贯设计理念。

实现意义

这一改进将为项目带来以下实际价值：

1. 测试稳定性提升：数值在零附近波动时不再导致验证输出不一致
2. 转换器可靠性增强：确保自定义值转换器在所有情况下都被调用
3. 输出一致性改善：验证输出保持统一和整洁，便于比较

总结

VerifyTests/Verify项目通过引入AlwaysInclude机制，解决了默认值属性处理的痛点问题，为开发者提供了更灵活的配置选项。这一改进既保持了项目原有的简洁性，又增强了特定场景下的实用性，体现了项目团队对开发者需求的敏锐洞察和快速响应能力。