防止 Audit.Net 将 BodyContent 值格式化为字符串？

问题描述

我对 audit.net 越来越熟悉，发现序列化工作不太正常。我想知道是否需要添加更多配置。我目前的配置如下：

// Startup.cs
public void ConfigureServices(IServiceCollection services)
{
    // ... configuration here
    Audit.Core.Configuration.Setup().UseFileLogProvider("./logs"); // issue also happens when using sqlServer
}

public void Configure(IApplicationBuilder app,IWebHostEnvironment env)
{
    app.Use(async (context,next) =>
    {
        context.Request.EnableBuffering();
        await next();
    });

    app.UseAuditMiddleware(_ => _
        .IncludeHeaders()
        .IncludeResponseHeaders()
        .IncludeRequestBody()
        .IncludeResponseBody(ctx => ctx.Response.StatusCode == 200));

    app.UseEndpoints(endpoints => 
    {
        endpoints.MapControllers();
    });
}

我得到什么（带有转义字符的字符串）：

"ResponseBody": {
  "Type": "application/json; charset=utf-8","Value": "[{\"date\":\"2021-04-22T12:39:31.173043-06:00\",\"temperatureC\":4,\"temperatureF\":39,\"summary\":\"Balmy\"},{\"date\":\"2021-04-23T12:39:31.1734617-06:00\",\"temperatureC\":34,\"temperatureF\":93,{\"date\":\"2021-04-24T12:39:31.1734642-06:00\",\"temperatureC\":-8,\"temperatureF\":18,\"summary\":\"Cool\"},{\"date\":\"2021-04-25T12:39:31.1734646-06:00\",\"temperatureC\":32,\"temperatureF\":89,\"summary\":\"Mild\"},{\"date\":\"2021-04-26T12:39:31.1734647-06:00\",\"temperatureC\":-2,\"temperatureF\":29,\"summary\":\"Mild\"}]"
},

我希望得到的（对象）：

"ResponseBody": {
  "Type": "application/json; charset=utf-8","Value": [
    {
      "date": "2021-04-22T12:39:31.173043-06:00","temperatureC": 4,"temperatureF": 39,"summary": "Balmy"
    },{
      // more temperatures
    },...,]

解决方法

那是因为中间件只能访问已经序列化为字节数组的响应体，所以只能解码为字符串。

另一方面，action filter 可以在对象写入响应流之前访问该对象，因此如果您也将其添加到管道中，到达操作方法的请求的审核事件将与您期望的一样。

例如，在您的 Startup 课上：

using Audit.WebApi;

public void ConfigureServices(IServiceCollection services)
{
    services
        .AddMvc(mvcOptions =>
        {
            mvcOptions.AddAuditFilter(a => a
                .LogAllActions()
                .IncludeResponseHeaders()
                .IncludeRequestBody()
                .IncludeResponseBody());
        });
}

检查 this 以了解有关配置中间件和操作过滤器的更多信息。

如果您不想或无法添加操作过滤器，您可以在使用自定义操作保存之前修改审核事件。例如，同样在您的 Startup 课上：

using Newtonsoft.Json;

Audit.Core.Configuration.AddOnSavingAction(scope =>
{
    var audit = scope.GetWebApiAuditAction();
    if (audit?.ResponseBody?.Type.Contains("application/json") == true)
    {
        audit.ResponseBody.Value = JsonConvert.DeserializeObject(audit.ResponseBody.Value.ToString());
    }
});