.net core webapi通过中间件获取请求和响应内容的方法

韩依楠

本文主要根据中间件来实现对

1. .net core webapi

复制代码

中产生的请求和响应数据进行获取并存入日志文件中；

这里不详细介绍日志文件的使用。你可以自己接入NLog,log4net，Exceptionless等

创建接口记录的中间件

1. using Microliu.Core.Loggers;
2. using Microsoft.AspNetCore.Builder;
3. using Microsoft.AspNetCore.Http;
4. using Microsoft.AspNetCore.Http.Internal;
5. using Newtonsoft.Json;
6. using System;
7. using System.Collections.Generic;
8. using System.Diagnostics;
9. using System.IO;
10. using System.Linq;
11. using System.Text;
12. using System.Threading.Tasks;
13. namespace Ptibro.Partner.API.Extensions
14. {
15. public class RequestResponseLoggingMiddleware
16. {
17. private readonly RequestDelegate _next;
18. private readonly ILogger _logger;
19. private SortedDictionary<string, object> _data;
20. private Stopwatch _stopwatch;
21. public RequestResponseLoggingMiddleware(RequestDelegate next, ILogger logger)
22. {
23. _next = next;
24. _logger = logger;
25. _stopwatch = new Stopwatch();
26. }
27. public async Task Invoke(HttpContext context)
28. {
29. _stopwatch.Restart();
30. _data = new SortedDictionary<string, object>();
31. HttpRequest request = context.Request;
32. _data.Add("request.url", request.Path.ToString());
33. _data.Add("request.headers", request.Headers.ToDictionary(x => x.Key, v => string.Join(";", v.Value.ToList())));
34. _data.Add("request.method", request.Method);
35. _data.Add("request.executeStartTime", DateTimeOffset.Now.ToString("yyyy-MM-dd HH:mm:ss.fff"));
36. // 获取请求body内容
37. if (request.Method.ToLower().Equals("post"))
38. {
39. // 启用倒带功能，就可以让 Request.Body 可以再次读取
40. request.EnableRewind();
41. Stream stream = request.Body;
42. byte[] buffer = new byte[request.ContentLength.Value];
43. stream.Read(buffer, 0, buffer.Length);
44. _data.Add("request.body", Encoding.UTF8.GetString(buffer));
45. request.Body.Position = 0;
46. }
47. else if (request.Method.ToLower().Equals("get"))
48. {
49. _data.Add("request.body", request.QueryString.Value);
50. }
51. // 获取Response.Body内容
52. var originalBodyStream = context.Response.Body;
53. using (var responseBody = new MemoryStream())
54. {
55. context.Response.Body = responseBody;
56. await _next(context);
57. _data.Add("response.body", await GetResponse(context.Response));
58. _data.Add("response.executeEndTime", DateTimeOffset.Now.ToString("yyyy-MM-dd HH:mm:ss.fff"));
59. await responseBody.CopyToAsync(originalBodyStream);
60. }
61. // 响应完成记录时间和存入日志
62. context.Response.OnCompleted(() =>
63. {
64. _stopwatch.Stop();
65. _data.Add("elaspedTime", _stopwatch.ElapsedMilliseconds + "ms");
66. var json = JsonConvert.SerializeObject(_data);
67. _logger.Debug(json, "api", request.Method.ToUpper());
68. return Task.CompletedTask;
69. });
70. }
71. /// <summary>
72. /// 获取响应内容
73. /// </summary>
74. /// <param name="response"></param>
75. /// <returns></returns>
76. public async Task<string> GetResponse(HttpResponse response)
77. {
78. response.Body.Seek(0, SeekOrigin.Begin);
79. var text = await new StreamReader(response.Body).ReadToEndAsync();
80. response.Body.Seek(0, SeekOrigin.Begin);
81. return text;
82. }
83. }
84. /// <summary>
85. /// 扩展中间件
86. /// </summary>
87. public static class RequestResponseLoggingMiddlewareExtensions
88. {
89. public static IApplicationBuilder UseRequestResponseLogging(this IApplicationBuilder app)
90. {
91. return app.UseMiddleware<RequestResponseLoggingMiddleware>();
92. }
93. }
94. }

复制代码

在startup.cs中Configure方法中使用中间件

1. public void Configure(IApplicationBuilder app, IHostingEnvironment env)
2. {
3. if (env.IsDevelopment())
4. {
5. app.UseDeveloperExceptionPage();
6. }
7. app.UseErrorHandling();// 全局异常尽量放上面
8. ...
9. app.UseRequestResponseLogging();
10. ...
11. app.UseExceptionless(Configuration);
12. app.UseMvc();
13. }

复制代码

现在请求一次看一下记录的效果：我的日志存在exceptionless上，如下图

 解析json，记录的数据如下：

总结

以上所述是小编给大家介绍的.net core webapi通过中间件获取请求和响应内容的方法,希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对晓枫资讯网站的支持！
如果你觉得本文对你有帮助，欢迎转载，烦请注明出处，谢谢！

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

123460142

路过，支持一下

烟织成愁撼

感谢楼主，顶。

rteslr471259

顶顶更健康！！！