【C#】WebApi 添加过滤器，实现对请求参数和响应内容的日志记录

2021-04-13 08:33

阅读：355

filter的介绍

filter在Web API中经常会用到，主要用于记录日志，安全验证，全局错误处理等；Web API提供两种过滤器的基本类型：actionfilterattribute，exceptionfilterattribute；两个类都是抽象类，actionfilter主要实现执行请求方法体之前（覆盖基类方法OnActionExecuting），和之后的事件处理（覆盖基类方法OnActionExecuted）；exceptionfilter主要实现触发异常方法（覆盖基类方法OnException）。下面对前者类型做示例。

新建ActionFilter类

打印参数、返回值、以及接口响应时间：

 public class ActionFilter : ActionFilterAttribute
    {
        private const string Key = "action";
        private bool _IsDebugLog = true;
        public override void OnActionExecuting(HttpActionContext actionContext)
        {
            if (_IsDebugLog)
            {
                Stopwatch stopWatch = new Stopwatch();

                actionContext.Request.Properties[Key] = stopWatch;

                string actionName = actionContext.ActionDescriptor.ActionName;

                Debug.Print(Newtonsoft.Json.JsonConvert.SerializeObject(actionContext.ActionArguments));

                stopWatch.Start();
            }

        }
        public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
        {
            if (_IsDebugLog)
            {
                Stopwatch stopWatch = actionExecutedContext.Request.Properties[Key] as Stopwatch;

                if (stopWatch != null)
                {

                    stopWatch.Stop();

                    string actionName = actionExecutedContext.ActionContext.ActionDescriptor.ActionName;

                    string controllerName = actionExecutedContext.ActionContext.ActionDescriptor.ControllerDescriptor.ControllerName;

                    Debug.Print(actionExecutedContext.Response.Content.ReadAsStringAsync().Result);

                    Debug.Print(string.Format(@"[{0}/{1} 用时 {2}ms]", controllerName, actionName, stopWatch.Elapsed.TotalMilliseconds));
                }
            }
        }

    }