說說 Spring AOP 中 @Aspect 的高階用法

deniro發表於2018-08-19

1 切點複合運算

支援在切點定義中加入以下運算子進行復合運算:

運算子 說明
&& 與運算。
! 非運算。
\|\| 或運算。

2 切點命名

一般情況下,切點是直接宣告在需要增強方法處,這種切點的宣告方式稱為匿名切點,匿名切點只能在宣告處被使用 。 如果希望在其它地方可以重用這個切點,我們可以通過 @Pointcut 註解及切面類方法來命名它。

public class NamePointcut {

    /**
     * 切點被命名為 method1,且該切點只能在本類中使用
     */
    @Pointcut("within(net.deniro.spring4.aspectj.*)")
    private void method1() {
    }

    /**
     * 切點被命名為 method2,且該切點可以在本類或子孫類中使用
     */
    @Pointcut("within(net.deniro.spring4.aspectj.*)")
    protected void method2() {
    }

    /**
     * 切點被命名為 method3,且該切點可以在任何類中使用
     * 這裡還使用了複合運算
     */
    @Pointcut("method1() && method2()")
    public void method3() {
    }
}
複製程式碼

命名切點的結構如下:

說說 Spring AOP 中 @Aspect 的高階用法

切點可訪問性修飾符與類可訪問性修飾符的功能是相同的,它可以決定定義的切點可以在哪些類中可使用。

因為命名切點僅利用方法名及訪問修飾符的資訊,所以我們一般定義方法的返回型別為 void ,並且方法體為空 。

定義好切點後,就可以在切面類中引用啦:

@Aspect
public class NamePointcutAspect {

    @After("NamePointcut.method2()")
    public void aspectMethod1() {
    }

    /**
     * 這裡使用了複合運算
     */
    @After("NamePointcut.method2() && NamePointcut.method3()")
    public void aspectMethod2() {
    }
}
複製程式碼

3 織入順序

一個連線點可以同時匹配多個切點,而切點所對應的增強在連線點上織入順序的規則是這樣的:

1.如果在同一個切面類中宣告的增強,則按照增強在切面類中定義的順序進行織入; 2. 如果增強位於不同的切面類中,並且這些切面類都實現了org.springframework.core.Ordered 介面,則由 Ordered 方法的順序號決定(順序號小的先織入); 3. 如果增強位於不同的切面類中,但這些切面類沒有實現org.springframework.core.Ordered 介面,織入的順序是不確定的 。

假設有兩個切面類 A 與 B,它們都實現了 Ordered 介面,A 的順序號為 1,B 的順序號為 2,切面類 A 與 B 都定義了 3 個增強,那麼同時匹配這 6 個增強的織入順序如下圖所示:

說說 Spring AOP 中 @Aspect 的高階用法

4 獲取連線點資訊

4.1 JoinPoint

org.aspectj.lang.JoinPoint 介面表示目標類連線點物件,它定義這些主要方法。

方法 說明
Object[] getArgs() 獲取連線點方法執行時的入參列表。
Signature getSignature() 獲取連線點的方法簽名物件。
Object getTarget() 獲取連線點所在的目標物件。
Object getThis() 獲取代理物件。

4.2 ProceedingJoinPoint

org.aspectj.lang.ProceedingJoinPoint 繼承了 JoinPoint 介面,它新增了兩個方法(它們用於執行連線點方法)。

方法 說明
Object proceed() throws Throwable 通過反射執行目標物件連線點處的方法。
Object proceed(Object[] var1) throws Throwable 使用新的入參(替換掉原來的入參),通過反射執行目標物件連線點處的方法。

4.3 示例

Cook 介面:

public interface Cook {

    /**
     * 製作食品
     */
    void make();

    /**
     * 製作
     *
     * @param name 食品名稱
     */
    void make(String name);
}
複製程式碼

CookA 類:

public class CookA implements Cook {
    public void make() {
        System.out.println("製作食品");
    }

    public void make(String name) {
        System.out.println("製作" + name);
    }
}
複製程式碼

在切面類中訪問連線點資訊:

@Aspect
public class JoinPointAspect {

    @Around("within(net.deniro.spring4.aspectj.CookA)")
    public void test(ProceedingJoinPoint pjp) throws Throwable {
        System.out.println("---------獲取連線點物件【開始】---------");
        System.out.println("引數:" + pjp.getArgs()[0]);
        System.out.println("簽名物件:" + pjp.getTarget().getClass());

        //執行目標物件方法
        pjp.proceed();
        System.out.println("---------獲取連線點物件【結束】---------");

    }
}
複製程式碼

Spring bean 配置:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">

    <!--aspectj 驅動器 -->
    <aop:aspectj-autoproxy/>

    <bean id="cookA" class="net.deniro.spring4.aspectj.CookA"/>
    <bean class="net.deniro.spring4.aspectj.JoinPointAspect"/>
</beans>
複製程式碼

輸出結果:

---------獲取連線點物件【開始】--------- 引數:壽司 簽名物件:class net.deniro.spring4.aspectj.CookA 製作壽司 ---------獲取連線點物件【結束】---------

5 繫結連線點的方法入參

args()、this()、target()、@args()、@within()、@target() 和 @annotation() 這些切點函式除可以指定類名外,還可以指定引數名,將目標物件連線點上的方法入參繫結到增強的方法中 。 其中 args() 用於繫結連線點方法的入參, @annotation() 用於繫結連線點方法的註解物件,而 @args() 用於繫結連線點方法入參的註解。

CookC 類:

public class CookC implements Cook {
    public void make() {
        System.out.println("製作食品");
    }

    public void make(String name) {
        System.out.println("製作" + name);
    }

    public void make(String name, int num) {
        System.out.println("製作" + name + " " + num + " 個");
    }
}
複製程式碼

切面類:

@Aspect
public class ParamsAspect {

    @Before("target(net.deniro.spring4.aspectj.CookC) && args(name,num,..)")
    public void test(String name,int num) {
        System.out.println("----------繫結連線點入參【開始】----------");
        System.out.println("name:" + name);
        System.out.println("num:" + num);
        System.out.println("----------繫結連線點入參【結束】----------");

    }
}
複製程式碼
  • 這裡的連線點表示式 args(name,num,..) 會先找到 name 與 num 的型別,從而生成真正的表示式 args(String,int,..)
  • 增強方法可以通過 name 與 num 得到連線點的方法入參。

切點匹配和引數繫結的過程是這樣的:

  1. args()會根據引數名稱在增強方法中查到名稱相同的入參並獲得對應引數的型別,這樣就得到了匹配連線點方法的入參型別 。
  2. 連線點方法入參型別所在的位置由引數名在 args() 函式中宣告的位置決定 。

上述示例中的匹配過程如下:

說說 Spring AOP 中 @Aspect 的高階用法

Spring 配置:

<!--aspectj 驅動器 -->
<aop:aspectj-autoproxy proxy-target-class="true"/>

<bean id="cookC" class="net.deniro.spring4.aspectj.CookC"/>
<bean class="net.deniro.spring4.aspectj.ParamsAspect"/>
複製程式碼

注意: 這裡必須通過 <aop:aspectj-autoproxy proxy-target-class="true" />來啟用 CGLib 動態代理,這是因為 CookC 的 public void make(String name, int num) 是該類獨有的方法(非介面定義的方法),所以必須使用 CGLib 生成子類的代理方法 。

單元測試:

ApplicationContext context = new ClassPathXmlApplicationContext("spring-beans.xml");
CookC cookC = (CookC) context.getBean("cookC");
cookC.make("壽司", 100);
複製程式碼

輸出結果:

----------繫結連線點入參【開始】---------- name:壽司 num:100 ----------繫結連線點入參【結束】---------- 製作壽司 100 個

6 繫結代理物件

使用 this()target() 可繫結被代理物件的例項。通過類例項名繫結物件時,依然具有原來連線點匹配的功能,只是類名是由增強方法中的同名入參型別間接決定的。

@Aspect
public class ProxyAspect {

    @Before("this(cook)")
    public void bind(Cook cook) {
        System.out.println("--------繫結代理物件【開始】--------");
        System.out.println(cook.getClass().getName());
        System.out.println("--------繫結代理物件【結束】--------");
    }
}
複製程式碼

首先通過 public void bind(Cook cook) 找出 cook 所對應的型別,接著轉換切點表示式為 this(net.deniro.spring4.aspectj.Cook) 。這樣就表示該切點匹配所有代理物件為 Cook 類中的所有方法。

輸出結果:

--------繫結代理物件【開始】-------- net.deniro.spring4.aspectj.CookC$$EnhancerBySpringCGLIB$$217fb793 --------繫結代理物件【結束】--------

target() 繫結與 this() 相似。

7 繫結類註解物件

@within() 和 @target() 函式都可以將目標類的註解物件繫結到增強方法中。

定義一個日誌註解類:

@Retention(RetentionPolicy.RUNTIME)//保留期限
@Target({ElementType.METHOD,ElementType.TYPE})//目標型別
public @interface Log {
    boolean value() default true;//宣告成員變數
}
複製程式碼

把該註解類應用於 CookD:

@Log
public class CookD implements Cook {
    public void make() {
        System.out.println("製作糕點");
    }

    public void make(String name) {

    }
}
複製程式碼

繫結類註解物件:

@Aspect
public class ClassAnnotationObjectAspect {

    @Before("@within(log)")
    public void bind(Log log){
        System.out.println("----------繫結類註解物件【開始】----------");
        System.out.println(log.getClass().getName());
        System.out.println("----------繫結類註解物件【結束】----------");
    }
}
複製程式碼

Spring 配置:

<!--aspectj 驅動器 -->
<aop:aspectj-autoproxy proxy-target-class="true"/>


<bean id="cookD" class="net.deniro.spring4.aspectj.CookD"/>
<bean class="net.deniro.spring4.aspectj.ClassAnnotationObjectAspect"/>
複製程式碼

單元測試:

ApplicationContext context = new ClassPathXmlApplicationContext("spring-beans.xml");
CookD cook = (CookD) context.getBean("cookD");
cook.make();
複製程式碼

輸出結果:

----------繫結類註解物件【開始】---------- com.sun.proxy.$Proxy8 ----------繫結類註解物件【結束】----------

從輸出結果 com.sun.proxy.$Proxy8 可以看出 ,CookD 類的註解 Log 物件也被代理咯O(∩_∩)O哈哈~

#8 繫結返回值

在後置增強中,可以通過 returning 來繫結連線點方法的返回值。

切面:

@Aspect
public class ReturnValueAspect {

    @AfterReturning(value = "target(net.deniro.spring4.aspectj.CookA)", returning = "value")
    public void bind(boolean value) {
        System.out.println("繫結返回值【開始】");
        System.out.println("value:" + value);
        System.out.println("繫結返回值【結束】");
    }
}
複製程式碼

**注意:**returning 的值必須與方法引數名相同。

CookA 新增 smell 方法:

public boolean smell(String name) {
	System.out.println(name + "香嗎?");
	return true;
}
複製程式碼

單元測試:

ApplicationContext context = new ClassPathXmlApplicationContext("spring-beans.xml");
CookA cook = (CookA) context.getBean("cookA");
cook.smell("烤鴨");
複製程式碼

輸出結果:

烤鴨香嗎? 繫結返回值【開始】 value:true 繫結返回值【結束】

9 繫結異常

可以使用 AfterThrowing 註解的 throwing 成員變數來繫結連線點丟擲的異常。

切面類:

@Aspect
public class ExceptionAspect {

    @AfterThrowing(value = "target(net.deniro.spring4.aspectj.CookA)",throwing = "e")
    public void bind(CookException e){
        System.out.println("繫結異常【開始】");
        System.out.println("e:" + e.getMessage());
        System.out.println("繫結異常【結束】");
    }
}
複製程式碼

**注意:**throwing 的值必須與方法引數名相同。

單元測試:

ApplicationContext context = new ClassPathXmlApplicationContext("spring-beans.xml");
CookA cook = (CookA) context.getBean("cookA");
cook.make("");
複製程式碼

輸出結果:

繫結異常【開始】 e:煮啥呢??? 繫結異常【結束】

`

相關文章