在 ASP.NET Core 3.1 中使用带有 HttpContext.Response 的新 Json 序列化程序

Question

当我们想在 ASP.NET Core 的管道中将对象序列化为 JSON 字符串时，我们需要使用 HttpContext.Response.Body.WriteAsync，除非我遗漏了什么，因为没有我们可以轻松使用的 Result 属性分配一个JsonResult 对象。

除非有更好的替代方案，否则使用上述方法究竟是如何实现序列化的？

注意： JSON 序列化程序的选项应与 ASP.NET Core 3.1 中使用的（默认）选项相同。

如果需要（不是我们的例子），可以通过IServiceCollection.AddJsonOptions 中间件修改它们。

例子：

app.Use( next =>
{
    return async context =>
    {
        if (<someFunkyConditionalExample>)
        {
            // serialize a JSON object as the response's content, returned to the end-user.
            // this should use ASP.NET Core 3.1's defaults for JSON Serialization.
        }
        else
        {
            await next(context);
        }
    };
});

Answer 1

首先，您可以使用these extension methods 将字符串直接写入您的响应中，例如：

await context.Response.WriteAsync("some text");

确保您已导入正确的命名空间，以便您可以访问这些扩展：

using Microsoft.AspNetCore.Http;

其次，如果您想获取框架正在使用的 JSON 序列化器设置，您可以从 DI 容器中提取它们：

var jsonOptions = context.RequestServices.GetService<IOptions<JsonOptions>>();

所以这将使您的完整管道代码看起来像这样：

app.Use(next =>
{
    return async context =>
    {
        if (<someFunkyConditionalExample>)
        {
            // Get the options
            var jsonOptions = context.RequestServices.GetService<IOptions<JsonOptions>>();

            // Serialise using the settings provided
            var json = JsonSerializer.Serialize(
                new {Foo = "bar"}, // Switch this with your object
                jsonOptions?.Value.JsonSerializerOptions);

            // Write to the response
            await context.Response.WriteAsync(json);
        }
        else
        {
            await next(context);
        }
    };
});