Swashbuckle.AspNetCore中DateOnly类型序列化问题的分析与解决

问题背景

在Swashbuckle.AspNetCore这个用于ASP.NET Core的Swagger/OpenAPI工具库中，从6.6.0版本开始增加了对DateOnly类型的原生支持。这一变更虽然带来了更好的类型支持，但也引入了一个潜在的兼容性问题。

问题现象

用户在从6.5.0版本升级到6.6.1或更高版本后，遇到了JSON序列化异常："The JSON value could not be converted to System.DateOnly"。这个问题特别出现在DTO类中同时使用了DateOnly类型和DefaultValue(null)属性的场景下。

技术分析

问题根源

在6.5.0及更早版本中，Swashbuckle.AspNetCore将DateOnly类型视为普通字符串处理。当DTO类中包含如下定义时：

public class MyDto
{
    public DateOnly ActiveFrom { get; set; }
    
    [DefaultValue(null)]
    public DateOnly? InactiveFrom { get; set; }
}

系统能够正常工作，因为DefaultValue(null)属性被简单地作为字符串处理。

然而在6.6.0及更高版本中，Swashbuckle.AspNetCore开始原生支持DateOnly类型，尝试将DefaultValue(null)实际转换为DateOnly?类型时，系统无法将null值直接转换为DateOnly类型，导致了序列化异常。

版本差异

• 6.5.0及之前：DateOnly被视为字符串，DefaultValue(null)可以正常工作
• 6.6.0及之后：DateOnly得到原生支持，DefaultValue(null)导致序列化失败

解决方案

临时解决方案

目前最简单的解决方法是移除DefaultValue(null)属性：

public class MyDto
{
    public DateOnly ActiveFrom { get; set; }
    
    public DateOnly? InactiveFrom { get; set; } // 移除了DefaultValue(null)
}

长期解决方案

开发团队已经意识到这个问题，并在GitHub上创建了相关issue进行跟踪。预计未来的版本中会提供更完善的解决方案，可能包括：

1. 更智能的null值处理
2. 对DefaultValue属性的特殊处理
3. 提供明确的文档说明

最佳实践建议

对于当前使用Swashbuckle.AspNetCore 6.6.x版本的用户，建议：

1. 检查项目中所有使用DateOnly/DateOnly?类型的DTO
2. 移除不必要的DefaultValue(null)属性
3. 对于确实需要默认值的情况，考虑使用明确的日期值而非null
4. 关注项目更新，及时应用修复版本

总结

这个案例展示了类型系统增强可能带来的兼容性问题。虽然Swashbuckle.AspNetCore对DateOnly的原生支持是一个进步，但也需要开发者注意相关的使用方式调整。通过理解问题的本质，开发者可以更好地规划升级路径和代码修改策略。