Asp.Net Core Filter 深入浅出的那些事-AOP

一、前言

在分享ASP.NET Core Filter 使用之前，先来谈谈 AOP,什么是AOP 呢？

AOP全称 AspectOrientedProgramming意为面向切面编程，也叫做面向方法编程，是通过预编译方式和运行期动态代理的方式实现不修改源代码的情况下给程序动态统一添加功能的技术。

AOP技术利用一种称为“横切”的技术，剖解开封装对象的内部，将影响多个类的公共行为封装到一个可重用的模块中，并将其命名为 Aspect切面。所谓的切面，简单来说就是与业务无关，却为业务模块所共同调用的逻辑，将其封装起来便于减少系统的重复代码，降低模块的耦合度，有利用未来的可操作性和可维护性。

利用AOP可以对业务逻辑各个部分进行隔离，从而使业务逻辑各部分之间的耦合度降低，提高程序的可重用性，同时提高开发效率。

AOP的使用场景主要包括日志记录、性能统计、安全控制、事务处理、异常处理等。

二、Filter-过滤器

Filter是延续ASP.NET MVC的产物，同样保留了五种的Filter，分别是Authorization Filter、Resource Filter、Action Filter、Exception Filter及Result Filter。 通过不同的Filter可以有效处理封包进出的加工，本篇将介绍ASP.NET Core的五种Filter运作方式。

2.1 Filter 介绍

ASP.NET Core 有以下五种Filter 可以使用：

• Authorization Filter： Authorization是五种Filter中优先级最高的，通常用于验证Request合不合法，不合法后面就直接跳过。
• Resource Filter：Resource是第二优先，会在Authorization之后，Model Binding之前执行。通常会是需要对Model加工处理才用。
• Exception Filter：异常处理的Filter。
• Action Filter：最常使用的Filter，封包进出都会经过它，使用上没什么需要特别注意的。跟Resource Filter很类似，但并不会经过Model Binding。
• Result Filter：当Action完成后，最终会经过的Filter。

三、五大Filter 的应用

这一篇章主要来讲解Asp.Net Core 的五大过滤器的实现及用途.

3.1 Authonization Filter

权限控制过滤器 通过 Authonization Filter 可以实现复杂的 权限角色认证、 登陆授权等操作 实现事例代码如下：

<code>public class AuthonizationFilter :Attribute,IAuthorizationFilter
{
   \t\t\t\tpublic void OnAuthorization(AuthorizationFilterContext context) 
  \t\t\t\t{
            \t\t\t//这里可以做复杂的权限控制操作 
            \t\t\tif (context.HttpContext.User.Identity.Name != "1") //简单的做一个示范
                  {
                    \t\t\t//未通过验证则跳转到无权限提示页 
                    \t\t\tRedirectToActionResult content = new RedirectToActionResult("NoAuth", "Exception", null); 
                    \t\t\tcontext.Result = content;  
                  }
          }
}/<code>

3.2 Resource Filter

资源过滤器 可以通过Resource Filter 进行 资源缓存、 防盗链等操作。 使用Resource Filter 要求实现IResourceFilter 抽象接口

<code>public class ResourceFilter : Attribute,IResourceFilter
{
  \t\t\tpublic void OnResourceExecuted(ResourceExecutedContext context)
  \t\t\t{
          \t\t\t\t// 执行完后的操作 
        }
  
  \t\t\tpublic void OnResourceExecuting(ResourceExecutingContext context)
  \t\t\t{
          \t\t\t\t// 执行中的过滤器管道
        }
}/<code>

3.3 Exception Filter

通过Execption Filter 过滤器可以进行全局的 异常日志收集 等操作。

使用Execption Filter 要求实现 IExceptionFilter 抽象接口 IExceptionFilter接口会要求实现 OnException方法，当系统发生未捕获异常时就会触发这个方法。 OnException方法有一个 ExceptionContext异常上下文，其中包含了具体的异常信息，HttpContext及mvc路由信息。系统一旦出现未捕获异常后，比较常见的做法就是使用日志工具，将异常的详细信息记录下来，方便修正调试。下面是日志记录的实现。　　

<code>public class ExecptionFilter : Attribute, IExceptionFilter  
{
  \t\t\t\tprivate ILogger<execptionfilter> _logger; 
  \t\t\t\t//构造注入日志组件
  \t\t\t\tpublic ExecptionFilter(ILogger<execptionfilter> logger) 
  \t\t\t\t{
            \t\t\t_logger = logger; 
          }
  \t\t\t\t
  \t\t\t\tpublic void OnException(ExceptionContext context) 
  \t\t\t\t{
            \t\t\t//日志收集
            \t\t\t_logger.LogError(context.Exception, context?.Exception?.Message??"异常"); 
          }
}/<execptionfilter>/<execptionfilter>/<code>

3.4 Action Filter

作用：可以通过ActionFilter 拦截 每个执行的方法进行一系列的操作，比如： 执行操作日志、 参数验证， 权限控制 等一系列操作。

使用Action Filter 需要实现IActionFilter 抽象接口， IActionFilter 接口要求实现 OnActionExecuted 和 OnActionExecuting 方法

<code>public class ActionFilter : Attribute, IActionFilter
{
  \t\t\t\tpublic void OnActionExecuted(ActionExecutedContext context)
  \t\t\t\t{ 

            \t\t\t\t//执行完成....
          }
  
  \t\t\t\tpublic void OnActionExecuting(ActionExecutingContext context)
  \t\t\t\t{
            \t\t\t\t//执行中...
          }
}/<code>

3.5 Result Filter

结果过滤器，可以对结果进行格式化、大小写转换等一系列操作。

使用Result Filter 需要实现IResultFilter 抽象接口，接口要求实现 OnResultExecuting 方法 和 OnResultExecuted 方法

• OnResultExecuting ：Called before the action result executes. 在操作结果执行之前调用
• OnResultExecuted ：Called after the action result executes. 在操作结果执行之后调用

具体代码实现代码如下：

<code>public class ResultFilter : Attribute, IResultFilter 
{
  \t\t\t\tpublic void OnResultExecuted(ResultExecutedContext context)
  \t\t\t\t{
            \t\t\t// 在结果执行之后调用的操作... 
          }
  \t\t\t
  \t\t\t\tpublic void OnResultExecuting(ResultExecutingContext context) 
  \t\t\t\t{
            \t\t\t// 在结果执行之前调用的一系列操作
          }
}/<code>

四、Asp.Net Core 过滤器的注册方式

这一篇章主要来分析探讨Asp.Net Core 中 过滤器的三种注册方式 Action、 Controller、 全局 。

4.1 Action 注册方式

Action 注册方式是局部注册方式，针对控制器中的某个方法上标注特性的方式进行注册，代码如下：

<code> [AuthonizationFilter()]
public IActionResult Index()
{
   \treturn View(); 
}/<code>

4.2 Controller 注册方式

了解过Action 特性注册方式的同学，一定发现了它的不好之处就是我一个控制器里面需要使用同一套Filter 的时候，需要一个一个Action 标注特性注册，是不是很繁琐呢？有没有其他方式进行代替这些繁琐的操作呢？微软给我们提供了简便的控制器标注注册方式，代码如下：

<code> [AuthonizationFilter()] public class FirstController : Controller
 {
   \t\t\t\t\tprivate ILogger<firstcontroller> _logger;
   \t\t\t\t\tpublic FirstController(ILogger<firstcontroller> logger)
   \t\t\t\t\t{
              \t\t\t\t_logger = logger;
            }
   
   \t\t\t\t\tpublic IActionResult Index() 
   \t\t\t\t\t{
              \t\t\t\treturn View();
            }
 }/<firstcontroller>/<firstcontroller>/<code>

4.3 全局注册方式

现在有些同学考虑了一些全局的情况，比如我要全局处理系统中的异常，或者收集操作日志等，需要全局注册一个 ExceptionFilter 来实现，就不需要每一个Controller 中进行代码注册，方便快捷。代码如下：

<code>public void ConfigureServices(IServiceCollection services) 
{
  \t\t\t\t//全局注册异常过滤器
  \t\t\t\tservices.AddControllersWithViews(option=>
           {
            \t\t\t\toption.Filters.Add<execptionfilter>();
          });
  \t\t\t
  \t\t\t\tservices.AddSingleton<isingletonservice>();
}/<isingletonservice>/<execptionfilter>/<code>

4.4 TypeFilter 和 ServiceFilter 注册方式

上面的五大过滤器中事例代码中其中有一个过滤器的代码比较特，再来回顾 ExceptionFilter过滤器的实现代码：

<code>    class ExecptionFilter : Attribute, IExceptionFilter    {        private ILogger<execptionfilter> _logger;        //构造注入日志组件        public ExecptionFilter(ILogger<execptionfilter> logger)        {            _logger = logger;        }        public void OnException(ExceptionContext context)        {            //日志收集            _logger.LogError(context.Exception, context?.Exception?.Message??"异常");        }    }/<execptionfilter>/<execptionfilter>/<code>

从上面的代码中可以发现 ExceptionFilter 过滤器实现中存在日志服务的构造函数的注入，也就是说该过滤器依赖于其他的日志服务，但是日志服务都是通过DI 注入进来的；再来回顾下上面Action 注册方式或者Controller 注册方式 也即 Attribute 特性标注注册方式，本身基础的特性是不支持构造函数的，是在运行时注册进来的，那要解决这种本身需要对服务依赖的过滤器需要使用 TypeFilter 或者 ServiceFilter 方式进行过滤器的标注注册。

TypeFilter 和 ServiceFilter 的区别。

• ServiceFilter和TypeFilter都实现了IFilterFactory
• ServiceFilter需要对自定义的Filter进行注册，TypeFilter不需要
• ServiceFilter的Filter生命周期源自于您如何注册，而TypeFilter每次都会创建一个新的实例

TypeFilter 使用方式

代码如下：

<code>[TypeFilter(typeof(ExecptionFilter))]
public IActionFilter Index2()
{
  \t\t\treturn View();
}/<code>

通过上面的代码可以发现AuthonizationFilter 是默认的构造器，但是如果过滤器中构造函数中存在参数，需要注入服务那该怎么办呢?，比如上面的ExceptionFilter 代码，就不能使用这种方式进行注册，需要使用服务特性的方式，我们可以选择使用 代码如下：

<code>[TypeFilter(typeof(ExecptionFilter))]
public IActionFilter Index2()
{
  \t\t\treturn View();
}/<code>

ServiceFilter 使用方式

控制器中的代码如下：

<code>[ServiceFilter(typeof(ExecptionFilter))]
public IActionFilter Index2()
{
  \t\t\t\treturn View();
}/<code>

注册服务的代码如下：

<code>// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
  \t\t\t\tConsole.WriteLine("ConfigureServices");
  \t\t\t\tservices.AddControllersWithViews();
  \t\t\t\t//services.AddControllersWithViews(option=> {
  \t\t\t\t//    \t\t\toption.Filters.Add<execptionfilter>(); 
  \t\t\t\t//}); 
  \t\t\t\t//注册过滤器服务，使用ServiceFilter 方式必须要注册 
  \t\t\t\tservices.AddSingleton<execptionfilter>();
}/<execptionfilter>/<execptionfilter>/<code>

閱讀更多 dotNET博士 的文章

關鍵字: 日志 logger 过滤器