需要将asp.net webapi 2请求和响应主体记录到数据库中

Question

我正在使用IIS上托管的Microsoft Asp.net WebApi2.我非常想简单地记录每个帖子的请求体(xml或json)和响应体.

这个项目或处理帖子的控制器没什么特别之处.我对使用nLog,elmah,log4net等日志框架或webapi的内置跟踪功能不感兴趣,除非有必要这样做.

我只是想知道在哪里放置我的日志代码以及如何从传入和传出的请求和响应中获取实际的json或xml.

我的控制器发布方法:

public HttpResponseMessage Post([FromBody])Employee employee)
{
   if (ModelState.IsValid)
   {
      // insert employee into to database
   }

}

Answer 1

我建议使用DelegatingHandler.然后,您无需担心控制器中的任何日志记录代码.

public class LogRequestAndResponseHandler : DelegatingHandler
{
    protected override async Task<HttpResponseMessage> SendAsync(
        HttpRequestMessage request, CancellationToken cancellationToken)
    {
        // log request body
        string requestBody = await request.Content.ReadAsStringAsync();
        Trace.WriteLine(requestBody);

        // let other handlers process the request
        var result = await base.SendAsync(request, cancellationToken);

        if (result.Content != null)
        {
            // once response body is ready, log it
            var responseBody = await result.Content.ReadAsStringAsync();
            Trace.WriteLine(responseBody);
        }

        return result;
    }
}

只需Trace.WriteLine用您的日志代码替换并注册处理程序,WebApiConfig如下所示:

config.MessageHandlers.Add(new LogRequestAndResponseHandler());

Answer 2

有多种方法可以为每个WebAPI方法调用一般地处理请求/响应日志记录:

1. ActionFilterAttribute:可以编写自定义ActionFilterAttribute并装饰控制器/操作方法以启用日志记录.

   Con:你需要装饰每个控制器/方法(你仍然可以在基础控制器上完成它,但它仍然不能解决交叉问题.

2. 覆盖BaseController并处理日志记录.

   Con:我们期待/强制控制器继承自定义基本控制器.

3. 用DelegatingHandler.

   优点:我们没有采用这种方法来触及控制器/方法.委托处理程序处于隔离状态,可以正常处理请求/响应日志记录.

有关更深入的文章,请参阅http://weblogs.asp.net/fredriknormen/log-message-request-and-response-in-asp-net-webapi.

Answer 3

您拥有的一个选项是使用创建动作过滤器并使用它来装饰WebApiController/ApiMethod.

过滤属性

public class MyFilterAttribute : System.Web.Http.Filters.ActionFilterAttribute
    {
        public override void OnActionExecuting(HttpActionContext actionContext)
        {
            if (actionContext.Request.Method == HttpMethod.Post)
            {
                var postData = actionContext.ActionArguments;
                //do logging here
            }
        }
    }

WebApi控制器

[MyFilterAttribute]
public class ValuesController : ApiController{..}

要么

[MyFilterAttribute]
public void Post([FromBody]string value){..}

希望这可以帮助.