ASP.NET Core 中 TypedResults 与 JSON 序列化配置的注意事项

在 ASP.NET Core 9.0 开发中，开发者可能会遇到一个关于 JSON 序列化配置的特殊情况。当使用 TypedResults 或 Results 类型返回 API 响应时，通过传统 MVC 方式配置的 JSON 序列化选项（如缩进格式）可能不会生效。

问题现象

开发者通常习惯在控制器配置中使用 AddJsonOptions 方法来设置 JSON 序列化选项，例如：

services.AddControllers().AddJsonOptions(options => {
    options.JsonSerializerOptions.WriteIndented = true;
});

这种配置对于传统的控制器返回方式（如 return Ok(object)）能够正常工作，JSON 响应会按照预期进行缩进格式化。然而，当使用 TypedResults.Ok(object) 或 Results.Ok(object) 这类返回方式时，这些配置却不会生效。

原因分析

这是由于 ASP.NET Core 中两种不同的 JSON 配置系统导致的：

1. 传统的 MVC 控制器使用 AddJsonOptions 配置的序列化选项
2. 最小 API 和 TypedResults/Results 使用独立的 HTTP JSON 选项配置系统

解决方案

要使 JSON 序列化选项对所有返回类型都生效，需要同时配置两个系统：

// 配置 MVC 控制器的 JSON 选项
services.AddControllers().AddJsonOptions(options => {
    options.JsonSerializerOptions.WriteIndented = true;
});

// 配置最小 API 和 TypedResults 的 JSON 选项
services.ConfigureHttpJsonOptions(options => {
    options.SerializerOptions.WriteIndented = true;
});

最佳实践

对于新项目，建议统一使用 ConfigureHttpJsonOptions 进行配置，因为：

1. 它同时适用于最小 API 和控制器 API
2. 代表了 ASP.NET Core 未来的发展方向
3. 保持配置的一致性，减少混淆

如果项目同时使用两种返回风格，则应该确保两套配置保持同步，以避免出现不一致的行为。

总结

理解 ASP.NET Core 中 JSON 序列化配置的双系统机制对于开发高质量的 Web API 至关重要。通过正确配置 HttpJsonOptions，开发者可以确保无论使用哪种返回风格，都能获得一致的 JSON 序列化行为。