Util应用框架基础（二）- 面向切面编程(AOP)

面向切面编程(AOP)

Util应用框架横切关注点处理

本节介绍Util应用框架对横切关注点的处理.

文章分为多个小节,如果对设计原理不感兴趣,只需阅读基础用法部分即可.

概述

有些问题需要在系统中全局处理,比如记录异常错误日志.

如果在每个出现问题的地方进行处理,不仅费力,还可能产生大量冗余代码,并打断业务逻辑的编写.

这类跨多个业务模块的非功能需求,被称为横切关注点.

我们需要把横切关注点集中管理起来.

Asp.Net Core 提供的过滤器可以处理这类需求.

过滤器有异常过滤器和操作过滤器等类型.

异常过滤器可以全局处理异常.

操作过滤器可以拦截控制器操作,在操作前和操作后执行特定代码.

过滤器很易用,但它必须配合控制器使用,所以只能解决部分问题.

你不能将过滤器特性打在应用服务的方法上,那不会产生作用.

我们需要引入一种类似 Asp.Net Core 过滤器的机制,在控制器范围外处理横切关注点.

AOP框架

AOP 是 Aspect Oriented Programming 的缩写,即面向切面编程.

AOP 框架提供了类似 Asp.Net Core 过滤器的功能,能够拦截方法,在方法执行前后插入自定义代码.

.Net AOP框架有动态代理和静态织入两种实现方式.

动态代理 AOP 框架

动态代理 AOP 框架在运行时动态创建代理类,从而为方法提供自定义代码插入点.

动态代理 AOP 框架有一些限制.

• 要拦截的方法必须在接口中定义,或是虚方法.

• 代理类过多,特别是启用了参数拦截,会导致启动性能下降.

.Net 动态代理 AOP 框架有Castle 和 AspectCore 等.

Util应用框架使用 AspectCore ,选择 AspectCore 是因为它更加易用.

Util 对 AspectCore 仅简单包装.

静态织入 AOP 框架

静态织入 AOP 框架在编译时修改.Net IL中间代码.

与动态代理AOP相比,静态织入AOP框架有一些优势.

• 不必是虚方法.

• 支持静态方法.

• 更高的启动性能.

但是成熟的 .Net 静态织入 AOP 框架大多是收费的.

Rougamo.Fody 是一个免费的静态织入 AOP 框架,可以关注.

基础用法

引用Nuget包

Nuget包名: Util.Aop.AspectCore

通常不需要手工引用它.

启用Aop

需要明确调用 AddAop 扩展方法启用 AOP 服务.

var builder = WebApplication.CreateBuilder( args );
builder.AsBuild().AddAop();

使用要点

• 定义服务接口

  如果使用抽象基类,应将需要拦截的方法设置为虚方法.

• 配置服务接口的依赖注入关系

  AspectCore AOP依赖Ioc对象容器,只有在对象容器中注册的服务接口才能创建服务代理.

• 将方法拦截器放在接口方法上.

  AspectCore AOP拦截器是一种.Net特性 Attribute,遵循 Attribute 使用约定.

  下面的例子将 CacheAttribute 方法拦截器添加到 ITestService 接口的 Test 方法上.

  注意: 应将拦截器放在接口方法上,而不是实现类上.

  按照约定, CacheAttribute 需要去掉 Attribute 后缀,并放到 [] 中.

  public interface ITestService : ISingletonDependency {        
      [Cache]
      List<string> Test( string value );
  }
  

• 将参数拦截器放在接口方法参数上.

  AspectCore AOP 支持拦截特定参数.

  下面的例子在参数 value 上施加了 NotNullAttribute 参数拦截器.

    public interface ITestService : ISingletonDependency {
        void Test( [NotNull] string value );
    }
  

Util内置拦截器

Util应用框架使用 Asp.Net Core 过滤器处理全局异常,全局错误日志,授权等需求,仅定义少量 AOP 拦截器.

Util应用框架定义了几个参数拦截器,用于验证.

• NotNullAttribute

  • 验证是否为 null,如果为 null 抛出 ArgumentNullException 异常.

  • 使用范例: