Spring AOP高級(jí)知識(shí)你知道多少?
環(huán)境:Spring Boot3.2.5
1. 簡(jiǎn)介
Spring AOP(面向切面編程)是一種強(qiáng)大的范式,用于模塊化應(yīng)用程序中的橫切關(guān)注點(diǎn)。切入點(diǎn)(Pointcut)是一組一個(gè)或多個(gè)連接點(diǎn)(Join Point)的集合,在這些連接點(diǎn)上應(yīng)該應(yīng)用通知(Advice)。連接點(diǎn)是程序執(zhí)行過程中的一個(gè)點(diǎn),比如方法執(zhí)行、對(duì)象實(shí)例化或字段訪問。切入點(diǎn)定義了通知執(zhí)行的時(shí)機(jī)和位置。
在本文中,我們將學(xué)習(xí)Spring AOP切入點(diǎn)表達(dá)式語(yǔ)法的復(fù)雜性,并通過幾個(gè)示例來幫助我們編寫精確且有效的切入點(diǎn)。
2. 切入點(diǎn)表達(dá)式語(yǔ)法
Spring AOP 使用 AspectJ 風(fēng)格的表達(dá)式來定義切入點(diǎn)。這種語(yǔ)法涉及組合各種元素以精確定位特定的連接點(diǎn)。
例如,使用execution()來指定方法執(zhí)行的連接點(diǎn)。其基本語(yǔ)法遵循如下的模式:
execution(modifiers? return_type method_name(param_type1, param_type2, …))
示例:
execution(public void com.pack.service.UserService.doSomething())
使用通配符匹配多個(gè)元素,類似于正則表達(dá)式。例如,* 可匹配任意字符序列,..可匹配任意數(shù)量的參數(shù),如下示例:
execution(* com.pack.service.*.*(..))
使用within()可以指定某一類型或包中的連接點(diǎn),如下示例:
within(com.pack.service.*)
該表達(dá)式匹配"com.pack.service"包中的所有方法。
2.1 匹配特定方法
最典型的點(diǎn)切表達(dá)式用于根據(jù)方法的簽名匹配方法。讓我們來看看幾個(gè)最常用的模式。
Pointcut 表達(dá)式 | 說明 |
execution(* com.pack.UserService.*(..)) | 匹配指定包和類中的所有方法 |
execution(*UserService.*(..)) | 匹配同一包和指定類中的所有方法 |
execution(public *UserService.*(..)) | 匹配UserService中的所有公共方法 |
execution(public UserUserService.*(..)) | 匹配UserService中所有返回類型為 User 對(duì)象的公共方法 |
execution(public UserUserService.*(User, ..)) | 匹配UserService中所有返回類型為 User 且第一個(gè)參數(shù)為 User 的公共方法 |
execution(public UserUserService.*(User, Integer)) | 匹配UserService中所有返回類型為 User 且?guī)в兄付▍?shù)的公共方法 |
接下來,我們來看看常用的with表達(dá)式
2.2 with表達(dá)式
我們可以使用 within() 函數(shù)攔截類或包中所有方法的執(zhí)行,如下表格:
Pointcut表達(dá)式 | 說明 |
within(com.pack.*) | 匹配包 "com.pack.*"中所有類的所有方法 |
within(com.pack..*) | 匹配包"com.pack"中所有類的所有方法,以及所有子包中的類 |
within(com.pack.UserService) | 匹配指定包中指定類的所有方法 |
within(UserService) | 匹配當(dāng)前包中指定類的所有方法 |
within(IUserService+) | 匹配指定接口所有實(shí)現(xiàn)中的所有方法 |
下面,再來看看bean表達(dá)式的使用
2.3 bean表達(dá)式
我們可以使用bean()函數(shù)來匹配所有符合指定模式的類中的所有方法。
Pointcut表達(dá)式 | 說明 |
bean(*Service) | 匹配 bean 中名稱以 "Service"結(jié)尾的所有方法 |
bean(userService) | 匹配指定 Bean 中名稱為 "userService "的所有方法 |
bean(com.pack.service.*) | 匹配特定包中所有bean的所有方法 |
bean(@PackAnnotation *) | 將所有 Bean 中的所有方法與特定注解相匹配 |
還有其它基于注解、方法參數(shù)的表達(dá)式這里就不做介紹了,可查看官方文檔。
2.4 組合切點(diǎn)表達(dá)式
在 AspectJ 中,點(diǎn)切分表達(dá)式可以與運(yùn)算符 &&(和)、||(或)和 !(讓我們通過一個(gè)簡(jiǎn)單的例子來理解。下面的示例匹配名稱以 Service 或 DAO 結(jié)尾的 Bean 中的所有方法。
bean(*Service) || bean(*DAO)
在這里使用"||"符號(hào)組合兩個(gè)表達(dá)式。
3. @Aspect順序
假設(shè)有這樣一個(gè)場(chǎng)景。我們有兩個(gè)切面,分別是LoggingAspect和SecurityAspect,它們都攔截服務(wù)包內(nèi)的方法調(diào)用。為了確保在進(jìn)行安全檢查之前生成全面的日志,LoggingAspect應(yīng)該在SecurityAspect之前執(zhí)行。
類似地,在應(yīng)用中我們還可能有CacheAspect和SecurityAspect。緩存切面(CachingAspect)應(yīng)該先執(zhí)行,以便在重復(fù)進(jìn)行安全檢查之前,可能從緩存中檢索結(jié)果。
在這些情況下,明確強(qiáng)制執(zhí)行切面的順序是必要的。
3.1 使用@Order注解
定義切面執(zhí)行順序的一種直接方法是利用 @Order 注解。順序值較低的方面優(yōu)先執(zhí)行。
- 相對(duì)于其他具有相同順序值的對(duì)象,具有相同順序值的切面將以任意順序排序。
- 任何沒有提供自己的排序值的切面都會(huì)被隱式地分配一個(gè) Ordered.LOWEST_PRECEDENCE 值,從而在所有排序切面都執(zhí)行完畢后再執(zhí)行。
接下來,我們來看看如下示例:
@Aspect
@Order(1)
@Component
public class MyAspect1 {
// 第一個(gè)執(zhí)行
}
@Aspect
@Order(2)
@Component
public class MyAspect2 {
// 最后執(zhí)行
}
以上通過@Order指定了切面的順序,值越小越先執(zhí)行。
3.2 實(shí)現(xiàn)Ordered接口
切面排序的另一種方法是實(shí)現(xiàn) Ordered 接口。這樣可以對(duì)分配給切面的順序值進(jìn)行更多控制,如下示例:
@Aspect
@Component
public class MyAspect1 implements Ordered {
@Override
public int getOrder() {
// 在這里你可以根據(jù)一些邏輯判斷進(jìn)行返回值
return 1;
}
// 第一個(gè)執(zhí)行
}
@Aspect
@Component
public class MyAspect2 implements Ordered {
@Override
public int getOrder() {
return 2;
}
// 最后執(zhí)行
}
通過這種實(shí)現(xiàn)Ordered接口的方式使得順序可以更加的靈活。
3.3 完整示例
如下,創(chuàng)建了 LoggingAspect 和 SecurityAspect 兩個(gè)切面。我們的目標(biāo)是在 SecurityAspect 之前執(zhí)行 LoggingAspect。
@Aspect
@Order(1)
@Component
public class LoggingAspect {
private static final Logger logger = LoggerFactory.getLogger(LoggingAspect.class);
@Before("execution(* com.pack.service.*.*(..))")
public void logBefore() {
logger.info("LoggingAspect: Logging before method execution");
// Logging logic
}
}
在這里,@Order(1) 注解表示應(yīng)首先執(zhí)行日志記錄。
下面,@Order(2) 注解表示安全方面應(yīng)在第二位執(zhí)行。
@Aspect
@Order(2)
@Component
public class SecurityAspect {
private static final Logger logger = LoggerFactory.getLogger(SecurityAspect.class);
@Before("execution(* com.pack.service.*.*(..))")
public void checkSecurity() {
logger.info("SecurityAspect: Performing security check before method execution");
// Security check logic
}
}
最終輸出結(jié)果如下
INFO LoggingAspect: Logging before method execution
INFO SecurityAspect: Performing security check before method execution
我們可以通過調(diào)整@Order的數(shù)值來控制切面的執(zhí)行順序。