巧用ActionFilterAttribute实现API日志的记录

 本文转载自微信公众号「UP技术控」，作者conan5566。转载本文请联系UP技术控公众号。  

背景

上回提到开发web api的时候，一般是需要记录api的输入输出信息，方便后续排查问题;使用的是委托的形式进行记录日志。

使用Func

这次我们使用另外一种方式，Filter来记录输入输出日志。

实现方式

1、首先在进入action的时候，定义OnActionExecuting。

 
 
 
    
  
  
  
  1. public override void OnActionExecuting(ActionExecutingContext context) 
    2. 
  
  
  
  2.         { 
    3. 
  
  
  
  3.             base.OnActionExecuting(context); 
    4. 
  
  
  
  4.  
    5. 
  
  
  
  5.             // 后续添加了获取请求的请求体，如果在实际项目中不需要删除即可 
    6. 
  
  
  
  6.             long contentLen = context.HttpContext.Request.ContentLength == null ? 0 : context.HttpContext.Request.ContentLength.Value; 
    7. 
  
  
  
  7.             if (contentLen > 0) 
    8. 
  
  
  
  8.             { 
    9. 
  
  
  
  9.                 // 读取请求体中所有内容 
    10. 
  
  
  
  10.                 System.IO.Stream stream = context.HttpContext.Request.Body; 
    11. 
  
  
  
  11.                 if (context.HttpContext.Request.Method == "POST") 
    12. 
  
  
  
  12.                 { 
    13. 
  
  
  
  13.                     stream.Position = 0; 
    14. 
  
  
  
  14.                 } 
    15. 
  
  
  
  15.                 byte[] buffer = new byte[contentLen]; 
    16. 
  
  
  
  16.                 stream.Read(buffer, 0, buffer.Length); 
    17. 
  
  
  
  17.                 // 转化为字符串 
    18. 
  
  
  
  18.                 RequestBody = System.Text.Encoding.UTF8.GetString(buffer); 
    19. 
  
  
  
  19.             } 
    20. 
  
  
  
  20.  
    21. 
  
  
  
  21.             ActionArguments = Newtonsoft.Json.JsonConvert.SerializeObject(context.ActionArguments); 
    22. 
  
  
  
  22.  
    23. 
  
  
  
  23.             Stopwatch = new Stopwatch(); 
    24. 
  
  
  
  24.             Stopwatch.Start(); 
    25. 
  
  
  
  25.         } 
    26.

2、定义Stopwatch ，计算方法的耗时。

 
 
 
    
  
  
  
  1. private string ActionArguments { get; set; } 
    2. 
  
  
  
  2.  
    3. 
  
  
  
  3.         ///  
    4. 
  
  
  
  4.         /// 请求体中的所有值 
    5. 
  
  
  
  5.         ///  
    6. 
  
  
  
  6.         private string RequestBody { get; set; } 
    7. 
  
  
  
  7.  
    8. 
  
  
  
  8.         private Stopwatch Stopwatch { get; set; } 
    9.

3、结束的时候，把信息打印出来OnActionExecuted。

 
 
 
    
  
  
  
  1. public override void OnActionExecuted(ActionExecutedContext context) 
    2. 
  
  
  
  2.         { 
    3. 
  
  
  
  3.             base.OnActionExecuted(context); 
    4. 
  
  
  
  4.             Stopwatch.Stop(); 
    5. 
  
  
  
  5.  
    6. 
  
  
  
  6.             string url = context.HttpContext.Request.Host + context.HttpContext.Request.Path + context.HttpContext.Request.QueryString; 
    7. 
  
  
  
  7.             string method = context.HttpContext.Request.Method; 
    8. 
  
  
  
  8.             string controller = context.Controller.ToString(); 
    9. 
  
  
  
  9.             string action = context.ActionDescriptor.DisplayName; 
    10. 
  
  
  
  10.             string token = ""; 
    11. 
  
  
  
  11.             if (context.HttpContext.Request != null && context.HttpContext.Request.Headers != null && context.HttpContext.Request.Headers["Authorization"].Count > 0) 
    12. 
  
  
  
  12.             { 
    13. 
  
  
  
  13.                 token = context.HttpContext.Request.Headers["Authorization"]; 
    14. 
  
  
  
  14.             } 
    15. 
  
  
  
  15.             string qs = ActionArguments; 
    16. 
  
  
  
  16.             dynamic result = context?.Result?.GetType()?.Name == "EmptyResult" ? new { Value = "无返回结果" } : context?.Result as dynamic; 
    17. 
  
  
  
  17.  
    18. 
  
  
  
  18.             string res = "在返回结果前发生了异常"; 
    19. 
  
  
  
  19.             try 
    20. 
  
  
  
  20.             { 
    21. 
  
  
  
  21.                 if (result != null) 
    22. 
  
  
  
  22.                 { 
    23. 
  
  
  
  23.                     res = Newtonsoft.Json.JsonConvert.SerializeObject(result.Value); 
    24. 
  
  
  
  24.                 } 
    25. 
  
  
  
  25.             } 
    26. 
  
  
  
  26.             catch (System.Exception) 
    27. 
  
  
  
  27.             { 
    28. 
  
  
  
  28.                 res = "日志未获取到结果，返回的数据无法序列化"; 
    29. 
  
  
  
  29.             } 
    30. 
  
  
  
  30.  
    31. 
  
  
  
  31.             NLogger.Info( 
    32. 
  
  
  
  32.                 $"地址：{url} \n " + 
    33. 
  
  
  
  33.                   $"controller：{controller} \n " + 
    34. 
  
  
  
  34.                     $"action：{action} \n " + 
    35. 
  
  
  
  35.                       $"token：{token} \n " + 
    36. 
  
  
  
  36.                 $"方式：{method} \n " + 
    37. 
  
  
  
  37.                 $"请求体：{RequestBody} \n " + 
    38. 
  
  
  
  38.                 $"参数：{qs}\n " + 
    39. 
  
  
  
  39.                 $"结果：{res}\n " + 
    40. 
  
  
  
  40.                 $"耗时：{Stopwatch.Elapsed.TotalMilliseconds} 毫秒（指控制器内对应方法执行完毕的时间）"); 
    41. 
  
  
  
  41.         } 
    42.

4、控制器调用LogAttribute。

 
 
 
    
  
  
  
  1. ///  
    2. 
  
  
  
  2.     /// 
    3. 
  
  
  
  3.     ///  
    4. 
  
  
  
  4.     [Produces("application/json")] 
    5. 
  
  
  
  5.     [LogAttribute] 
    6. 
  
  
  
  6.     [CustomExceptionFilterAttribute] 
    7. 
  
  
  
  7.     public class DefaultController : Controller 
    8. 
  
  
  
  8.     { 
    9. 
  
  
  
  9.     } 
    10.

 

完整代码



 
 
 
    
  
  
  
  1. using CompanyName.ProjectName.Core; 
    2. 
  
  
  
  2. using Microsoft.AspNetCore.Mvc.Filters; 
    3. 
  
  
  
  3. using System.Diagnostics; 
    4. 
  
  
  
  4.  
    5. 
  
  
  
  5. namespace CompanyName.ProjectName.HttpApi.Host.Code 
    6. 
  
  
  
  6. { 
    7. 
  
  
  
  7.     ///  
    8. 
  
  
  
  8.     /// 拦截器 
    9. 
  
  
  
  9.     ///  
    10. 
  
  
  
  10.     public class LogAttribute : ActionFilterAttribute 
    11. 
  
  
  
  11.     { 
    12. 
  
  
  
  12.         private string ActionArguments { get; set; } 
    13. 
  
  
  
  13.  
    14. 
  
  
  
  14.         ///  
    15. 
  
  
  
  15.         /// 请求体中的所有值 
    16. 
  
  
  
  16.         ///  
    17. 
  
  
  
  17.         private string RequestBody { get; set; } 
    18. 
  
  
  
  18.  
    19. 
  
  
  
  19.         private Stopwatch Stopwatch { get; set; } 
    20. 
  
  
  
  20.  
    21. 
  
  
  
  21.         ///  
    22. 
  
  
  
  22.         /// 
    23. 
  
  
  
  23.         ///  
    24. 
  
  
  
  24.         ///  
    25. 
  
  
  
  25.         public override void OnActionExecuting(ActionExecutingContext context) 
    26. 
  
  
  
  26.         { 
    27. 
  
  
  
  27.             base.OnActionExecuting(context); 
    28. 
  
  
  
  28.  
    29. 
  
  
  
  29.             // 后续添加了获取请求的请求体，如果在实际项目中不需要删除即可 
    30. 
  
  
  
  30.             long contentLen = context.HttpContext.Request.ContentLength == null ? 0 : context.HttpContext.Request.ContentLength.Value; 
    31. 
  
  
  
  31.             if (contentLen > 0) 
    32. 
  
  
  
  32.             { 
    33. 
  
  
  
  33.                 // 读取请求体中所有内容 
    34. 
  
  
  
  34.                 System.IO.Stream stream = context.HttpContext.Request.Body; 
    35. 
  
  
  
  35.                 if (context.HttpContext.Request.Method == "POST") 
    36. 
  
  
  
  36.                 { 
    37. 
  
  
  
  37.                     stream.Position = 0; 
    38. 
  
  
  
  38.                 } 
    39. 
  
  
  
  39.                 byte[] buffer = new byte[contentLen]; 
    40. 
  
  
  
  40.                 stream.Read(buffer, 0, buffer.Length); 
    41. 
  
  
  
  41.                 // 转化为字符串 
    42. 
  
  
  
  42.                 RequestBody = System.Text.Encoding.UTF8.GetString(buffer); 
    43. 
  
  
  
  43.             } 
    44. 
  
  
  
  44.  
    45. 
  
  
  
  45.             ActionArguments = Newtonsoft.Json.JsonConvert.SerializeObject(context.ActionArguments); 
    46. 
  
  
  
  46.  
    47. 
  
  
  
  47.             Stopwatch = new Stopwatch(); 
    48. 
  
  
  
  48.             Stopwatch.Start(); 
    49. 
  
  
  
  49.         } 
    50. 
  
  
  
  50.  
    51. 
  
  
  
  51.         ///  
    52. 
  
  
  
  52.         /// 
    53. 
  
  
  
  53.         ///  
    54. 
  
  
  
  54.         ///  
    55. 
  
  
  
  55.         public override void OnActionExecuted(ActionExecutedContext context) 
    56. 
  
  
  
  56.         { 
    57. 
  
  
  
  57.             base.OnActionExecuted(context); 
    58. 
  
  
  
  58.             Stopwatch.Stop(); 
    59. 
  
  
  
  59.  
    60. 
  
  
  
  60.             string url = context.HttpContext.Request.Host + context.HttpContext.Request.Path + context.HttpContext.Request.QueryString; 
    61. 
  
  
  
  61.             string method = context.HttpContext.Request.Method; 
    62. 
  
  
  
  62.             string controller = context.Controller.ToString(); 
    63. 
  
  
  
  63.             string action = context.ActionDescriptor.DisplayName; 
    64. 
  
  
  
  64.             string token = ""; 
    65. 
  
  
  
  65.             if (context.HttpContext.Request != null && context.HttpContext.Request.Headers != null && context.HttpContext.Request.Headers["Authorization"].Count > 0) 
    66. 
  
  
  
  66.             { 
    67. 
  
  
  
  67.                 token = context.HttpContext.Request.Headers["Authorization"]; 
    68. 
  
  
  
  68.             } 
    69. 
  
  
  
  69.             string qs = ActionArguments; 
    70. 
  
  
  
  70.             dynamic result = context?.Result?.GetType()?.Name == "EmptyResult" ? new { Value = "无返回结果" } : context?.Result as dynamic; 
    71. 
  
  
  
  71.  
    72. 
  
  
  
  72.             string res = "在返回结果前发生了异常"; 
    73. 
  
  
  
  73.             try 
    74. 
  
  
  
  74.             { 
    75. 
  
  
  
  75.                 if (result != null) 
    76. 
  
  
  
  76.                 { 
    77. 
  
  
  
  77.                     res = Newtonsoft.Json.JsonConvert.SerializeObject(result.Value); 
    78. 
  
  
  
  78.                 } 
    79. 
  
  
  
  79.             } 
    80. 
  
  
  
  80.             catch (System.Exception) 
    81. 
  
  
  
  81.             { 
    82. 
  
  
  
  82.                 res = "日志未获取到结果，返回的数据无法序列化"; 
    83. 
  
  
  
  83.             } 
    84. 
  
  
  
  84.  
    85. 
  
  
  
  85.             NLogger.Info( 
    86. 
  
  
  
  86.                 $"地址：{url} \n " + 
    87. 
  
  
  
  87.                   $"controller：{controller} \n " + 
    88. 
  
  
  
  88.                     $"action：{action} \n " + 
    89. 
  
  
  
  89.                       $"token：{token} \n " + 
    90. 
  
  
  
  90.                 $"方式：{method} \n " + 
    91. 
  
  
  
  91.                 $"请求体：{RequestBody} \n " + 
    92. 
  
  
  
  92.                 $"参数：{qs}\n " + 
    93. 
  
  
  
  93.                 $"结果：{res}\n " + 
    94. 
  
  
  
  94.                 $"耗时：{Stopwatch.Elapsed.TotalMilliseconds} 毫秒（指控制器内对应方法执行完毕的时间）"); 
    95. 
  
  
  
  95.         } 
    96. 
  
  
  
  96.     } 
    97. 
  
  
  
  97. } 
    98.

分享名称：巧用ActionFilterAttribute实现API日志的记录
文章来源：http://www.mswzjz.cn/qtweb/news6/476856.html

攀枝花网站建设、攀枝花网站运维推广公司-贝锐智能，是专注品牌与效果的网络营销公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 贝锐智能

贝锐智能技术为您推荐以下文章

网站收录知识

同城分类信息

成都多线机房　　 　传美奇电器　　 　泽君科技　　 　商城系统开发　　 　bgp多线机房托管　　 　led无边发光字　　 　定制网站设计　　 　软文发布平台　　 　子晨包装　　 　阿坝网站设计　　 　马边网站建设　　 　蓬安网站建设　　 　成都劢可为　　 　营山产后修复　　 　seo推广公司　　 　四川审计公司　　 　成都网络营销　　 　成都广告公司　　 　资阳服务器托管　　 　成都公司注册