Asp.NET Core 6中获取Ok()返回精确字符串并正确保存JSON

问题原因 #

Asp.NET Core的Ok()方法使用框架默认的JSON序列化配置（比如引号转义规则、驼峰命名策略等），而手动调用JsonSerializer.Serialize()时用的是默认参数，两者配置不一致，导致生成的JSON字符串存在差异。

解决方案 #

通过注入框架的JSON序列化配置，确保本地序列化的结果和Ok()返回的完全一致，同时针对大JSON文件优化写入方式：

1. 注入JSON配置选项 #

在控制器构造函数中注入IOptions<JsonOptions>，获取框架默认的序列化配置：

private readonly IService _service;
private readonly IOptions<JsonOptions> _jsonOptions;

public YourController(IService service, IOptions<JsonOptions> jsonOptions)
{
    _service = service;
    _jsonOptions = jsonOptions;
}

2. 修改接口方法实现 #

使用框架配置序列化对象，并采用流式写入优化大文件处理：

[HttpPost]
[Route("rest/result")]
public async Task<IActionResult> GetResult(string requestId)
{
    var item = _service.GetItem(requestId);
    if (item?.Result == null)
    {
        return NotFound();
    }

    // 复用框架默认的JSON序列化配置，保证与Ok()返回内容一致
    var jsonString = JsonSerializer.Serialize(item.Result, _jsonOptions.Value.SerializerOptions);
    
    // 确保输出目录存在
    var outputDir = @"c:\output";
    Directory.CreateDirectory(outputDir);
    var filePath = Path.Combine(outputDir, $"{requestId}.json");
    
    // 流式写入大文件，降低内存占用
    await using var stream = new FileStream(filePath, FileMode.Create, FileAccess.Write, FileShare.None, 4096, true);
    await using var writer = new StreamWriter(stream, Encoding.UTF8);
    await writer.WriteAsync(jsonString);

    return Ok(item.Result);
}

关键说明 #

• 复用框架的SerializerOptions是保证序列化结果一致的核心，它包含了Asp.NET Core默认的JSON处理规则（如字符转义、属性命名策略等）。
• 针对大JSON文件，使用FileStream流式写入比File.WriteAllTextAsync更高效，避免一次性加载大字符串到内存中引发性能问题。
• 提前创建输出目录，避免因目录不存在导致写入失败。

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