登录/ 注册
 找回密码
 立即注册
关闭

CSDN热搜

程序园 精品问答 技术交流 资源下载
返回列表 发新帖
首页 › 业界区 › 安全 ›ASP.NET Core中使用请求过滤器记录Http API日志 ...

ASP.NET Core中使用请求过滤器记录Http API日志

姘轻拎 6 天前
一、过滤器简介

ASP.NET Core中的过滤器是一种组件，它可以在请求处理管道中的特定阶段运行代码。过滤器有多种类型，包括授权过滤器、资源过滤器、动作过滤器、异常过滤器和结果过滤器。本文中使用的是动作过滤器（Action Filter），它在动作方法执行前后执行，可以用来记录请求和响应信息。
二、自定义GlobalActionFilter类

1. 类定义
  1. /// <summary>
  2. /// Action过滤器
  3. /// </summary>
  4. public class GlobalActionFilter : IActionFilter, IOrderedFilter
  5. {
  6.     /// <summary>
  7.     /// 构造
  8.     /// </summary>
  9.     /// <param name="logger"></param>
  10.     public GlobalActionFilter(SugarDbContext dbContext, ILogger<GlobalActionFilter> logger)
  11.     {
  12.         this.dbContext = dbContext;
  13.         this.logger = logger;
  14.     }
  16.     private readonly SugarDbContext dbContext;
  17.     private readonly ILogger<GlobalActionFilter> logger;
  19.     /// <summary>
  20.     /// 过滤器执行顺序
  21.     /// </summary>
  22.     public int Order => 2; // 设置执行顺序
  24.     private (string Method, string Path, string ClientIp) GetRequestInfo(HttpContext context)
  25.     {
  26.         string method = context.Request.Method;
  27.         string serverIp = context.Connection.LocalIpAddress.GetFormattedIpAddress();
  28.         string serverBaseUrl = $"http://{serverIp}:{context.Connection.LocalPort}";
  29.         string pathSmall = context.Request.Path.ToString();
  30.         string path = serverBaseUrl + pathSmall;
  31.         string clientIp = context.Connection.RemoteIpAddress.GetFormattedIpAddress();
  32.         return (method, path, clientIp);
  33.     }
  35.     private string GetInParam(ActionExecutingContext context)
  36.     {
  37.         return context.ActionArguments.Values.FirstOrDefault()?.ToJson() ?? "Null";
  38.     }
  40.     private string GetOutParam(ActionExecutedContext context)
  41.     {
  42.         JsonResult? response = context.Result as JsonResult;
  43.         return response?.Value != null ? JsonConvert.SerializeObject(response.Value) : "";
  44.     }
  46.     private EmResponseStaus GetResponseStatus(string pathSmall, string outParam)
  47.     {
  48.         if (string.IsNullOrWhiteSpace(outParam))
  49.         {
  50.             return EmResponseStaus.ReqNull;
  51.         }
  53.         try
  54.         {
  55.             //如果是TesTaskNotice接口,则使用TesResponse因为它的返回值和ApiResponse不一样
  56.             if (pathSmall.Contains("TesTaskNotice"))
  57.             {
  58.                 var apiResponse = outParam.ToObject<TesResponse>();
  59.                 return apiResponse?.ReturnCode == 0 ? EmResponseStaus.Success : EmResponseStaus.Fail;
  60.             }
  61.             else
  62.             {
  63.                 var apiResponse = outParam.ToObject();
  64.                 return apiResponse?.Code == 0 ? EmResponseStaus.Success : EmResponseStaus.Fail;
  65.             }
  66.         }
  67.         catch (JsonException)
  68.         {
  69.             logger.LogError($"在记录http日志时,序列化返参失败,path:{pathSmall} | outParam:{outParam}");
  70.             return EmResponseStaus.Unknown;
  71.         }
  72.         catch (Exception ex)
  73.         {
  74.             logger.LogError($"在记录http日志时,序列化返参失败,走到了Catch中,msg:{ex.Message},path:{pathSmall} | outParam:{outParam}");
  75.             return EmResponseStaus.Unknown;
  76.         }
  77.     }
  79.     /// <summary>
  80.     /// 执行Action之前
  81.     /// </summary>
  82.     /// <param name="context"></param>
  83.     public void OnActionExecuting(ActionExecutingContext context)
  84.     {
  85.         SkipActionFilterAttribute? skipActionFilterAttribute = context.ActionDescriptor.EndpointMetadata.OfType<SkipActionFilterAttribute>().FirstOrDefault();
  86.         // 判断是否存在 SkipActionFilterAttribute 特性
  87.         bool hasSkipActionFilter = skipActionFilterAttribute != null;
  88.         var (method, path, clientIp) = GetRequestInfo(context.HttpContext);
  89.         if (method == "GET" || path.Contains("Test") || hasSkipActionFilter) return; // 忽略GET请求和测试控制器
  91.         string inParam = GetInParam(context);
  92.         //当前请求的唯一ID
  93.         string requestId = context.HttpContext.TraceIdentifier;
  95.         HttpApiLogEntity httpApiLogEntity = new HttpApiLogEntity()
  96.         {
  97.             Method = Tool.ToMethodEnum(method),
  98.             Url = path,
  99.             IPAddress = clientIp,
  100.             InParam = inParam,
  101.             OutParam = "",
  102.             ResponseStaus = EmResponseStaus.Unknown,
  103.             IsIncomingRequest = true,
  104.             SystemType = EmSystemType.WCS,
  105.             RequestId = requestId,
  106.             CreateTime = DateTime.Now,
  107.         };
  109.         dbContext.HttpApiLogEntity.Insert(httpApiLogEntity);
  111.         if (!context.ModelState.IsValid)//如果在进入Action之前 就已经判断到入参有误 则直接返回不进入Action
  112.         {
  113.             List<string>? errors = context.ModelState.SelectMany(x => x.Value.Errors)
  114.                 .Select(x => x.ErrorMessage)
  115.                 .ToList();
  116.             ApiResponse? outParam = new ApiResponse
  117.             {
  118.                 Code = EmApiResCode.ReqError, //入参有误 返回2
  119.                 Msg = string.Join(',', errors),
  120.                 Data = false
  121.             };
  122.             logger.LogInformation(
  123.                 $"Method: {method}, Path: {path}, IP: {clientIp}, InParam: {inParam}, OutParam: {outParam.ToJson()}");
  125.             httpApiLogEntity.OutParam = outParam.ToJson();
  126.             httpApiLogEntity.ResponseStaus = outParam.Code == 0 ? EmResponseStaus.Success : EmResponseStaus.Fail;
  127.             httpApiLogEntity.EndTime = DateTime.Now;
  128.             dbContext.HttpApiLogEntity.Update(httpApiLogEntity);
  130.             context.Result = new JsonResult(outParam);
  131.         }
  132.     }
  134.     /// <summary>
  135.     /// 执行Action之后
  136.     /// </summary>
  137.     /// <param name="context"></param>
  138.     public void OnActionExecuted(ActionExecutedContext context)
  139.     {
  140.         SkipActionFilterAttribute? skipActionFilterAttribute = context.ActionDescriptor.EndpointMetadata.OfType<SkipActionFilterAttribute>()
  141.             .FirstOrDefault();
  142.         // 判断是否存在 SkipActionFilterAttribute 特性
  143.         bool hasSkipActionFilter = skipActionFilterAttribute != null;
  144.         var (method, path, clientIp) = GetRequestInfo(context.HttpContext);
  145.         string pathSmall = context.HttpContext.Request.Path.ToString();
  146.         if (method == "GET" || pathSmall.Contains("Test") || hasSkipActionFilter) return; // 忽略GET请求和测试控制器
  148.         string requestId = context.HttpContext.TraceIdentifier;
  149.         HttpApiLogEntity? httpApiLogEntity = dbContext.HttpApiLogEntity.GetFirst(x => x.RequestId == requestId);
  151.         if (httpApiLogEntity != null)
  152.         {
  153.             string outParam = GetOutParam(context);
  154.             httpApiLogEntity.OutParam = outParam;
  155.             httpApiLogEntity.ResponseStaus = GetResponseStatus(pathSmall, outParam);
  156.             httpApiLogEntity.EndTime = DateTime.Now;
  158.             dbContext.HttpApiLogEntity.Update(httpApiLogEntity);
  159.         }
  160.     }
  161. }
复制代码
该类实现了IActionFilter接口，该接口定义了OnActionExecuting和OnActionExecuted方法，分别在动作方法执行前和执行后调用。同时实现了IOrderedFilter接口，用于指定过滤器的执行顺序。
2. 构造函数
  1. /// <summary>
  2. /// 构造
  3. /// </summary>
  4. /// <param name="logger"></param>
  5. public GlobalActionFilter(SugarDbContext dbContext, ILogger<GlobalActionFilter> logger)
  6. {
  7.     this.dbContext = dbContext;
  8.     this.logger = logger;
  9. }
  11. private readonly SugarDbContext dbContext;
  12. private readonly ILogger<GlobalActionFilter> logger;
复制代码
构造函数接收数据库上下文对象SugarDbContext和日志记录器ILogger，用于后续的数据库操作和日志记录。
3. 执行顺序
  1. /// <summary>
  2. /// 过滤器执行顺序
  3. /// </summary>
  4. public int Order => 2; // 设置执行顺序
复制代码
通过实现IOrderedFilter接口的Order属性，指定该过滤器的执行顺序为2。数值越小，过滤器越先执行。
4. 获取请求信息
  1. private (string Method, string Path, string ClientIp) GetRequestInfo(HttpContext context)
  2. {
  3.     string method = context.Request.Method;
  4.     string serverIp = context.Connection.LocalIpAddress.GetFormattedIpAddress();
  5.     string serverBaseUrl = $"http://{serverIp}:{context.Connection.LocalPort}";
  6.     string pathSmall = context.Request.Path.ToString();
  7.     string path = serverBaseUrl + pathSmall;
  8.     string clientIp = context.Connection.RemoteIpAddress.GetFormattedIpAddress();
  9.     return (method, path, clientIp);
  10. }
复制代码
该方法从HttpContext中提取请求方法、完整请求路径和客户端IP地址，并以元组形式返回。
5. 获取输入参数
  1. private string GetInParam(ActionExecutingContext context)
  2. {
  3.     return context.ActionArguments.Values.FirstOrDefault()?.ToJson() ?? "Null";
  4. }
复制代码
从ActionExecutingContext的ActionArguments中获取动作方法的输入参数，并序列化为JSON字符串。如果没有参数，则返回"Null"。
6. 获取输出参数
  1. private string GetOutParam(ActionExecutedContext context)
  2. {
  3.     JsonResult? response = context.Result as JsonResult;
  4.     return response?.Value != null ? JsonConvert.SerializeObject(response.Value) : "";
  5. }
复制代码
从ActionExecutedContext的Result中获取动作方法的返回结果，如果是JsonResult类型，则将其值序列化为JSON字符串返回。
7. 获取响应状态
  1. private EmResponseStaus GetResponseStatus(string pathSmall, string outParam)
  2. {
  3.     if (string.IsNullOrWhiteSpace(outParam))
  4.     {
  5.         return EmResponseStaus.ReqNull;
  6.     }
  8.     try
  9.     {
  10.         //如果是TesTaskNotice接口,则使用TesResponse因为它的返回值和ApiResponse不一样
  11.         if (pathSmall.Contains("TesTaskNotice"))
  12.         {
  13.             var apiResponse = outParam.ToObject<TesResponse>();
  14.             return apiResponse?.ReturnCode == 0 ? EmResponseStaus.Success : EmResponseStaus.Fail;
  15.         }
  16.         else
  17.         {
  18.             var apiResponse = outParam.ToObject();
  19.             return apiResponse?.Code == 0 ? EmResponseStaus.Success : EmResponseStaus.Fail;
  20.         }
  21.     }
  22.     catch (JsonException)
  23.     {
  24.         logger.LogError($"在记录http日志时,序列化返参失败,path:{pathSmall} | outParam:{outParam}");
  25.         return EmResponseStaus.Unknown;
  26.     }
  27.     catch (Exception ex)
  28.     {
  29.         logger.LogError($"在记录http日志时,序列化返参失败,走到了Catch中,msg:{ex.Message},path:{pathSmall} | outParam:{outParam}");
  30.         return EmResponseStaus.Unknown;
  31.     }
  32. }
复制代码
根据响应结果和请求路径判断响应状态。如果是特定接口TesTaskNotice，则根据TesResponse的ReturnCode判断；否则根据ApiResponse的Code判断。如果序列化失败，则记录错误日志并返回未知状态。
8. 动作执行前
  1. /// <summary>
  2. /// 执行Action之前
  3. /// </summary>
  4. /// <param name="context"></param>
  5. public void OnActionExecuting(ActionExecutingContext context)
  6. {
  7.     SkipActionFilterAttribute? skipActionFilterAttribute = context.ActionDescriptor.EndpointMetadata.OfType<SkipActionFilterAttribute>().FirstOrDefault();
  8.     // 判断是否存在 SkipActionFilterAttribute 特性
  9.     bool hasSkipActionFilter = skipActionFilterAttribute != null;
  10.     var (method, path, clientIp) = GetRequestInfo(context.HttpContext);
  11.     if (method == "GET" || path.Contains("Test") || hasSkipActionFilter) return; // 忽略GET请求和测试控制器
  13.     string inParam = GetInParam(context);
  14.     //当前请求的唯一ID
  15.     string requestId = context.HttpContext.TraceIdentifier;
  17.     HttpApiLogEntity httpApiLogEntity = new HttpApiLogEntity()
  18.     {
  19.         Method = Tool.ToMethodEnum(method),
  20.         Url = path,
  21.         IPAddress = clientIp,
  22.         InParam = inParam,
  23.         OutParam = "",
  24.         ResponseStaus = EmResponseStaus.Unknown,
  25.         IsIncomingRequest = true,
  26.         SystemType = EmSystemType.WCS,
  27.         RequestId = requestId,
  28.         CreateTime = DateTime.Now,
  29.     };
  31.     dbContext.HttpApiLogEntity.Insert(httpApiLogEntity);
  33.     if (!context.ModelState.IsValid)//如果在进入Action之前 就已经判断到入参有误 则直接返回不进入Action
  34.     {
  35.         List<string>? errors = context.ModelState.SelectMany(x => x.Value.Errors)
  36.            .Select(x => x.ErrorMessage)
  37.            .ToList();
  38.         ApiResponse? outParam = new ApiResponse
  39.         {
  40.             Code = EmApiResCode.ReqError, //入参有误 返回2
  41.             Msg = string.Join(',', errors),
  42.             Data = false
  43.         };
  44.         logger.LogInformation(
  45.             $"Method: {method}, Path: {path}, IP: {clientIp}, InParam: {inParam}, OutParam: {outParam.ToJson()}");
  47.         httpApiLogEntity.OutParam = outParam.ToJson();
  48.         httpApiLogEntity.ResponseStaus = outParam.Code == 0 ? EmResponseStaus.Success : EmResponseStaus.Fail;
  49.         httpApiLogEntity.EndTime = DateTime.Now;
  50.         dbContext.HttpApiLogEntity.Update(httpApiLogEntity);
  52.         context.Result = new JsonResult(outParam);
  53.     }
  54. }
复制代码
在动作方法执行前，首先判断是否应跳过该过滤器（例如GET请求、测试控制器或标记了SkipActionFilterAttribute特性的方法）。然后获取请求信息和输入参数，创建HttpApiLogEntity对象并插入数据库。如果模型状态无效（入参有误），则构造错误响应，更新日志记录并返回错误响应。
9. 动作执行后
  1. /// <summary>
  2. /// 执行Action之后
  3. /// </summary>
  4. /// <param name="context"></param>
  5. public void OnActionExecuted(ActionExecutedContext context)
  6. {
  7.     SkipActionFilterAttribute? skipActionFilterAttribute = context.ActionDescriptor.EndpointMetadata.OfType<SkipActionFilterAttribute>()
  8.        .FirstOrDefault();
  9.     // 判断是否存在 SkipActionFilterAttribute 特性
  10.     bool hasSkipActionFilter = skipActionFilterAttribute != null;
  11.     var (method, path, clientIp) = GetRequestInfo(context.HttpContext);
  12.     string pathSmall = context.HttpContext.Request.Path.ToString();
  13.     if (method == "GET" || pathSmall.Contains("Test") || hasSkipActionFilter) return; // 忽略GET请求和测试控制器
  15.     string requestId = context.HttpContext.TraceIdentifier;
  16.     HttpApiLogEntity? httpApiLogEntity = dbContext.HttpApiLogEntity.GetFirst(x => x.RequestId == requestId);
  18.     if (httpApiLogEntity != null)
  19.     {
  20.         string outParam = GetOutParam(context);
  21.         httpApiLogEntity.OutParam = outParam;
  22.         httpApiLogEntity.ResponseStaus = GetResponseStatus(pathSmall, outParam);
  23.         httpApiLogEntity.EndTime = DateTime.Now;
  25.         dbContext.HttpApiLogEntity.Update(httpApiLogEntity);
  26.     }
  27. }
复制代码
在动作方法执行后，同样判断是否应跳过该过滤器。然后根据请求ID从数据库中获取之前插入的日志记录，获取输出参数和响应状态，更新日志记录的输出参数、响应状态和结束时间。
三、使用过滤器

1. 注册过滤器

在Startup.cs文件的ConfigureServices方法中注册过滤器：
  1. public void ConfigureServices(IServiceCollection services)
  2. {
  3.     // 其他服务注册...
  4.     services.AddControllers(options =>
  5.     {
  6.         options.Filters.Add<GlobalActionFilter>();
  7.     });
  8. }
复制代码
这样，该过滤器将应用于所有控制器的动作方法。如果只希望应用于特定控制器或动作方法，可以在控制器类或动作方法上添加[TypeFilter(typeof(GlobalActionFilter))]特性。
2. 示例

假设我们有一个简单的控制器：
  1. using Microsoft.AspNetCore.Mvc;
  3. namespace Project.Controllers
  4. {
  5.     [Route("api/[controller]")]
  6.     [ApiController]
  7.     public class WeatherForecastController : ControllerBase
  8.     {
  9.         [HttpPost]
  10.         public IActionResult Post([FromBody] WeatherForecast forecast)
  11.         {
  12.             // 处理逻辑...
  13.             return Ok(new { Message = "Success" });
  14.         }
  15.     }
  16. }
复制代码
当发送POST请求到该控制器的Post方法时，GlobalActionFilter将记录请求和响应信息到数据库中。
四、总结

通过自定义动作过滤器，我们可以方便地在ASP.NET Core应用中记录Http API日志。这不仅有助于系统的调试和维护，还能提供有价值的运行时信息。在实际应用中，可以根据具体需求对过滤器进行扩展和优化，例如添加更多的日志字段、支持不同的日志存储方式等。
希望本文能帮助你理解和使用ASP.NET Core中的请求过滤器来记录API日志。如果有任何问题或建议，欢迎留言讨论。

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

使用道具 举报
相关推荐
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 | 立即注册
发帖
姘轻拎
6 天前

0

粉丝关注

7

主题发布

板块介绍填写区域，请于后台编辑
微信扫一扫