ASP.NET Web API 记录请求响应数据到日志的一个方法

原文:ASP.NET Web API 记录请求响应数据到日志的一个方法

原文：http://blog.bossma.cn/dotnet/asp-net-web-api-log-request-response/

ASP.NET Web API 记录请求响应数据到日志的一个方法

REST风格的服务架构已经成为越来越多人的选择，之前我用过WCF来实现REST服务，WCF是一个很强大的框架，干这点小事有点太沉重的感觉。后来微软又推出了一个ASP.NET Web API，专门用来处理一些基本的Http服务，即灵活又简单，推荐大家都看看。

今天这篇文章是使用ASP.NET Web API过程中的一个小经验，与大家分享。

后台服务通常需要记录一些运行记录，如输入输出、请求信息、处理过程、响应信息等，在以前记录请求数据和响应数据时，我经常在具体的接口方法中处理，如：

/// 账户验证
/// &lt;/summary&gt;
/// &lt;param name="instance"&gt;&lt;/param&gt;
/// &lt;returns&gt;&lt;/returns&gt;
public LoginResponse UserCheck(UserInfo instance)
{LogHelper.LogRequest&lt;UserInfo&gt;(instance);var response = InnerAPI.UserLogin(instance);LogHelper.LogResponse&lt;LoginResponse&gt;(response);return response;
}

LogHelper.LogRequest 用于记录请求的数据，LogHelper.LogResponse用于记录返回的数据。

这样处理的话，每个方法中都要重复如此记录，不简洁，不方便，还处于复制代码的阶段。一直想改变，去苦于没有思路。

某一天在博客园看到《ASP.NET Web API 处理架构》，如获至宝。于是开始在Web API的生命周期中寻找可以截获到这些数据的点，最终在官网上找到一篇文章《HTTP Message Handlers》，参考其中的说明，我重新构造了记录输入输出的方法：

/// &lt;summary&gt;
/// 消息处理程序
/// &lt;/summary&gt;
public class CustomMessageHandler : DelegatingHandler
{/// &lt;summary&gt;/// 重写发送HTTP请求到内部处理程序的方法/// &lt;/summary&gt;/// &lt;param name="request"&gt;请求信息&lt;/param&gt;/// &lt;param name="cancellationToken"&gt;取消操作的标记&lt;/param&gt;/// &lt;returns&gt;&lt;/returns&gt;protected override Task&lt;HttpResponseMessage&gt; SendAsync(HttpRequestMessage request, CancellationToken cancellationToken){// 记录请求内容if (request.Content != null){LogWriter.ToInfo(string.Format("请求Content:{0}", request.Content.ReadAsStringAsync().Result));}// 发送HTTP请求到内部处理程序，在异步处理完成后记录响应内容return base.SendAsync(request, cancellationToken).ContinueWith&lt;HttpResponseMessage&gt;((task) =&gt;{// 记录响应内容LogWriter.ToInfo(string.Format("响应Content:{0}", task.Result.Content.ReadAsStringAsync().Result));return task.Result;});}
}

为了使消息处理进入我们自定义的消息处理程序，需要在Global.asax文件的Application_Start方法中，将CustomMessageHandler添加到MessageHandlers中：

protected static void Configure(HttpConfiguration config)
{config.MessageHandlers.Add(new CustomMessageHandler());
}protected void Application_Start(object sender, EventArgs e)
{Configure(GlobalConfiguration.Configuration);
}

DelegatingHandler使用委托模式，这样添加以后，程序就会执行CustomMessageHandler中重写的方法了。

这样也算AOP了一下吧。

关于日志记录，推荐使用log4net或NLog，成熟稳定。

喜欢的朋友赶紧试试吧。

ASP.NET Web API 记录请求响应数据到日志的一个方法相关推荐

ASP.NET Core：从ASP.NET Web API迁移的多层数据服务应用程序
目录介绍设置和运行示例应用程序类库项目依赖注入访问应用程序设置实体框架核心相关更改主键标识插入问题数据上下文和连接字符串自定义存储库(Repositories) LINQ表达式翻新( ...
ASP NET Web API 2框架揭秘
ASP.NET Web API2框架揭秘(.NET领域再现力作顶级专家精讲微软全新轻量级通信平台) 蒋金楠著 ISBN 978-7-121-23536-8 2014年7月出版定价:108.00 ...
ASP.NET Web API 基本操作(CRUD)
上一篇介绍了ASP.NET Web API的基本知识和原理,这一篇我们通过一个更直观的实例,对产品进行CRUD操作(Create/Read/Update/Delete)来继续了解一下它的基本应用. 创 ...
java调用asp.net webapi_通过HttpClient 调用ASP.NET Web API示例
在前面两篇文章中我们介绍了ASP.NET Web API的基本知识和原理,并且通过简单的实例了解了它的基本(CRUD)操作.我们是通过JQuery和Ajax对Web API进行数据操作.这一篇我们来介 ...
监控系统简介（二）：使用 App Metrics 在 ASP.NET Web API 中记录指标
回顾在<监控系统简介:使用 Prometheus 与 Grafana>一文中,我们了解了什么是监控系统,Prometheus 这一监控工具及它提供的数据类型.PromQL 以及 Graf ...
【ASP.NET Web API教程】5.2 发送HTML表单数据：URL编码的表单数据
注:本文是[ASP.NET Web API系列教程]的一部分,如果您是第一次看本系列教程,请先看前面的内容. 5.2 Sending HTML Form Data 5.2 发送HTML表单数据本文引 ...
利用查询条件对象，在Asp.net Web API中实现对业务数据的分页查询处理
在Asp.net Web API中,对业务数据的分页查询处理是一个非常常见的接口,我们需要在查询条件对象中,定义好相应业务的查询参数,排序信息,请求记录数和每页大小信息等内容,根据这些查询信息,我们在 ...
ASP.NET MVC和ASP.NET Web API跨域请求问题解决方案【最全】
无论是ASP.NET MVC和ASP.NET Web API跨域请求大致分成2种方式第一种:web.config 配置第二种:用HttpContext.Response.AppendHeader设 ...
ASP.NET Web API 异常日志记录
如果在 ASP.NET MVC 应用程序中记录异常信息,我们只需要在 Global.asax 的 Application_Error 中添加代码就可以了,比如: public class MvcApp ...

ASP.NET Web API 记录请求响应数据到日志的一个方法

ASP.NET Web API 记录请求响应数据到日志的一个方法

ASP.NET Web API 记录请求响应数据到日志的一个方法相关推荐

最新文章

热门文章