Spring Aop如何給Advice傳遞參數
給Advice傳遞參數
Advice除了可以接收JoinPoint(非Around Advice)或ProceedingJoinPoint(Around Advice)參數外,還可以直接接收與切入點方法執行有關的對象,比如切入點方法參數、切入點目標對象(target)、切入點代理對象(this)等。
1獲取切入點方法參數
假設我們現在有一個id為userService的bean中定義了一個findById(int id)方法,我們希望定義一個Advice來攔截這個方法,并且把findById()的參數作為Advice處理方法的參數,即每次調用findById()傳遞的參數都將傳遞到Advice處理方法,那么我們可以如下這樣定義。
@Before(value='bean(userService) && execution(* findById(java.lang.Integer)) && args(id)', argNames='id')public void beforeWithParam(JoinPoint joinPoint, Integer id) { System.out.println(this.getClass().getName()+' ID is : ' + id);}
上面這種定義是非常精確的定義,我們通過表達式“bean(userService) && execution(* findById(java.lang.Integer))”就已經明確的指定了我們需要攔截的是id或name為userService的findById(Integer)方法,后面又加了一個args(id)是干什么用的呢?它的作用跟findById(Integer)是類似的,它表示我們的切入點方法必須只接收一個參數,而且這個參數的類型是和當前定義的Advice處理方法的參數id是相同類型的,在上面的示例中其實就是要求是Integer類型的;另外它還有一個非常重要的作用,通過這種指定后對應的Advice處理方法在執行時將接收到與之對應的切入點方法參數的值。在上面的示例中筆者特意給Advice處理方法加了一個JoinPoint參數是為了說明JoinPoint、ProceedingJoinPoint參數是可以直接定義在Advice方法的第一個參數,并且是可以與其它接收的參數共存的。其實如果我們不只是需要攔截findById(Integer)方法,而是需要攔截id為userService的bean中所有接收一個int/Integer參數的方法,那么我們可以把上面的配置簡化為如下這樣。
@Before(value='bean(userService) && args(id)', argNames='id')public void beforeWithParam2(int id) { System.out.println(this.getClass().getName()+' ID is : ' + id);}
如果我們需要攔截的方法可能是有多個參數的,但我們只關注第一個參數,那我們可以把表達式調整為如下這樣,只關注第一個參數為int/Integer類型的,并且在Advice方法中接收這個方法參數進行相應的處理。
@Before(value='bean(userService) && args(id,..)', argNames='id')public void beforeWithParam2(int id) { System.out.println(this.getClass().getName()+' ID is : ' + id);}
2 argNames參數
我們可以看到在上述例子中我們都指定了@Before的argNames屬性的值為id,那么這個argNames屬性有什么作用呢?argNames屬性是用于指定在表達式中應用的參數名與Advice方法參數是如何對應的,argNames中指定的參數名必須與表達式中的一致,可以與Advice方法參數名不一致;當表達式中使用了多個參數時,argNames中需要指定多個參數,多個參數之間以英文逗號分隔,這些參數的順序必須與對應的Advice方法定義的參數順序是一致的。
比如下面這個示例中,我們在Pointcut表達式中使用了name和sex兩個參數,我們的Advice處理方法接收兩個參數,分別是sex1和name1,我們希望Pointcut表達式中的name參數是對應的Advice處理方法的第二個參數,即name1,希望Pointcut表達式中的sex參數是對應的Advice處理方法的第一個參數,即sex1,那么我們在指定@Before注解的argNames參數時必須定義name和sex參數與Advice處理方法參數的關系,且順序要求與對應的處理方法的參數順序一致,即哪個參數是需要與Advice處理方法的第一個參數匹配則把哪個參數放第一位,與第二個參數匹配的則放第二位,在我們的這個示例中就應該是sex放第一位,name放第二位。
@Before(value='bean(userService) && args(name, sex)', argNames='sex, name')public void beforeWithParam3(int sex1, String name1) { System.out.println('sex is : ' + sex1); System.out.println('name is : ' + name1);}
@Before注解的argNames參數不是必須的,它只有在我們編譯的字節碼中不含DEBUG信息或Pointcut表達式中使用的參數名與Advice處理方法的參數名不一致時才需要。所以在編譯的字節碼中包含DEBUG信息且Advice參數名與Pointcut表達式中使用的參數名一致時,我們完全可以把argNames參數省略。如果表達式里面使用了多個參數,那么這些參數在表達式中的順序可以與Advice方法對應參數的順序不一致,例如下面這個樣子。
@Before(value='bean(userService) && args(id)')public void beforeWithParam2(int id) { System.out.println(this.getClass().getName()+' ID is : ' + id);}
3 獲取this對象
this對象就是Spring生成的bean的那個代理對象。如下示例就是Advice方法接收this對象,我們給Advice方法指定一個需要攔截的this對象類型的參數,然后在表達式中使用this類型的表達式定義,表達式中定義的對應類型指定為Advice方法參數。
@Before('this(userService)')public void beforeWithParam4(IUserService userService) { //this對象應該是一個代理對象 System.out.println(this.getClass().getName()+'==============傳遞this對 象: ' + userService.getClass());}
4 混合使用
我們的Advice方法可以同時接收多個目標方法參數,與此同時它也可以接收this等對象,即它們是可以混合使用的。下面這個示例中我們就同時接收了this對象和目標方法int/Interger類型的參數。
@Before('this(userService) && args(id)')public void beforeWithParam5(IUserService userService, int id) { System.out.println(this.getClass().getName()+'===========' + id + '==============' + userService.getClass());}
5 獲取target對象
獲取target對象也比較簡單,只需要把表達式改為target類型的表達式即可。
@Before('target(userService)')public void beforeWithParam6(IUserService userService) { System.out.println(this.getClass().getName()+'==============傳遞 target對象: ' + userService.getClass());}
6 獲取注解對象
當我們的Pointcut表達式類型是通過注解匹配時,我們也可以在Advice處理方法中獲取匹配的注解對象,如下面這個示例,其它如使用@target等是類似的。
@Before('@annotation(annotation)')public void beforeWithParam7(MyAnnotation annotation) { System.out.println(this.getClass().getName()+'==============傳遞標 注在方法上的annotation: ' + annotation.annotationType().getName());}
7 泛型參數
有的時候我們的Advice方法需要接收的切入點方法參數定義的不是具體的類型,而是一個泛型,這種情況下怎么辦呢?可能你會想那我就把對應的Advice方法參數定義為Object類型就好了,反正所有的類型都可以轉換為Object類型。對的,這樣是沒有錯的,但是說如果你只想攔截某種具體類型的參數調用時就可以不用把Advice方法參數類型定義為Object了,這樣還得在方法體里面進行判斷,我們可以直接把Advice方法參數類型定義為我們想攔截的方法參數類型。比如我們有下面這樣一個使用了泛型的方法定義,我們希望只有在調用testParam方法時傳遞的參數類型是Integer類型時才進行攔截。
public <T> void testParam(T param);
那這個時候我們就可以把我們的Advice的表達式定義為如下這樣,前者精確定義接收方法名為testParam,返回類型為void,后者精確定義方法參數為一個Integer類型的參數,其實前者也可以定義為“execution(void testParam(Integer))”。看到這你可能會想,為什么不直接把表達式定義為“execution(void testParam(param))”呢?因為execution是不支持Advice方法參數綁定的,基本上支持Advice參數綁定的就只有this、target、args以及對應的注解形式加@annotation。
@Before('execution(void testParam(..)) && args(param)')public void beforeWithParam8(Integer param) { System.out.println('pointcut expression[args(param)]--------------param:' + param);}
以上就是常用的傳遞參數給Advice處理方法的方式,有一些示例可能沒有講到,比如@target這種,這些其實都是類似的。包括上面我們都是以@Before這種Advice來講的,其實其它的Advice在接收參數的時候也是類似的。
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持好吧啦網。
相關文章: