5.1 AOP概述

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

image.png

5.2 AOP术语

image.png
1、横切关注点
从每个方法中抽取出来的同一类非核心业务。

2、切面(Aspect)
封装横切关注点信息的类,每个关注点体现为一个通知方法。

3、通知(Advice)
切面必须要完成的各个具体工作

4、目标(Target)
被通知的对象

5、代理(Proxy)
向目标对象应用通知之后创建的代理对象

6、连接点(Joinpoint)
横切关注点在程序代码中的具体体现,对应程序执行的某个特定位置。例如:类某个方法调用前、调用后、方法捕获到异常后等。
在应用程序中可以使用横纵两个坐标来定位一个具体的连接点:

7、切入点(pointcut):
定位连接点的方式。每个类的方法中都包含多个连接点,所以连接点是类中客观存在的事物。如果把连接点看作数据库中的记录,那么切入点就是查询条件——AOP可以通过切入点定位到特定的连接点。切点通过org.springframework.aop.Pointcut 接口进行描述,它使用类和方法作为连接点的查询条件。

5.3 AOP的简单配置(注解模式)

1、导包

image.png

2、开启基于注解的AOP功能

引入aop名称空间:
image.png

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <beans xmlns="http://www.springframework.org/schema/beans"
  3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4. xmlns:context="http://www.springframework.org/schema/context"
  5. xmlns:aop="http://www.springframework.org/schema/aop"
  6. xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
  7. http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd
  8. http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.0.xsd">
  9. <context:component-scan base-package="com.hao"></context:component-scan>
  10. <aop:aspectj-autoproxy></aop:aspectj-autoproxy>
  11. </beans>

当Spring IOC容器侦测到bean配置文件中的元素时,会自动为与AspectJ切面匹配的bean创建代理

3、写配置

image.png
用AspectJ注解声明切面
①要在Spring中声明AspectJ切面,只需要在IOC容器中将切面声明为bean实例。②当在Spring IOC容器中初始化AspectJ切面之后,Spring IOC容器就会为那些与 AspectJ切面相匹配的bean创建代理。
③在AspectJ注解中,切面只是一个带有@Aspect注解的Java类,它往往要包含很多通知。
④通知是标注有某种注解的简单的Java方法。
⑤AspectJ支持5种类型的通知注解:
[1]@Before:前置通知,在方法执行之前执行
[2]@After:后置通知,在方法执行之后执行
[3]@AfterRunning:返回通知,在方法返回结果之后执行
[4]@AfterThrowing:异常通知,在方法抛出异常之后执行
[5]@Around:环绕通知,围绕着方法执行

@Aspect
@Component
public class logUtils {

    @Pointcut("execution(public int com.hao.impl.MyMathCalculator.*(int, int))")
    public void point() {};

    @Before("point()")
    public static void logStart(JoinPoint joinPoint) {
        Object[] args = joinPoint.getArgs();
        String name = joinPoint.getSignature().getName();
        System.out.println("[log]【"+ name +"】 方法开始执行,使用参数列表 【 "+ Arrays.asList(args) +"】");
    }

    @AfterReturning(value="point()",returning="result")
    public static void logReturn(JoinPoint joinPoint,Object result) {
        String name = joinPoint.getSignature().getName();
        System.out.println("[log]【"+ name +"】 方法执行完成,计算结果是:" + result);
    }

    @AfterThrowing(value="point()",throwing="exception")
    public static void logException(JoinPoint joinPoint,Exception exception) {
        String name = joinPoint.getSignature().getName();

        System.out.println("[log]【"+ name +"】 方法出现了异常,异常信息是:" + exception );
    }

    @After("point()")
    public static void logEnd(JoinPoint joinPoint) {
        String name = joinPoint.getSignature().getName();
        System.out.println("[log]【"+ name +"】 方法最终结束了" );
    }
}

5.4 切入点表达式(execution)

1、作用
通过表达式的方式定位一个或多个具体的连接点。

2、语法细节
①切入点表达式的语法格式

execution([权限修饰符] [返回值类型] [简单类名/全类名] 方法名)

②举例说明

表达式 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中,切入点表达式可以通过“&&”、“||”、“!”等操作符结合起来。

表达式 execution ( .add(int,..)) || execution( .sub(int,..))
含义 任意类中第一个参数为int类型的add方法或sub方法

3、切入点表达式应用到实际的切面类中
image.png

5.5 当前连接点细节(JoinPoint)

  1. 概述

切入点表达式通常都会是从宏观上定位一组方法,和具体某个通知的注解结合起来就能够确定对应的连接点。那么就一个具体的连接点而言,我们可能会关心这个连接点的一些具体信息,例如:当前连接点所在方法的方法名、当前传入的参数值等等。这些信息都封装在JoinPoint接口的实例对象中。

  1. JoinPoint

image.png

@Before("point()")
    public static void logStart(JoinPoint joinPoint) {
        Object[] args = joinPoint.getArgs();
        String name = joinPoint.getSignature().getName();
        System.out.println("[log]【"+ name +"】 方法开始执行,使用参数列表 【 "+ Arrays.asList(args) +"】");
    }

    @AfterReturning(value="point()",returning="result")
    public static void logReturn(JoinPoint joinPoint,Object result) {
        String name = joinPoint.getSignature().getName();
        System.out.println("[log]【"+ name +"】 方法执行完成,计算结果是:" + result);
    }

5.6 通知

1、概述

  • 在具体的连接点上要执行的操作。
  • 一个切面可以包括一个或者多个通知。
  • 通知所使用的注解的值往往是切入点表达式。

2、前置通知(@Before)

  • 前置通知:在方法执行之前执行的通知
  • 使用@Before注解

3、后置通知(@After)

  • 后置通知:后置通知是在连接点完成之后执行的,即连接点返回结果或者抛出异常的时候
  • 使用@After注解

4、返回通知(@AfterReturning)

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

5、异常通知(@AfterThrowing)

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

6、环绕通知(@Around)

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

image.png

7、重用切入点定义(@Pointcut)

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

8、指定切面的优先级

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

image.png

9、执行顺序

单切面:
image.png

多切面:

  • 默认是按字母顺序
  • 还可以用@Order注解排序

image.png

10、案例

@Aspect
@Component
@Order(2)
public class logUtils {

    @Pointcut("execution(public int com.hao.impl.MyMathCalculator.*(int, int))")
    public void point() {};

    @Before("point()")
    public static void logStart(JoinPoint joinPoint) {
        Object[] args = joinPoint.getArgs();
        String name = joinPoint.getSignature().getName();
        System.out.println("[log]【"+ name +"】 方法开始执行,使用参数列表 【 "+ Arrays.asList(args) +"】");
    }

    @AfterReturning(value="point()",returning="result")
    public static void logReturn(JoinPoint joinPoint,Object result) {
        String name = joinPoint.getSignature().getName();
        System.out.println("[log]【"+ name +"】 方法执行完成,计算结果是:" + result);
    }

    @AfterThrowing(value="point()",throwing="exception")
    public static void logException(JoinPoint joinPoint,Exception exception) {
        String name = joinPoint.getSignature().getName();

        System.out.println("[log]【"+ name +"】 方法出现了异常,异常信息是:" + exception );
    }

    @After("point()")
    public static void logEnd(JoinPoint joinPoint) {
        String name = joinPoint.getSignature().getName();
        System.out.println("[log]【"+ name +"】 方法最终结束了" );
    }
}
@Aspect
@Component
@Order(1)
public class ValidateAspect {

    @Before("com.hao.utils.logUtils.point()")
    public static void logStart(JoinPoint joinPoint) {
        Object[] args = joinPoint.getArgs();
        String name = joinPoint.getSignature().getName();
        System.out.println("[val]【"+ name +"】 方法开始执行,使用参数列表 【 "+ Arrays.asList(args) +"】");
    }

    @AfterReturning(value="com.hao.utils.logUtils.point()",returning="result")
    public static void logReturn(JoinPoint joinPoint,Object result) {
        String name = joinPoint.getSignature().getName();
        System.out.println("[val]【"+ name +"】 方法执行完成,计算结果是:" + result);
    }

    @AfterThrowing(value="com.hao.utils.logUtils.point()",throwing="exception")
    public static void logException(JoinPoint joinPoint,Exception exception) {
        String name = joinPoint.getSignature().getName();

        System.out.println("[val]【"+ name +"】 方法出现了异常,异常信息是:" + exception );
    }

    @After("com.hao.utils.logUtils.point()")
    public static void logEnd(JoinPoint joinPoint) {
        String name = joinPoint.getSignature().getName();
        System.out.println("[val]【"+ name +"】 方法最终结束了" );
    }
}

5.7 基于配置的AOP(XML)

1、概述

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

2、配置细节

在bean配置文件中,所有的Spring AOP配置都必须定义在元素内部。对于每个切面而言,都要创建一个元素来为具体的切面实现引用后端bean实例。
切面bean必须有一个标识符,供元素引用。
image.png

3、声明切入点

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

image.png

4、声明通知

在aop名称空间中,每种通知类型都对应一个特定的XML元素。
通知元素需要使用来引用切入点,或用直接嵌入切入点表达式。
method属性指定切面类中通知方法的名称
image.png