ASP.NET Core 8 Web API中JsonConverter<DateTime>日期转换错误排查

可能的原因及解决步骤 #

1. 先确认数据来源有没有问题 #

• 先查仓库返回的FooBar实例里，对应的DateTime属性是不是本来就是DateTime.MinValue（也就是你看到的1/1/0001 12:00:00 AM）。如果数据库里的字段是空或者默认值，那序列化后肯定不对。
• 可以在仓库或者API控制器里加个调试输出，直接打印FooBar的日期属性值，先确认数据从数据库读出来就是对的。

2. 检查你的自定义DateTimeJsonConverter实现 #

• 大概率是转换器写得有问题，比如：
  • Read方法里如果解析失败直接返回DateTime.MinValue，就会把本来应该是null或者错误的日期变成默认值。
  • Write方法有没有正确读取属性的实际值，会不会误写成了默认值。
• 举个容易踩坑的错误写法：

public override DateTime Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
    // 解析失败直接返回MinValue，会掩盖真实问题
    return DateTime.TryParse(reader.GetString(), out var date) ? date : DateTime.MinValue;
}

• 修正思路：如果数据库允许日期为空，模型里用DateTime?（可空日期类型），转换器也要对应处理可空类型，解析失败时返回null而不是默认值。

3. 确认JsonSerializerOptions配置是否生效 #

• 检查全局配置有没有加对地方：
  • 在Program.cs里，要确保转换器是加在AddControllers().AddJsonOptions()里的，比如：

builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        options.JsonSerializerOptions.Converters.Add(new DateTimeJsonConverter());
        // 其实也可以不用自定义转换器，直接用内置配置指定日期格式：
        // options.JsonSerializerOptions.DateFormatString = "yyyy-MM-dd'T'HH:mm:ss";
    });

• 如果是手动序列化（比如在代码里调用JsonSerializer.Serialize），要确保传入的是你配置好转换器的JsonSerializerOptions，别用默认的。

4. 检查FooBar模型的属性定义 #

• 看日期属性是DateTime还是DateTime?：
  • 数据库字段允许为空的话，模型一定要用DateTime?，不然未赋值时会自动填充DateTime.MinValue。
  • 检查属性有没有加[JsonIgnore]这类特性，导致真实值没被序列化。

5. 排查数据库读取逻辑 #

• 如果是从数据库的字符串字段读日期，要确保解析时用了正确的格式，别因为格式不对解析出默认值。
• 用EF Core的话，检查实体模型的日期字段映射是不是正确，有没有因为类型不匹配导致读错数据。

快速验证技巧 #

• 先把自定义转换器去掉，用System.Text.Json默认的日期序列化，看能不能输出预期的2024-05-30T15:46:45。如果默认配置正常，那问题肯定在自定义转换器上。
• 在控制器里直接返回一个硬编码的FooBar实例（给日期属性设正确值），看序列化结果对不对，这样能快速排除数据来源的问题。

内容的提问来源于stack exchange，提问作者Learner