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過程中的一個小經驗，與大家分享。

后台服務通常需要記錄一些運行記錄，如輸入輸出、請求信息、處理過程、響應信息等，在以前記錄請求數據和響應數據時，我經常在具體的接口方法中處理，如：

/// 賬戶驗證
/// </summary>
/// <param name="instance"></param>
/// <returns></returns>
public LoginResponse UserCheck(UserInfo instance)
{
　　LogHelper.LogRequest<UserInfo>(instance);
 
　　var response = InnerAPI.UserLogin(instance);
 
　　LogHelper.LogResponse<LoginResponse>(response);
 
　　return response;
}

 

LogHelper.LogRequest 用於記錄請求的數據，LogHelper.LogResponse用於記錄返回的數據。

這樣處理的話，每個方法中都要重復如此記錄，不簡潔，不方便，還處於復制代碼的階段。一直想改變，去苦於沒有思路。

某一天在博客園看到《ASP.NET Web API 處理架構》，如獲至寶。於是開始在Web API的生命周期中尋找可以截獲到這些數據的點，最終在官網上找到一篇文章《HTTP Message Handlers》，參考其中的說明，我重新構造了記錄輸入輸出的方法：

 

/// <summary>
/// 消息處理程序
/// </summary>
public class CustomMessageHandler : DelegatingHandler
{
　　/// <summary>
　　/// 重寫發送HTTP請求到內部處理程序的方法
　　/// </summary>
　　/// <param name="request">請求信息</param>
　　/// <param name="cancellationToken">取消操作的標記</param>
　　/// <returns></returns>
　　protected override Task<HttpResponseMessage> 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<HttpResponseMessage>(
　　　　(task) =>
　　　　{
　　　　　　// 記錄響應內容
　　　　　　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，成熟穩定。

喜歡的朋友趕緊試試吧。