springboot aop裡的@Pointcut()的配置方式

Posted on by

springboot aop裡的@Pointcut()的配置

@Pointcut("execution(public * com.wangzhou.newboot.exception.TestExceptionController.test(String,String))")

com.wangzhou.newboot.exception是TestExceptionController類的全路徑，test(String,String)是TestExceptionController類下的

test(String s,String d)方法

如果要忽略test方法的入參，所有test方法將被aop

@Pointcut("execution(public * com.wangzhou.newboot.exception.TestExceptionController.test(..))")

如果忽略TestExceptionController的方法，所有TestExceptionController下的方法將被aop

@Pointcut("execution(public * com.wangzhou.newboot.exception.TestExceptionController.*(..))")

如果忽略exception路徑下的所有類，不包括exception的子路徑

@Pointcut("execution(public * com.wangzhou.newboot.exception.*.*(..))")

如果忽略newboot路徑下的所有類，不包括newboot的子路徑比如exception裡的類，

@Pointcut("execution(public * com.wangzhou.newboot..*.*(..))")

springboot aop @Pointcut的用法

格式：

execution(modifiers-pattern? ret-type-pattern declaring-type-pattern? name-pattern(param-pattern)throws-pattern?)

括號中各個pattern分別表示：

  • 修飾符匹配（modifier-pattern?）
  • 返回值匹配（ret-type-pattern）可以為*表示任何返回值,全路徑的類名等
  • 類路徑匹配（declaring-type-pattern?）
  • 方法名匹配（name-pattern）可以指定方法名 或者 *代表所有, set* 代表以set開頭的所有方法
  • 參數匹配（(param-pattern)）可以指定具體的參數類型，多個參數間用“,”隔開，各個參數也可以用“*”來表示匹配任意類型的參數，如(String)表示匹配一個String參數的方法；(*,String) 表示匹配有兩個參數的方法，第一個參數可以是任意類型，而第二個參數是String類型；可以用(..)表示零個或多個任意參數
  • 異常類型匹配（throws-pattern?）
  • 其中後面跟著“?”的是可選項

現在來看看幾個例子：

1）execution(* *(..))  
//表示匹配所有方法  
2）execution(public * com. savage.service.UserService.*(..))  
//表示匹配com.savage.server.UserService中所有的公有方法  
3）execution(* com.savage.server..*.*(..))  
//表示匹配com.savage.server包及其子包下的所有方法

在Spring 2.0中，Pointcut的定義包括兩個部分：Pointcut表示式(expression)和Pointcut簽名(signature)

//Pointcut表示式
@Pointcut("execution(* com.savage.aop.MessageSender.*(..))")
//Point簽名
private void log(){}

然後要使用所定義的Pointcut時，可以指定Pointcut簽名

如下：

@Before("og()")

這種使用方式等同於以下方式，直接定義execution表達式使用

@Before("execution(* com.savage.aop.MessageSender.*(..))")

Pointcut定義時，還可以使用&&、||、! 這三個運算

@Pointcut("execution(* com.savage.aop.MessageSender.*(..))")
private void logSender(){}
@Pointcut("execution(* com.savage.aop.MessageReceiver.*(..))")
private void logReceiver(){}
@Pointcut("logSender() || logReceiver()")
private void logMessage(){}

這個例子中，logMessage()將匹配任何MessageSender和MessageReceiver中的任何方法。

還可以將一些公用的Pointcut放到一個類中，以供整個應用程序使用，如下：

package com.savage.aop;
import org.aspectj.lang.annotation.*;
public class Pointcuts {
@Pointcut("execution(* *Message(..))")
public void logMessage(){}
@Pointcut("execution(* *Attachment(..))")
public void logAttachment(){}
@Pointcut("execution(* *Service.*(..))")
public void auth(){}
}

在使用上面定義Pointcut時，指定完整的類名加上Pointcut簽名就可以瞭，如：

package com.savage.aop;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.*;
@Aspect
public class LogBeforeAdvice {
@Before("com.sagage.aop.Pointcuts.logMessage()")
public void before(JoinPoint joinPoint) {
System.out.println("Logging before " + joinPoint.getSignature().getName());
}
}

當基於XML Sechma實現Advice時，如果Pointcut需要被重用，可以使用<aop:pointcut></aop:pointcut>來聲明Pointcut，然後在需要使用這個Pointcut的地方，用pointcut-ref引用就行瞭，如：

<aop:config>
　　<aop:pointcut id="log" expression="execution(* com.savage.simplespring.bean.MessageSender.*(..))"/>
　　<aop:aspect id="logging" ref="logBeforeAdvice">
　　　　<aop:before pointcut-ref="log" method="before"/>
　　　　<aop:after-returning pointcut-ref="log" method="afterReturning"/>
　　</aop:aspect>
</aop:config>

另外，除瞭execution表示式外，還有within、this、target、args等Pointcut表示式

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：