.net core使用Filter过滤器拦截webapi方法示例(附代码)

时间：2021-06-02 15:55:40 收藏：0 阅读：0

Filter的基本用法

代码在最下方

使用filter过滤器，来实现拦截接口信息。咱们先新建一个项目，在原有的webapi上面，选择添加项目，添加一个类库项目：

技术图片

我起个名字，就叫 Wsk.Core.Filter:

技术图片

然后，我们把自带的控制器删除掉，咱们手撸一个。以下是要删掉的部分：

技术图片

然后新建一个api控制器，例如叫 WSKController

技术图片

然后，新建一个webapi方法，例如HelloWorld：

技术图片

然后，我们来做个打印输出到日志，切换回我们的Wsk.Core.Filter上面，删除默认的Class1,然后新增一个类，就叫HelloFilter,它需要继承于ActionFilterAttribute 不存在需要先手动引用有关的包：Microsoft.AspNetCore.Mvc

技术图片

接下来，好戏开始了，直接上代码：

技术图片

重写4个方法，具体作用，如图上注释。我们现在只做简单验证，验证进接口之前、以及执行接口完毕，都会发生什么。我们给他们打印点东西。先在webapi方法里面写个打印的内容：

技术图片

然后，在OnActionExecuting方法里面写点接收前的打印内容：

技术图片

在 OnResultExecuted方法写点webapi方法执行完毕返回时候的打印内容：

技术图片

然后，在接口项目里面，引用该类库项目：

技术图片

在属性上方添加 [HelloFilter]实现切面拦截：

技术图片

接下来准备duang一下见证奇迹，运行程序，走一个：

技术图片

如图，奇迹见证完毕。

拦截器内部代码如下：

public class HelloFilter: ActionFilterAttribute
    {

        /// <summary>
        /// Action方法调用之前执行
        /// </summary>
        /// <param name="context"></param>
        public override void OnActionExecuting(ActionExecutingContext context) {
            var descriptor = context.ActionDescriptor as ControllerActionDescriptor;

            string param = string.Empty;
            string globalParam = string.Empty;

            foreach (var arg in context.ActionArguments)
            {
                string value = Newtonsoft.Json.JsonConvert.SerializeObject(arg.Value);
                param += $"{arg.Key} : {value} \r\n";
                globalParam += value;
            }
            Console.WriteLine($"webapi方法名称:【{descriptor.ActionName}】接收到参数为：{param}");
        }
        /// <summary>
        /// Action 方法调用后，Result 方法调用前执行
        /// </summary>
        /// <param name="context"></param>
        public override void OnActionExecuted(ActionExecutedContext context) { }
        /// <summary>
        /// Result 方法调用前执行
        /// </summary>
        /// <param name="context"></param>
        public override void OnResultExecuting(ResultExecutingContext context) {  }
        /// <summary>
        /// Result 方法调用后执行
        /// </summary>
        /// <param name="context"></param>
        public override void OnResultExecuted(ResultExecutedContext context)  {
            var descriptor = context.ActionDescriptor as ControllerActionDescriptor;
           
            string result = string.Empty;
            if (context.Result is ObjectResult)
            {
                result = Newtonsoft.Json.JsonConvert.SerializeObject(((ObjectResult)context.Result).Value);
            }

            Console.WriteLine($"webapi方法名称【{descriptor.ActionName}】执行的返回值 :  {result}");
        }
    }

最后，见证奇迹了的大大们，欢迎各位大大们打赏呀！！！

技术图片