Spring-03-AOP配置

1. 简介

• AspectJ：Java 社区里最完整最流行的 AOP 框架.
• 在 Spring2.0 以上版本中, 可以使用基于 AspectJ 注解或基于 XML 配置的 AOP
• AOP(Aspect-Oriented Programming, 面向切面编程): 是一种新的方法论, 是对传统 OOP(Object-Oriented Programming, 面向对象编程) 的补充.
• AOP 的主要编程对象是切面(aspect), 而切面是模块化横切关注点.
• 在应用 AOP 编程时, 仍然需要定义公共功能, 但可以明确的定义这个功能在哪里, 以什么方式应用, 并且不必修改受影响的类. 这样一来横切关注点就被模块化到特殊的对象(切面)里.
• AOP 的好处:
  –> 每个事物逻辑位于一个位置, 代码不分散, 便于维护和升级
  –> 业务模块更简洁, 只包含核心业务代码.

2. AOP术语

• 切面(Aspect): 横切关注点(跨越应用程序多个模块的功能)被模块化的特殊对象，比如添加事务通知，自定义Log等等。
• 通知(Advice): 切面必须要完成的工作，比如设置前置通知（before），后置通知（after）等等。
• 目标(Target): 被通知的对象
• 代理(Proxy): 向目标对象应用通知之后创建的对象
• 连接点（Joinpoint）：程序执行的某个特定位置，如类某个方法调用前、调用后、方法抛出异常后等。连接点由两个信息确定：方法表示的程序执行点；相对点表示的方位。例如 ArithmethicCalculator#add() 方法执行前的连接点，执行点为 ArithmethicCalculator#add()； 方位为该方法执行前的位置。通俗点讲就是切入点的某个点（方法）。
• 切点（pointcut）：每个类都拥有多个连接点，例如 ArithmethicCalculator 的所有方法实际上都是连接点，即连接点是程序类中客观存在的事物。AOP 通过切点定位到特定的连接点。类比：连接点相当于数据库中的记录，切点相当于查询条件。切点和连接点不是一对一的关系，一个切点匹配多个连接点，切点通过 org.springframework.aop.Pointcut 接口进行描述，它使用类和方法作为连接点的查询条件。切入点通常与一个表达式相关联，并在满足这个切入点的连接点上运行。

3. 在 Spring 中启用 AspectJ 注解支持

• 要在 Spring 应用中使用 AspectJ 注解, 必须在 classpath 下包含 AspectJ 类库: aopalliance.jar、aspectj.weaver.jar 和 spring-aspects.jar
• 将 aop Schema 添加到<beans> 根元素中.
• 要在 Spring IOC 容器中启用 AspectJ 注解支持, 只要在 Bean 配置文件中定义一个空的 XML 元素 <aop:aspectj-autoproxy>
• 当 Spring IOC 容器侦测到 Bean 配置文件中的 <aop:aspectj-autoproxy> 元素时, 会自动为与 AspectJ 切面匹配的 Bean 创建代理.

4. 用 AspectJ 注解声明切面

• 要在 Spring 中声明 AspectJ 切面, 只需要在 IOC 容器中将切面声明为 Bean 实例. 当在 Spring IOC 容器中初始化 AspectJ 切面之后, Spring IOC 容器就会为那些与 AspectJ 切面相匹配的 Bean 创建代理.
• 在 AspectJ 注解中, 切面只是一个带有 @Aspect 注解的 Java 类.
• 通知是标注有某种注解的简单的 Java 方法.
• AspectJ 支持 5 种类型的通知注解:
  – @Before: 前置通知, 在方法执行之前执行
  – @After: 后置通知, 在方法执行之后执行
  – @AfterRunning: 返回通知, 在方法返回结果之后执行
  – @AfterThrowing: 异常通知, 在方法抛出异常之后
  – @Around: 环绕通知, 围绕着方法执行

比如我们要为一个Calculator类中的方法加入切面通知。

@Component("calculator") // 或者在配置文件中配置bean
public class Calculator {   
    public void add(int a,int b){
        System.out.println(a+b);
    }
}

<1> 前置通知 @Before

• 前置通知:在方法执行之前执行的通知
• 前置通知使用 @Before 注解, 并将切入点表达式的值作为注解值.

@Aspect
@Component
public class Aspect_log {

    @Before("execution(* ice.mimosa.d_inform.Calculator.add(..))")
    public void before_log(){
        System.out.println("Annotation Before.......");
    }

}

@Before标识这个方法是个前置通知, 切点表达式表示执行 Calculator
中的 add() 方法。* 代表匹配任意修饰符及任意返回值, 参数列表中的 ..表示匹配任意数量的参数。
此时从IOC容器获取Calculator 实例的时候，调用add方法，就会出发这个前置通知。

ApplicationContext applicationContext = new ClassPathXmlApplicationContext("bean-aspect.xml");

Calculator calculator = (Calculator) applicationContext.getBean("calculator");

calculator.add(1, 2);

输出为：

Annotation Before.......
3

<2> 利用方法签名编写 AspectJ 切入点表达式

• 最典型的切入点表达式是根据方法的签名来匹配各种方法:
  – execution * org.mimosa.spring.Calculator.(..): 匹配 Calculator 中声明的所有方法,第一个 代表任意修饰符及任意返回值. 第二个 * 代表任意方法… 匹配任意数量的参数. 若目标类与接口与该切面在同一个包中, 可以省略包名.
  – execution public * Calculator.*(..): 匹配 Calculator 接口的所有公有方法.
  – execution public double Calculator.*(..): 匹配 Calculator 中返回 double 类型数值的方法
  – execution public double Calculator.*(double, ..): 匹配第一个参数为 double 类型的方法, .. 匹配任意数量任意类型的参数
  – execution public double Calculator.*(double, double): 匹配参数类型为 double, double 类型的方法.

• 在 AspectJ 中, 切入点表达式可以通过操作符 &&， ||， ! 结合起来.

比如：
execution(* ice.mimosa.d_inform.Calculator.add(..)) || execution(* ice.mimosa.d_inform.Calculator.sub(..))

• 可以在通知方法中声明一个类型为 JoinPoint 的参数. 然后就能访问链接细节. 如方法名称和参数值.

@Before("execution(* ice.mimosa.d_inform.Calculator.add(..))")
public void before_log(JoinPoint joinPoint){
     // 连接点名称
     joinPoint.getSignature().getName();
     // 获取参数列表
     joinPoint.getArgs();
     // .. 等等
}

<3> 后置通知 @After

• 后置通知是在连接点完成之后执行的, 即连接点返回结果或者抛出异常的时候, 下面的后置通知记录了方法的终止. 即无论是否有异常, 后置通知的方法都会被执行。
• 一个切面可以包括一个或者多个通知.

<4> 返回通知

• 无论连接点是正常返回还是抛出异常, 后置通知都会执行. 如果只想在连接点返回的时候记录日志, 应使用返回通知代替后置通知.
• 在返回通知中, 只要将 returning 属性添加到 @AfterReturning 注解中, 就可以访问连接点的返回值. 该属性的值即为用来传入返回值的参数名称.
• 必须在通知方法的签名中添加一个同名参数. 在运行时, Spring AOP 会通过这个参数传递返回值.
• 原始的切点表达式需要出现在 pointcut 属性中

Calculator类中加入方法

public int add_return(int a, int b) {
        return a + b;
}

通知配置：

@AfterReturning(pointcut="execution(* ice.mimosa.d_inform.Calculator.*(..))",returning="result")
public void afterReturn_log(JoinPoint joinPoint, Object result){
    System.out.println("返回值：" + result);
}
// 执行 calculator.add_return(1, 2); 输出：
// 返回值：3

<5> 异常通知

• 只在连接点抛出异常时才执行异常通知
• 将 throwing 属性添加到 @AfterThrowing 注解中, 也可以访问连接点抛出的异常. Throwable 是所有错误和异常类的超类. 所以在异常通知方法可以捕获到任何错误和异常.
• 如果只对某种特殊的异常类型感兴趣, 可以将参数声明为其他异常的参数类型. 然后通知就只在抛出这个类型及其子类的异常时才被执行.

<6> 环绕通知

• 环绕通知是所有通知类型中功能最为强大的, 能够全面地控制连接点. 甚至可以控制是否执行连接点.
• 对于环绕通知来说, 连接点的参数类型必须是 ProceedingJoinPoint . 它是 JoinPoint 的子接口, 允许控制何时执行, 是否执行连接点.
• 在环绕通知中需要明确调用 ProceedingJoinPoint 的 proceed() 方法来执行被代理的方法. 如果忘记这样做就会导致通知被执行了, 但目标方法没有被执行.
• 注意: 环绕通知的方法需要返回目标方法执行之后的结果, 即调用 joinPoint.proceed(); 的返回值, 否则会出现空指针异常

@Around("execution(* ice.mimosa.d_inform.Calculator.*(..))") 
public void around(ProceedingJoinPoint joinPoint) {          
    System.out.println("around beginning ...");              
    try{                                                     
        joinPoint.proceed(new Object[]{1,2});                
        System.out.println("around end ...");                
    }catch(Throwable e){                                     
        System.out.println("around exception ...");          
    }                                                        
}                                                            

<7> 指定切面的优先级

• 在同一个连接点上应用不止一个切面时, 除非明确指定, 否则它们的优先级是不确定的.
• 切面的优先级可以通过实现 Ordered 接口或利用 @Order 注解指定.
• 实现 Ordered 接口, getOrder() 方法的返回值越小, 优先级越高.
• 若使用 @Order 注解, 序号出现在注解中

@Aspect
@Order(0)
public class Aspect01{...}
------------------------------------------
@Aspect
@Order(1)
public class Aspect02{...}

<8> 重用切入点定义

• 在编写 AspectJ 切面时, 可以直接在通知注解中书写切入点表达式. 但同一个切点表达式可能会在多个通知中重复出现.
• 在 AspectJ 切面中, 可以通过 @Pointcut 注解将一个切入点声明成简单的方法. 切入点的方法体通常是空的, 因为将切入点定义与应用程序逻辑混在一起是不合理的.
• 切入点方法的访问控制符同时也控制着这个切入点的可见性. 如果切入点要在多个切面中共用, 最好将它们集中在一个公共的类中. 在这种情况下, 它们必须被声明为 public. 在引入这个切入点时, 必须将类名也包括在内. 如果类没有与这个切面放在同一个包中, 还必须包含包名.
• 其他通知可以通过方法名称引入该切入点.

@Pointcut("execution(* ice.mimosa.d_inform.Calculator.*(..))")
private void aspect_point(){
}

@Before("aspect_point()")
public void before_log(){
    System.out.println("Annotation Before.......");
}

5. 基于 XML —- 配置 AOP

• 当使用 XML 声明切面时, 需要在 根元素中导入 aop Schema
• 在 Bean 配置文件中, 所有的 Spring AOP 配置都必须定义在 <aop:config> 元素内部. 对于每个切面而言, 都要创建一个 <aop:aspect> 元素来为具体的切面实现引用后端 Bean 实例. 对于配置切点表示用 <aop:pointcut> 元素
• 切面 Bean 必须有一个标示符, 供<aop:aspect> 元素引用

<!-- 将切面声明成bean -- >
<bean id="logXmlAspectBean" class="ice.mimosa.d_inform.AspectXml_log"></bean>

• 切入点使用 <aop:pointcut> 元素声明
• 切入点必须定义在 <aop:aspect> 元素下, 或者直接定义在 <aop:config> 元素下.
  
  • 定义在 <aop:aspect> 元素下: 只对当前切面有效
  • 定义在<aop:config> 元素下: 对所有切面都有效
• 基于 XML 的 AOP 配置不允许在切入点表达式中用名称引用其他切入点.

<aop:config>
        <!-- 声明切面 -->
        <aop:aspect id="logXmlAspect" ref="logXmlAspectBean">
            <!-- 切入点 -->
            <aop:pointcut expression="execution(* ice.mimosa.d_inform.Calculator.*(..))" id="logXmlAspectCut"/>

            <!-- 通知，引用切入点，或者使用pointcut指明表达式 -->
            <aop:before method="before_log" pointcut-ref="logXmlAspectCut"/>
            <aop:after method="after_log" pointcut-ref="logXmlAspectCut"/>
        </aop:aspect>

    </aop:config>

• 在 aop Schema 中, 每种通知类型都对应一个特定的 XML 元素.
• 通知元素需要使用 <pointcut-ref> 来引用切入点, 或用 <pointcut>直接嵌入切入点表达式. method 属性指定切面类中通知方法的名称.