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
============環繞後==============