Azure Functions 2 - 如何控制json序列化设置

Posted 2021-04-03

我希望能够控制从Azure函数（V2）返回内容结果时json的格式。以下是我正在做的简化版本：

[FunctionName("CreateThing")]
public static async Task<IActionResult> CreateThingAsync([HttpTrigger(AuthorizationLevel.Anonymous, "post", Route = "thing")]HttpRequest req, ILogger log)
{
    try{
        var result = await GetResultAsync(req);
        return new CreatedResult($"thing/{result.id}", result);
    }
    catch(ErrorException) {
        return new BadRequestObjectResult(e.Error);
    }
}

有没有办法控制返回结果时的格式，而不使用模型上的属性？我希望能够使用JsonSerializerSettings但我无法找到一种方法，可以根据上面的示例为返回的结果配置它。

答案

今天我自己也遇到了同样的问题。

正如杰瑞评论的那样，JsonResult可以带你到达那里;它支持StatusCode属性：

return new JsonResult(new WorkQueuedResponseMessage
{
    ...
}, Constants.CommunicationJsonSerializerSettings)
{
    StatusCode = StatusCodes.Status202Accepted,
};

对于自定义标头，我的解决方案更加hacky。我定义了自己的IActionResult，只是将标题粘贴到另一个IActionResult上：

private sealed class HeaderActionResult : IActionResult
{
    private readonly IActionResult _result;

    public HeaderActionResult(IActionResult result)
    {
        _result = result;
        HeaderDictionary = new HeaderDictionary();
        Headers = new ResponseHeaders(HeaderDictionary);
    }

    public IHeaderDictionary HeaderDictionary { get; }

    public ResponseHeaders Headers { get; }

    public async Task ExecuteResultAsync(ActionContext context)
    {
        foreach (var header in HeaderDictionary)
            context.HttpContext.Response.Headers.Append(header.Key, header.Value);
        await _result.ExecuteResultAsync(context);
    }
}

然后我可以根据需要定义辅助方法：

public static IActionResult EnableCacheHeaders(this IActionResult response, TimeSpan time)
{
    return new HeaderActionResult(response)
    {
        Headers =
        {
            CacheControl = new CacheControlHeaderValue
            {
                Public = true,
                MaxAge = time,
            },
            Expires = DateTimeOffset.UtcNow + time,
        },
    };
}

并使用它们：

return new JsonResult(new WorkAlreadyCompletedResponseMessage
{
    ...
}, Constants.CommunicationJsonSerializerSettings).EnableCacheHeaders(TimeSpan.FromDays(1));

这是一种使用自定义JSON序列化，状态代码和标头返回IActionResult的方法，同时使用尽可能多的ASP.NET Core类型。希望将来我们能够获得更好的集成/注入故事。