Spring5（七）——AOP注解

一、AOP注解

1、介绍

　　上一节介绍了 AspectJ 框架如何实现 AOP，具体的实现方式是通过 xml 来进行配置的。xml 方式思路清晰，便于理解，但是书写过于麻烦。这一节介绍注解的方式来进行 AOP 配置。

2、案例（注解）

　　定义目标对象（被代理的对象）

// 定义一个接口
public interface ITeacher {
    void teach();
    int add(int i, int j);
}

// 定义目标对象
@Service
public class Teacher implements ITeacher {
    @Override
    public void teach() {
        System.out.println("老师正在上课");
    }

    @Override
    public int add(int i, int j) {
        int add = i + j;
        System.out.println("执行目标方法:老师正在做加法,结果为:" + add);
        // int throwable = 10 / 0; 测试异常通知
        return add;
    }

    // 目标对象自己的方法,此方法不是接口所以无法代理
    public void sayHello() {
        System.out.println("老师会说hello");
    }

}

　　编写一个切面类（通知）

// 创建切面类(包含各种通知)
@Component
@Aspect
public class MyAspect {

    // 1.先定义切入点表达式
    @Pointcut("execution(* com.lx.spring.day4.ITeacher.*(..))")
    private void myPointcut() {

    }

    // 2.标识此方法为一个前置通知,用来切满足后面切点表达式的方法
    @Before("myPointcut()")
    public void myBefore(JoinPoint joinPoint) {
        System.out.println("前置通知:方法增强myBefore()" + " , -->" + joinPoint.getSignature().getName());
    }

    @AfterReturning(value = "myPointcut()", returning = "object")
    public void myAfterReturning(JoinPoint joinPoint, Object object) {
        System.out.println("后置通知:方法增强myAfterReturning()" + " , -->" + joinPoint.getSignature().getName() + " , -->" + object);
    }

    public Object myAround(ProceedingJoinPoint joinPoint) throws Throwable {
        System.out.println("============环绕前==============");
        Object obj = joinPoint.proceed(); // 手动执行目标方法
        System.out.println("============环绕后==============");
        return obj;
    }

    public void myAfterThrowing(JoinPoint joinPoint, Throwable e) {
        System.out.println("抛出异常通知:" + e.getMessage());
    }

    public void myAfter() {
        System.out.println("最终通知:方法增强myAfter()");
    }

}

　　编写配置文件 application.xml

<!-- 1.自动扫描(自动注入bean) -->
<context:component-scan base-package="com.lx.spring.day4"/>

<!-- 2.扫描 @Aspect 告诉 spring 这是一个切面类 -->
<aop:aspectj-autoproxy/>

// 测试类
public class Main {
    public static void main(String[] args) {
        ApplicationContext app = new ClassPathXmlApplicationContext("app4.xml");
        ITeacher iTeacher = app.getBean(ITeacher.class);

        iTeacher.add(11, 24);
    }
}

// 结果
前置通知:方法增强myBefore() , -->add
执行目标方法:老师正在做加法,结果为:35
后置通知:方法增强myAfterReturning() , -->add , -->35

　　说明：对比 xml 的配置，不难理解注解的方式。

　　@Service @Component
　　<context:component-scan base-package="com.lx.spring.day4"/>

　　用于 Spring 扫描并注册bean。

　　@Aspect：指明这是一个切面类
　　<aop:aspectj-autoproxy/>：开启切面注解扫描

3、优先级

　　有多个增强类对同一个方法进行增强，设置增强类优先级，在增强类上面添加注解 @Order（数字类型值），数字类型值越小优先级越高。

@Component
@Aspect
@Order(1)
public class MyAspect2 {}

　　优先级：这里的优先级，只会影响两个增强类对应的方法，执行的先后顺序。并不会只执行优先级高的。

二、AOP+自定义注解

　　通过AOP+自定义注解的方式，可以实现前面说的抽取公共非业务模块，对业务逻辑的增强。比如：

　　需求：①想要对业务逻辑层的所有方法，打印出入参和出参，做日志管理。②对业务逻辑层的方法入口，开启事务，逻辑执行后，提交事务，等。

　　自定义注解

// 用于日志打印
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log {

    String value() default "";
}

　　编写切面类（通知）

@Component
@Aspect
public class MyAspect {

    // 定义切入点为 有注解Log的方法
    @Pointcut("@annotation(com.lx.spring.day5.Log) ")
    private void myLogPointcut() {

    }
    
    // 为切入点增强一个环绕通知，可以在这里写打印入参出参的逻辑
    @Around("myLogPointcut()")
    public Object myAround(ProceedingJoinPoint joinPoint) throws Throwable {
        System.out.println("============环绕前==============");
        Object obj = joinPoint.proceed(); // 手动执行目标方法
        System.out.println("============环绕后==============");
        return obj;
    }

}

　　在相应的方法上加注解

@Service
public class Teacher implements ITeacher {

    // 为需要打印入参出参的方法 加上@Log注解即可
    @Log
    @Override
    public int add(int i, int j) {
        int add = i + j;
        System.out.println("执行目标方法:老师正在做加法,结果为:" + add);
        // int throwable = 10 / 0; 测试异常通知
        return add;
    }

}

　　测试类

public class Main {
    public static void main(String[] args) {
        ApplicationContext app = new ClassPathXmlApplicationContext("app4.xml");
        ITeacher iTeacher = app.getBean(ITeacher.class);

        iTeacher.add(11, 24);
    }
}

// 结果
============环绕前==============
执行目标方法:老师正在做加法,结果为:35
============环绕后==============