Spring AOP

AOP 前奏

WHY AOP?

需求1：在程序执行期间追踪正在发生的活动
需求2：希望计算器只能处理正数的运算

代码实现片段

出现的问题

• 代码混乱：越来越多的非业务需求(日志和验证等)加入后, 原有的业务方法急剧膨胀. 每个方法在处理核心逻辑的同时还必须兼顾其他多个关注点.
• 代码分散：以日志需求为例, 只是为了满足这个单一需求, 就不得不在多个模块（方法）里多次重复相同的日志代码. 如果日志需求发生变化, 必须修改所有模块.

使用动态代理解决上述问题

• 代理设计模式的原理：使用一个代理将对象包装起来, 然后用该代理对象取代原始对象. 任何对原始对象的调用都要通过代理. 代理对象决定是否以及何时将方法调用转到原始对象上.

ArithmeticCalculator.java

package com.spring.aop.impl;

public interface ArithmeticCalculator {
    int add(int i, int j);
    int sub(int i, int j);
    int mul(int i, int j);
    int div(int i, int j);
}

ArithmeticCalculatorimpl.java

package com.spring.aop.helloworld;

public class ArithmeticCalculatorImpl implements ArithmeticCalculator {
    @Override
    public int add(int i, int j) {
        return i+j;
    }

    @Override
    public int sub(int i, int j) {
        return i-j;
    }

    @Override
    public int mul(int i, int j) {
        return i*j;
    }

    @Override
    public int div(int i, int j) {
        return i/j;
    }
}

ArithmeticCalculatorLoggingProxy.java

package com.spring.aop.helloworld;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.util.Arrays;

public class ArithmeticCalculatorLoggingProxy {
    //要代理的对象
    private ArithmeticCalculator target;

    public ArithmeticCalculatorLoggingProxy(ArithmeticCalculator target) {
        this.target = target;
    }

    public ArithmeticCalculator getLoggingProxy(){
        ArithmeticCalculator proxy = null;

        //代理对象由哪一个类加载器负责加载
        ClassLoader loader = target.getClass().getClassLoader();
        //代理对象的类型，即其中有哪些方法
        Class[] interfaces = new Class[]{ArithmeticCalculator.class};
        //当调用代理对象其中方法时，该执行的方法
        InvocationHandler h = new InvocationHandler() {
            /**
             * proxy:正在返回的那个代理对象，一般情况下，在invoke方法中都不使用该对象
             * method:正在被调用的方法
             * args:调用方法时，传入的参数
             * */
            @Override
            public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                String methodName = method.getName();
                //日志
                System.out.println("The method " + methodName + "begins with " + Arrays.asList(args));
                //执行方法
                Object result = method.invoke(target,args);
                //日志
                System.out.println("The method " + methodName+ "ends with " + result);
                return result;
            }
        };
        proxy = (ArithmeticCalculator) Proxy.newProxyInstance(loader,interfaces,h);

        return proxy;
    }
}

测试代码

package com.spring.aop.helloworld;

public class Main {
    public static void main(String[] args){
        ArithmeticCalculator target = new ArithmeticCalculatorImpl();
        ArithmeticCalculator proxy = new ArithmeticCalculatorLoggingProxy(target).getLoggingProxy();

        int result = proxy.add(1,2);
        System.out.println("-->"+result);

        result = proxy.div(4,3);
        System.out.println("-->"+result);
    }
}

结果：
The method addbegins with [1, 2]
The method addends with 3
-->3
The method divbegins with [4, 3]
The method divends with 1
-->1

AOP 简介

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

AOP 术语

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

Spring AOP

• AspectJ：Java 社区里最完整最流行的 AOP 框架.
• 在 Spring2.0 以上版本中, 可以使用基于 AspectJ 注解或基于 XML 配置的 AOP

在Spring中启用AspectJ注解支持

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

用AspectJ注解声明切面

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

前置通知

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

//声明该方法时一个前置通知: 在目标方法开始之前执行
    @Before("execution(* com.spring.aop.impl.*.add(..))")
    public void beforeMethod(JoinPoint joinPoint)
    {
        System.out.println("The method  begins with ");
    }

标识这个方法是个前置通知, 切点表达式表示执行 ArithmeticCalculator 接口的 add() 方法. * 代表匹配任意修饰符及任意返回值, 参数列表中的 .. 匹配任意数量的参数

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

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

合并切入点表达式

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

  //声明该方法时一个前置通知: 在目标方法开始之前执行
      @Before("execution(* com.spring.aop.impl.*.add(int,int))&&execution(* com.spring.aop.impl.*.div(int,int))")
      public void beforeMethod(JoinPoint joinPoint)
      {
          System.out.println("The method  begins with ");
      }

让通知访问当前连接点的细节

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

  //声明该方法时一个前置通知: 在目标方法开始之前执行
      @Before("execution(* com.spring.aop.impl.*.*(int,int))")
      public void beforeMethod(JoinPoint joinPoint)
      {
          String MethodName =  joinPoint.getSignature().getName();
          List<Object> args = Arrays.asList(joinPoint.getArgs());
          System.out.println("The method "+MethodName+" begins with " + args);
      }

标识这个方法是个前置通知, 切点表达式表示执行任意类的任意方法. 第一个 代表匹配任意修饰符及任意返回值, 第二个 代表任意类的对象,第三个 * 代表任意方法, 参数列表中的 .. 匹配任意数量的参数

后置通知

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

//后置通知：在目标方法执行后（无论是否发生异常），执行的通知
    //在后置通知中还不能访问目标方法执行的结果
    @After("execution(* com.spring.aop.impl.*.*(..))")
    public void afterMethod(JoinPoint joinPoint){
        String MethodName = joinPoint.getSignature().getName();
        System.out.println("The method "+ MethodName+" ends");
    }

返回通知

• 无论连接点是正常返回还是抛出异常, 后置通知都会执行. 如果只想在连接点返回的时候记录日志, 应使用返回通知代替后置通知.

  /**
       * 在方法正常结束受执行的代码
       * */
      @AfterReturning("execution(* com.spring.aop.impl.*.*(..))")
      public void afterRunningMethod(){
          System.out.println("afterRunning... ");
      }

在返回通知中访问连接点的返回值

• 在返回通知中, 只要将 returning 属性添加到 @AfterReturning 注解中, 就可以访问连接点的返回值. 该属性的值即为用来传入返回值的参数名称.
• 必须在通知方法的签名中添加一个同名参数. 在运行时, Spring AOP 会通过这个参数传递返回值.
• 原始的切点表达式需要出现在 pointcut 属性中

/**
     * 在方法正常结束受执行的代码
     * 返回通知时可以访问到方法的返回值的！
     * */
    @AfterReturning(pointcut = "execution(* com.spring.aop.impl.*.*(..))",
    returning = "result")
    public void afterRunningMethod(Object result){
        System.out.println("afterRunning: " + result);
    }

异常通知

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

/**
    * 在目标方法出现异常时会执行的代码
    * 可以访问到异常对象；且可以指定在出现特定异常时执行通知代码qwx
    * */
   @AfterThrowing(value = "execution(* com.spring.aop.impl.*.*(..))",
   throwing = "ex")
   public void AfterThrowingMethod(Exception ex){
       System.out.println("AfterThrowing:"+ex);
   }

环绕通知

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

环绕通知示例代码

@Around("execution(* com.spring.aop.impl.*.*(..))")
    public Object aroundMethod(ProceedingJoinPoint pjd){
        Object result = null;
        String methodName = pjd.getSignature().getName();
        try {
            //执行目标方法
            //前置通知
            System.out.println("The method " + methodName + " before with " + Arrays.asList(pjd.getArgs()));
            result = pjd.proceed();
            //后置通知
            System.out.println("The method " + methodName + " after with");
        } catch (Throwable throwable) {
            //异常通知
            System.out.println("The method "+methodName+"occurs exception:"+ throwable);
        }

        return result;
    }

指定切面的优先级

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

/**
 * 可以使用@Order注解指定切面的优先级，值越小优先级越高
 * */
@Order(1)
@Aspect
@Component
public class VlidationAspect {

    @Before("execution(* com.spring.aop.impl.*.*(..))")
    public void validateArgs(JoinPoint joinPoint){
        System.out.println("validate:" + Arrays.asList(joinPoint.getArgs()));
    }
}

重用切入点定义

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

重用切入点示例代码

/**
    * 定义一个方法，用于声明切入点表达式，一般地，该方法中再也不需要添入其他的代码
    * */
   @Pointcut("execution(* com.spring.aop.impl.*.*(..))")
   public void declareJointPointExpression(){}

   //声明该方法时一个前置通知: 在目标方法开始之前执行
   @Before("declareJointPointExpression()")
   public void beforeMethod(JoinPoint joinPoint)
   {
       String MethodName =  joinPoint.getSignature().getName();
       List<Object> args = Arrays.asList(joinPoint.getArgs());
       System.out.println("The method "+MethodName+" begins with " + args);
   }

   //后置通知：在目标方法执行后（无论是否发生异常），执行的通知
   //在后置通知中还不能访问目标方法执行的结果
   @After("declareJointPointExpression()")
   public void afterMethod(JoinPoint joinPoint){
       String MethodName = joinPoint.getSignature().getName();
       System.out.println("The method "+ MethodName+" ends");
   }

   /**
    * 在目标方法出现异常时会执行的代码
    * 可以访问到异常对象；且可以指定在出现特定异常时执行通知代码qwx
    * */
   @AfterThrowing(value = "declareJointPointExpression()",
   throwing = "ex")
   public void AfterThrowingMethod(Exception ex){
       System.out.println("AfterThrowing:"+ex);
   }

   /**
    * 在方法正常结束受执行的代码
    * 返回通知时可以访问到方法的返回值的！
    * */
   @AfterReturning(value = "declareJointPointExpression()",
   returning = "result")
   public void afterRunningMethod(Object result){
       System.out.println("afterRunning: " + result);
   }

用基于XML的配置声明切面

• 除了使用 AspectJ 注解声明切面, Spring 也支持在 Bean 配置文件中声明切面. 这种声明是通过 aop schema 中的 XML 元素完成的.
• 正常情况下, 基于注解的声明要优先于基于 XML 的声明. 通过 AspectJ 注解, 切面可以与 AspectJ 兼容, 而基于 XML 的配置则是 Spring 专有的. 由于 AspectJ 得到越来越多的 AOP 框架支持, 所以以注解风格编写的切面将会有更多重用的机会.

基于XML —- 声明切面

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

声明切面的实例代码

<!-- 配置切面的bean -->
    <bean id="calculatorvalidationAspect" class="com.spring.aop.xml.VlidationAspect"></bean>
 <!-- 配置AOP -->
    <aop:config>
		<aop:aspect id = "validationAspect" ref="calculatorvalidationAspect">
        </aop:aspect>
    </aop:config>

基于 XML —- 声明切入点

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

声明切入点的示例代码

<!-- 定义bean -->
<bean id="arithmeticCalculator" class="com.spring.aop.xml.ArithmeticCalculatorImpl"></bean>

<!-- 配置切面的bean -->
<bean id="loggingAspect" class="com.spring.aop.xml.LoggingAspect"></bean>
<bean id="validationAspect" class="com.spring.aop.xml.VlidationAspect"></bean>

<!-- 配置AOP -->
<aop:config>
<!-- 配置切点表达式 -->
    <aop:pointcut expression="execution(* com.spring.aop.xml.*.*(..))" id="pointcut" />
    <!-- 配置切面及通知 -->
    <aop:aspect ref="loggingAspect" order="2">
        <aop:before method="beforeMethod" pointcut-ref="pointcut"/>
        <aop:after method="afterMethod" pointcut-ref="pointcut"/>
        <aop:after-returning method="afterRunningMethod" pointcut-ref="pointcut" returning="result"/>
        <aop:after-throwing method="AfterThrowingMethod" pointcut-ref="pointcut" throwing="ex" />
    </aop:aspect>
    <aop:aspect ref="validationAspect" order="1">
        <aop:before method="validateArgs" pointcut-ref="pointcut" ></aop:before>
    </aop:aspect>
</aop:config>