8 個(gè)Spring AOP 全部注解:真實(shí)業(yè)務(wù)使用案例說明(必須收藏)

image.png

Spring AOP(面向切面編程)是Spring框架的一個(gè)重要組成部分尊搬,它允許開發(fā)者以聲明式的方式實(shí)現(xiàn)橫切關(guān)注點(diǎn)湾蔓,如日志記錄椒丧、事務(wù)管理壹甥、安全性控制等。通過使用Spring AOP注解壶熏,我們可以將這些橫切邏輯與業(yè)務(wù)邏輯分離句柠,從而保持代碼的清晰和可維護(hù)性。AOP注解提供了一種強(qiáng)大的機(jī)制棒假,使得開發(fā)者能夠在不修改主業(yè)務(wù)邏輯代碼的前提下溯职,為應(yīng)用程序添加豐富的橫切功能,增強(qiáng)了代碼的模塊化和重用性帽哑。這些注解包括@Aspect谜酒、@Pointcut、@Before妻枕、@After僻族、@AfterReturning粘驰、@AfterThrowing、@Around和@EnableAspectJAutoProxy等述么,它們共同構(gòu)成了Spring AOP的核心蝌数,使得開發(fā)者能夠輕松地實(shí)現(xiàn)復(fù)雜的企業(yè)級(jí)特性。

肖哥彈架構(gòu) 跟大家“彈彈” 代碼設(shè)計(jì)技巧度秘,需要代碼關(guān)注

歷史熱點(diǎn)文章

1、AOP代理注解

1. @Aspect

1.1 注解作用介紹

@Aspect 注解用于標(biāo)識(shí)一個(gè)類作為切面類敷钾,允許在其中定義切點(diǎn)和通知枝哄。

1.2 注解屬性介紹

  • 無特定屬性。

1.3 注解業(yè)務(wù)案例

@Aspect
@Component
public class SecurityAspect {
    // 切點(diǎn)和通知定義
}

2. @Pointcut

2.1 注解作用介紹

@Pointcut 注解用于定義一個(gè)切點(diǎn)阻荒,可以與@Before挠锥、@AfterReturning、@AfterThrowing等注解結(jié)合使用侨赡。

2.2 注解屬性介紹

  • value: 指定切點(diǎn)表達(dá)式蓖租。

2.3 注解業(yè)務(wù)案例

@Pointcut("execution(* com.example.service.*.*(..))")
public void pointcutServiceMethods() {
    // 切點(diǎn)表達(dá)式定義,匹配com.example.service包下的所有方法羊壹。
}

3. @Before

3.1 注解作用介紹

@Before 注解用于定義前置通知蓖宦,它會(huì)在目標(biāo)方法執(zhí)行之前執(zhí)行。

3.2 注解屬性介紹

  • valuepointcut: 指定切點(diǎn)表達(dá)式油猫。
    3.3 注解業(yè)務(wù)案例
@Before("pointcutServiceMethods()")
public void logBeforeServiceMethod(JoinPoint joinPoint) {
    // 日志記錄邏輯稠茂,例如記錄方法名和參數(shù)
    String methodName = joinPoint.getSignature().getName();
    Object[] args = joinPoint.getArgs();
    System.out.println("Entering: " + methodName + " with arguments " + Arrays.toString(args));
}

4. @After

4.1 注解作用介紹

@After 注解用于定義后置通知,它會(huì)在目標(biāo)方法執(zhí)行之后執(zhí)行情妖。

4.2 注解屬性介紹

  • valuepointcut: 指定切點(diǎn)表達(dá)式睬关。

4.3 注解業(yè)務(wù)案例

@After("pointcutServiceMethods()")
public void logAfterServiceMethod(JoinPoint joinPoint) {
    // 日志記錄邏輯,例如記錄方法執(zhí)行完成
    String methodName = joinPoint.getSignature().getName();
    System.out.println("Exiting: " + methodName);
}

5. @AfterReturning

5.1 注解作用介紹

@AfterReturning 注解用于定義返回后通知毡证,它會(huì)在目標(biāo)方法成功執(zhí)行并返回結(jié)果之后執(zhí)行电爹。

5.2 注解屬性介紹

  • valuepointcut: 指定切點(diǎn)表達(dá)式。
  • returning: 指定從目標(biāo)方法返回的參數(shù)名稱料睛。
    5.3 注解業(yè)務(wù)案例
@AfterReturning(pointcut = "pointcutServiceMethods()", returning = "result")
public void logAfterReturningServiceMethod(Object result) {
    // 處理方法返回結(jié)果
    System.out.println("Service method returned: " + result);
}

6. @AfterThrowing

6.1 注解作用介紹

@AfterThrowing 注解用于定義異常拋出通知丐箩,它會(huì)在目標(biāo)方法拋出異常之后執(zhí)行。

6.2 注解屬性介紹

  • valuepointcut: 指定切點(diǎn)表達(dá)式恤煞。
  • throwing: 指定異常參數(shù)名稱屎勘。

6.3 注解業(yè)務(wù)案例

@AfterThrowing(pointcut = "pointcutServiceMethods()", throwing = "exception")
public void logAfterThrowingServiceMethod(Exception exception) {
    // 異常處理邏輯
    System.err.println("Service method threw exception: " + exception.getMessage());
}

7. @Around

7.1 注解作用介紹

@Around 注解用于定義環(huán)繞通知,它包圍目標(biāo)方法的執(zhí)行居扒,允許在方法執(zhí)行前后和方法拋出異常時(shí)執(zhí)行自定義邏輯概漱。
7.2 注解屬性介紹

  • valuepointcut: 指定切點(diǎn)表達(dá)式。
    7.3 注解業(yè)務(wù)案例
@Around("pointcutServiceMethods()")
public Object aroundServiceMethod(ProceedingJoinPoint joinPoint) throws Throwable {
    // 方法執(zhí)行前后的邏輯
    long startTime = System.currentTimeMillis();
    Object result = joinPoint.proceed(); // 繼續(xù)執(zhí)行目標(biāo)方法
    long endTime = System.currentTimeMillis();
    System.out.println("Execution time: " + (endTime - startTime) + " ms");
    return result;
}

8. @EnableAspectJAutoProxy

8.1 注解作用介紹

@EnableAspectJAutoProxy 注解用于開啟對(duì)AspectJ代理的支持苔货,通常在配置類上使用犀概。
8.2 注解屬性介紹

  • 無特定屬性立哑。
    8.3 注解業(yè)務(wù)案例
@Configuration
@EnableAspectJAutoProxy
public class AspectConfiguration {
    // 其他Spring配置
}

2、AOP代理注解綜合案例

電子商務(wù)平臺(tái)的訂單服務(wù)姻灶,其中包含訂單創(chuàng)建铛绰、訂單支付和訂單狀態(tài)查詢的方法。我們需要記錄每個(gè)訂單操作的日志产喉、監(jiān)控操作的執(zhí)行時(shí)間捂掰,并處理可能發(fā)生的異常。

2.1 實(shí)體類:Order

public class Order {
    private Long id;
    private String status;
    // 其他訂單屬性和方法
}

2.2 服務(wù)接口:OrderService

public interface OrderService {
    void createOrder(Order order);
    void processPayment(Long orderId);
    Order getOrderStatus(Long orderId);
}

2.3 服務(wù)實(shí)現(xiàn):OrderServiceImpl

@Service
public class OrderServiceImpl implements OrderService {
    @Override
    public void createOrder(Order order) {
        // 創(chuàng)建訂單的業(yè)務(wù)邏輯
    }

    @Override
    public void processPayment(Long orderId) {
        // 處理訂單支付的業(yè)務(wù)邏輯
    }

    @Override
    public Order getOrderStatus(Long orderId) {
        // 獲取訂單狀態(tài)的業(yè)務(wù)邏輯
        return new Order(); // 返回新訂單狀態(tài)
    }
}

2.4 切面類:OrderAspect

@Aspect
@Component
public class OrderAspect {
    
    @Pointcut("execution(* com.example.ecommerce.service.OrderService.*(..))")
    public void orderServiceMethods() {}

    @Before("orderServiceMethods()")
    public void logBeforeOrderServiceMethod(JoinPoint joinPoint) {
        // 日志記錄邏輯曾沈,記錄方法入口
        String methodName = joinPoint.getSignature().getName();
        System.out.println("Before method: " + methodName);
    }

    @AfterReturning(pointcut = "orderServiceMethods()", returning = "result")
    public void logAfterReturningOrderServiceMethod(Object result) {
        // 處理方法返回結(jié)果
        System.out.println("After method returned: " + result);
    }

    @AfterThrowing(pointcut = "orderServiceMethods()", throwing = "error")
    public void logAfterThrowingOrderServiceMethod(Exception error) {
        // 異常處理邏輯
        System.err.println("Exception in order service: " + error.getMessage());
    }

    @Around("orderServiceMethods()")
    public Object aroundOrderServiceMethod(ProceedingJoinPoint joinPoint) throws Throwable {
        // 方法執(zhí)行前后的邏輯
        long startTime = System.currentTimeMillis();
        Object result = joinPoint.proceed(); // 繼續(xù)執(zhí)行目標(biāo)方法
        long endTime = System.currentTimeMillis();
        System.out.println("Execution time: " + (endTime - startTime) + " ms");
        return result;
    }
}

2.5 配置類:AspectConfiguration

@Configuration
@EnableAspectJAutoProxy
public class AspectConfiguration {
    // 其他Spring配置
}

本案例中这嚣,我們定義了一個(gè)Order實(shí)體類、一個(gè)OrderService接口及其實(shí)現(xiàn)OrderServiceImpl塞俱。OrderAspect切面類使用@Aspect注解標(biāo)識(shí)姐帚,其中定義了多個(gè)通知方法,使用@Pointcut定義了切點(diǎn)表達(dá)式障涯,這些通知方法將應(yīng)用于OrderService中的所有方法罐旗。我們還使用@Before@AfterReturning唯蝶、@AfterThrowing@Around注解來定義前置通知九秀、返回后通知、異常拋出通知和環(huán)繞通知粘我。最后鼓蜒,AspectConfiguration配置類用于開啟AspectJ自動(dòng)代理。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末征字,一起剝皮案震驚了整個(gè)濱河市都弹,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌柔纵,老刑警劉巖缔杉,帶你破解...
    沈念sama閱讀 217,277評(píng)論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件锤躁,死亡現(xiàn)場(chǎng)離奇詭異搁料,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)系羞,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,689評(píng)論 3 393
  • 文/潘曉璐 我一進(jìn)店門郭计,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人椒振,你說我怎么就攤上這事昭伸。” “怎么了澎迎?”我有些...
    開封第一講書人閱讀 163,624評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵庐杨,是天一觀的道長(zhǎng)选调。 經(jīng)常有香客問我,道長(zhǎng)灵份,這世上最難降的妖魔是什么仁堪? 我笑而不...
    開封第一講書人閱讀 58,356評(píng)論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮填渠,結(jié)果婚禮上弦聂,老公的妹妹穿的比我還像新娘。我一直安慰自己氛什,他們只是感情好莺葫,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,402評(píng)論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著枪眉,像睡著了一般捺檬。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上贸铜,一...
    開封第一講書人閱讀 51,292評(píng)論 1 301
  • 那天欺冀,我揣著相機(jī)與錄音,去河邊找鬼萨脑。 笑死隐轩,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的渤早。 我是一名探鬼主播职车,決...
    沈念sama閱讀 40,135評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼鹊杖!你這毒婦竟也來了悴灵?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 38,992評(píng)論 0 275
  • 序言:老撾萬榮一對(duì)情侶失蹤骂蓖,失蹤者是張志新(化名)和其女友劉穎积瞒,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體登下,經(jīng)...
    沈念sama閱讀 45,429評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡茫孔,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,636評(píng)論 3 334
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了被芳。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片缰贝。...
    茶點(diǎn)故事閱讀 39,785評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖畔濒,靈堂內(nèi)的尸體忽然破棺而出剩晴,到底是詐尸還是另有隱情,我是刑警寧澤侵状,帶...
    沈念sama閱讀 35,492評(píng)論 5 345
  • 正文 年R本政府宣布赞弥,位于F島的核電站毅整,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏绽左。R本人自食惡果不足惜毛嫉,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,092評(píng)論 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望妇菱。 院中可真熱鬧承粤,春花似錦、人聲如沸闯团。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,723評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽房交。三九已至彻舰,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間候味,已是汗流浹背刃唤。 一陣腳步聲響...
    開封第一講書人閱讀 32,858評(píng)論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留白群,地道東北人尚胞。 一個(gè)月前我還...
    沈念sama閱讀 47,891評(píng)論 2 370
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像帜慢,于是被迫代替她去往敵國和親笼裳。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,713評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容