本篇內(nèi)容主要講解“如何使用ActionFilterAttribute實現(xiàn)API日志的記錄”，感興趣的朋友不妨來看看。本文介紹的方法操作簡單快捷，實用性強(qiáng)。下面就讓小編來帶大家學(xué)習(xí)“如何使用ActionFilterAttribute實現(xiàn)API日志的記錄”吧!
公司主營業(yè)務(wù)：做網(wǎng)站、網(wǎng)站建設(shè)、移動網(wǎng)站開發(fā)等業(yè)務(wù)。幫助企業(yè)客戶真正實現(xiàn)互聯(lián)網(wǎng)宣傳，提高企業(yè)的競爭能力。創(chuàng)新互聯(lián)建站是一支青春激揚(yáng)、勤奮敬業(yè)、活力青春激揚(yáng)、勤奮敬業(yè)、活力澎湃、和諧高效的團(tuán)隊。公司秉承以“開放、自由、嚴(yán)謹(jǐn)、自律”為核心的企業(yè)文化，感謝他們對我們的高要求，感謝他們從不同領(lǐng)域給我們帶來的挑戰(zhàn)，讓我們激情的團(tuán)隊有機(jī)會用頭腦與智慧不斷的給客戶帶來驚喜。創(chuàng)新互聯(lián)建站推出永仁免費(fèi)做網(wǎng)站回饋大家。
實現(xiàn)方式
1、首先在進(jìn)入action的時候，定義OnActionExecuting。
重慶分公司
重慶分公司
public override void OnActionExecuting(ActionExecutingContext context) { base.OnActionExecuting(context); // 后續(xù)添加了獲取請求的請求體，如果在實際項目中不需要刪除即可 long contentLen = context.HttpContext.Request.ContentLength == null ? 0 : context.HttpContext.Request.ContentLength.Value; if (contentLen > 0) { // 讀取請求體中所有內(nèi)容 System.IO.Stream stream = context.HttpContext.Request.Body; if (context.HttpContext.Request.Method == "POST") { stream.Position = 0; } byte[] buffer = new byte[contentLen]; stream.Read(buffer, 0, buffer.Length); // 轉(zhuǎn)化為字符串 RequestBody = System.Text.Encoding.UTF8.GetString(buffer); } ActionArguments = Newtonsoft.Json.JsonConvert.SerializeObject(context.ActionArguments); Stopwatch = new Stopwatch(); Stopwatch.Start(); }2、定義Stopwatch ，計算方法的耗時。
private string ActionArguments { get; set; } /// /// 請求體中的所有值 /// private string RequestBody { get; set; } private Stopwatch Stopwatch { get; set; }3、結(jié)束的時候，把信息打印出來OnActionExecuted。
public override void OnActionExecuted(ActionExecutedContext context) { base.OnActionExecuted(context); Stopwatch.Stop(); string url = context.HttpContext.Request.Host + context.HttpContext.Request.Path + context.HttpContext.Request.QueryString; string method = context.HttpContext.Request.Method; string controller = context.Controller.ToString(); string action = context.ActionDescriptor.DisplayName; string token = ""; if (context.HttpContext.Request != null && context.HttpContext.Request.Headers != null && context.HttpContext.Request.Headers["Authorization"].Count > 0) { token = context.HttpContext.Request.Headers["Authorization"]; } string qs = ActionArguments; dynamic result = context?.Result?.GetType()?.Name == "EmptyResult" ? new { Value = "無返回結(jié)果" } : context?.Result as dynamic; string res = "在返回結(jié)果前發(fā)生了異常"; try { if (result != null) { res = Newtonsoft.Json.JsonConvert.SerializeObject(result.Value); } } catch (System.Exception) { res = "日志未獲取到結(jié)果，返回的數(shù)據(jù)無法序列化"; } NLogger.Info( $"地址：{url} \n " + $"controller：{controller} \n " + $"action：{action} \n " + $"token：{token} \n " + $"方式：{method} \n " + $"請求體：{RequestBody} \n " + $"參數(shù)：{qs}\n " + $"結(jié)果：{res}\n " + $"耗時：{Stopwatch.Elapsed.TotalMilliseconds} 毫秒（指控制器內(nèi)對應(yīng)方法執(zhí)行完畢的時間）"); }4、控制器調(diào)用LogAttribute。
////// /// [Produces("application/json")] [LogAttribute] [CustomExceptionFilterAttribute] public class DefaultController : Controller { }
完整代碼
using CompanyName.ProjectName.Core; using Microsoft.AspNetCore.Mvc.Filters; using System.Diagnostics; namespace CompanyName.ProjectName.HttpApi.Host.Code { /// /// 攔截器 /// public class LogAttribute : ActionFilterAttribute { private string ActionArguments { get; set; } /// /// 請求體中的所有值 /// private string RequestBody { get; set; } private Stopwatch Stopwatch { get; set; } /// /// /// /// public override void OnActionExecuting(ActionExecutingContext context) { base.OnActionExecuting(context); // 后續(xù)添加了獲取請求的請求體，如果在實際項目中不需要刪除即可 long contentLen = context.HttpContext.Request.ContentLength == null ? 0 : context.HttpContext.Request.ContentLength.Value; if (contentLen > 0) { // 讀取請求體中所有內(nèi)容 System.IO.Stream stream = context.HttpContext.Request.Body; if (context.HttpContext.Request.Method == "POST") { stream.Position = 0; } byte[] buffer = new byte[contentLen]; stream.Read(buffer, 0, buffer.Length); // 轉(zhuǎn)化為字符串 RequestBody = System.Text.Encoding.UTF8.GetString(buffer); } ActionArguments = Newtonsoft.Json.JsonConvert.SerializeObject(context.ActionArguments); Stopwatch = new Stopwatch(); Stopwatch.Start(); } /// /// /// /// public override void OnActionExecuted(ActionExecutedContext context) { base.OnActionExecuted(context); Stopwatch.Stop(); string url = context.HttpContext.Request.Host + context.HttpContext.Request.Path + context.HttpContext.Request.QueryString; string method = context.HttpContext.Request.Method; string controller = context.Controller.ToString(); string action = context.ActionDescriptor.DisplayName; string token = ""; if (context.HttpContext.Request != null && context.HttpContext.Request.Headers != null && context.HttpContext.Request.Headers["Authorization"].Count > 0) { token = context.HttpContext.Request.Headers["Authorization"]; } string qs = ActionArguments; dynamic result = context?.Result?.GetType()?.Name == "EmptyResult" ? new { Value = "無返回結(jié)果" } : context?.Result as dynamic; string res = "在返回結(jié)果前發(fā)生了異常"; try { if (result != null) { res = Newtonsoft.Json.JsonConvert.SerializeObject(result.Value); } } catch (System.Exception) { res = "日志未獲取到結(jié)果，返回的數(shù)據(jù)無法序列化"; } NLogger.Info( $"地址：{url} \n " + $"controller：{controller} \n " + $"action：{action} \n " + $"token：{token} \n " + $"方式：{method} \n " + $"請求體：{RequestBody} \n " + $"參數(shù)：{qs}\n " + $"結(jié)果：{res}\n " + $"耗時：{Stopwatch.Elapsed.TotalMilliseconds} 毫秒（指控制器內(nèi)對應(yīng)方法執(zhí)行完畢的時間）"); } } } 到此，相信大家對“如何使用ActionFilterAttribute實現(xiàn)API日志的記錄”有了更深的了解，不妨來實際操作一番吧！這里是創(chuàng)新互聯(lián)網(wǎng)站，更多相關(guān)內(nèi)容可以進(jìn)入相關(guān)頻道進(jìn)行查詢，關(guān)注我們，繼續(xù)學(xué)習(xí)！
