ASP.NET Core中TypedResults与JsonOptions的配置问题解析

在ASP.NET Core 9.0开发中，使用TypedResults返回JSON数据时，开发者可能会遇到一个常见问题：通过AddJsonOptions配置的JSON序列化选项（如缩进格式）无法生效。本文将深入分析这一现象的原因，并提供正确的解决方案。

问题现象

当开发者在控制器中使用两种不同的方式返回JSON数据时：

1. 直接返回对象（如return Ok(x)）
2. 使用TypedResults.Ok(x)

会发现第一种方式能正确应用通过AddJsonOptions配置的JSON序列化选项，而第二种方式则不会。特别是在配置了缩进格式等选项时，TypedResults返回的JSON数据会保持默认的紧凑格式。

根本原因

这个问题源于ASP.NET Core框架中两种不同的JSON配置系统：

1. MVC风格的配置（通过AddJsonOptions）

   • 适用于传统控制器(Controller)的返回方式
   • 配置在MvcJsonOptions中

2. 最小API风格的配置（通过ConfigureHttpJsonOptions）

   • 适用于TypedResults和Results等最小API返回方式
   • 配置在HttpJsonOptions中

TypedResults属于最小API的范畴，因此它不会读取MvcJsonOptions中的配置，而是使用HttpJsonOptions的默认配置。

解决方案

要使TypedResults也能应用自定义的JSON序列化选项，开发者需要同时配置HttpJsonOptions：

builder.Services.ConfigureHttpJsonOptions(options => {
    options.SerializerOptions.WriteIndented = true;
    // 其他JSON配置...
});

这种双重配置的方式确保了无论是传统控制器返回方式还是TypedResults，都能应用一致的JSON序列化行为。

最佳实践

对于同时使用传统控制器和最小API的项目，建议：

1. 创建统一的JSON配置方法，避免重复代码
2. 在Startup或Program中同时调用AddJsonOptions和ConfigureHttpJsonOptions
3. 保持两种配置的一致性，避免产生混淆

总结

理解ASP.NET Core中JSON配置的双系统机制对于开发高质量的Web API至关重要。通过正确配置HttpJsonOptions，开发者可以确保TypedResults等最小API返回方式也能应用所需的JSON序列化选项，从而提供一致的API响应格式。