.NET7中使用Newtonsoft.Json返回JArray/JObject时响应JSON异常

根因 #

.NET 7的ASP.NET Core默认用System.Text.Json做JSON序列化，但你用的是Newtonsoft.Json的JArray、JObject类型——这俩序列化框架不兼容，System.Text.Json没法正确解析Newtonsoft的JSON类型，所以返回时才会出现嵌套空数组、值丢失的异常。而JsonConvert.Serialize能正常工作，是因为它本身就是Newtonsoft的序列化逻辑。

解决方法 #

1. 安装适配ASP.NET Core的Newtonsoft包 #

先确保项目装了Newtonsoft.Json.AspNetCore，可以用NuGet包管理器安装，或者执行CLI命令：

# NuGet包管理器命令
Install-Package Newtonsoft.Json.AspNetCore

# .NET CLI命令
dotnet add package Newtonsoft.Json.AspNetCore

2. 全局配置ASP.NET Core使用Newtonsoft.Json #

在Program.cs里修改服务配置，把默认序列化器换成Newtonsoft的：

var builder = WebApplication.CreateBuilder(args);

// 添加控制器服务并指定用Newtonsoft.Json序列化
builder.Services.AddControllers()
    .AddNewtonsoftJson(options =>
    {
        // 这里可以按需配置Newtonsoft的序列化规则，比如驼峰命名、日期格式等
        // 示例：启用驼峰命名
        // options.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();
    });

var app = builder.Build();

app.MapControllers();

app.Run();

3. 验证结果 #

配置完成后，再返回你的Test对象或JObject，ASP.NET Core会用Newtonsoft.Json处理序列化，就能得到预期的JSON结构了。

临时替代方案 #

如果不想全局替换序列化器，也可以在接口里手动序列化后返回ContentResult：

[HttpGet]
public IActionResult GetTest()
{
    var test = new Test
    {
        Array = new JArray(new JObject { { "foo", "bar" } })
    };
    var jsonStr = JsonConvert.SerializeObject(test);
    return Content(jsonStr, "application/json");
}

不过这种方式需要每个涉及Newtonsoft类型的接口都手动处理，不如全局配置省心。

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