SpringBoot AOP中JoinPoint的用法和通知切點(diǎn)表達(dá)式

前言

上一篇文章講解了springboot aop 初步完整的使用和整合 這一篇講解他的接口方法和類

JoinPoint和ProceedingJoinPoint對(duì)象

  1. JoinPoint對(duì)象封裝了SpringAop中切面方法的信息,在切面方法中添加JoinPoint參數(shù),就可以獲取到封裝了該方法信息的JoinPoint對(duì)象.

  2. ProceedingJoinPoint對(duì)象是JoinPoint的子接口,該對(duì)象只用在@Around的切面方法中

方法名 功能
Signature getSignature(); 獲取封裝了署名信息的對(duì)象,在該對(duì)象中可以獲取到目標(biāo)方法名,所屬類的Class等信息
Object[] getArgs(); 獲取傳入目標(biāo)方法的參數(shù)對(duì)象
Object getTarget(); 獲取被代理的對(duì)象
Object getThis(); 獲取代理對(duì)象 
@Aspect
@Component
public class aopAspect {
    /**
     * 定義一個(gè)切入點(diǎn)表達(dá)式,用來(lái)確定哪些類需要代理
     * execution(* aopdemo.*.*(..))代表aopdemo包下所有類的所有方法都會(huì)被代理
     */
    @Pointcut("execution(* aopdemo.*.*(..))")
    public void declareJoinPointerExpression() {}

    /**
     * 前置方法,在目標(biāo)方法執(zhí)行前執(zhí)行
     * @param joinPoint 封裝了代理方法信息的對(duì)象,若用不到則可以忽略不寫
     */
    @Before("declareJoinPointerExpression()")
    public void beforeMethod(JoinPoint joinPoint){
        System.out.println("目標(biāo)方法名為:" + joinPoint.getSignature().getName());
        System.out.println("目標(biāo)方法所屬類的簡(jiǎn)單類名:" +        joinPoint.getSignature().getDeclaringType().getSimpleName());
        System.out.println("目標(biāo)方法所屬類的類名:" + joinPoint.getSignature().getDeclaringTypeName());
        System.out.println("目標(biāo)方法聲明類型:" + Modifier.toString(joinPoint.getSignature().getModifiers()));
        //獲取傳入目標(biāo)方法的參數(shù)
        Object[] args = joinPoint.getArgs();
        for (int i = 0; i < args.length; i++) {
            System.out.println("第" + (i+1) + "個(gè)參數(shù)為:" + args[i]);
        }
        System.out.println("被代理的對(duì)象:" + joinPoint.getTarget());
        System.out.println("代理對(duì)象自己:" + joinPoint.getThis());
    }

    /**
     * 環(huán)繞方法,可自定義目標(biāo)方法執(zhí)行的時(shí)機(jī)
     * @param pjd JoinPoint的子接口,添加了
     *            Object proceed() throws Throwable 執(zhí)行目標(biāo)方法
     *            Object proceed(Object[] var1) throws Throwable 傳入的新的參數(shù)去執(zhí)行目標(biāo)方法
     *            兩個(gè)方法
     * @return 此方法需要返回值,返回值視為目標(biāo)方法的返回值
     */
    @Around("declareJoinPointerExpression()")
    public Object aroundMethod(ProceedingJoinPoint pjd){
        Object result = null;

        try {
            //前置通知
            System.out.println("目標(biāo)方法執(zhí)行前...");
            //執(zhí)行目標(biāo)方法
            //result = pjd.proeed();
            //用新的參數(shù)值執(zhí)行目標(biāo)方法
            result = pjd.proceed(new Object[]{"newSpring","newAop"});
            //返回通知
            System.out.println("目標(biāo)方法返回結(jié)果后...");
        } catch (Throwable e) {
            //異常通知
            System.out.println("執(zhí)行目標(biāo)方法異常后...");
            throw new RuntimeException(e);
        }
        //后置通知
        System.out.println("目標(biāo)方法執(zhí)行后...");

        return result;
    }
}

切點(diǎn)表達(dá)式

  1. 在Spring AOP中，連接點(diǎn)始終代表方法的執(zhí)行。切入點(diǎn)是與連接點(diǎn)匹配的，切入點(diǎn)表達(dá)語(yǔ)言是以編程方式描述切入點(diǎn)的方式。

  2. 切入點(diǎn)（Poincut）是定義了在“什么地方”進(jìn)行切入，哪些連接點(diǎn)會(huì)得到通知。顯然，切點(diǎn)一定是連接點(diǎn)

  3. 切點(diǎn)是通過@Pointcut注解和切點(diǎn)表達(dá)式定義的。@Pointcut注解可以在一個(gè)切面內(nèi)定義可重用的切點(diǎn)。

execute表達(dá)式

*代表匹配任意修飾符及任意返回值，參數(shù)列表中..匹配任意數(shù)量的參數(shù)

可以使用&&、||、!、三種運(yùn)算符來(lái)組合切點(diǎn)表達(dá)式，表示與或非的關(guān)系

  1. 攔截任意公共方法execution(public * *(..))
  2. 攔截以set開頭的任意方法execution(* set*(..))
  3. 攔截類或者接口中的方法
攔截AccountService(類、接口)中定義的所有方法
execution(* com.xyz.service.AccountService.*(..))
  1. 攔截包中定義的方法，不包含子包中的方法
攔截com.xyz.service包中所有類中任意方法，**不包含**子包中的類
execution(* com.xyz.service.*.*(..))
  1. 攔截包或者子包中定義的方法
攔截com.xyz.service包或者子包中定義的所有方法
execution(* com.xyz.service..*.*(..))

通知分類

@Before

  1. 前置通知: 在方法執(zhí)行之前執(zhí)行
  2. 前置通知使用@Before注解 將切入點(diǎn)表達(dá)式值作為注解的值
image

@After

  1. 后置通知, 在方法執(zhí)行之后執(zhí)行
  2. 后置通知使用@After注解 ，在后置通知中，不能訪問目標(biāo)方法執(zhí)行的結(jié)果
image

@AfterRunning

  1. 返回通知, 在方法返回結(jié)果之后執(zhí)行
  2. 返回通知使用@AfterRunning注解
image
image

@AfterThrowing

  1. 異常通知, 在方法拋出異常之后執(zhí)行
  2. 異常通知使用@AfterThrowing注解
image

@Around

  1. 環(huán)繞通知, 圍繞著方法執(zhí)行
  2. 環(huán)繞通知使用@Around注解
image
package com.jason.spring.aop.impl;
 
import java.util.Arrays;
import java.util.List;
 
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component;
 
 
//把這個(gè)類聲明為一個(gè)切面
//1.需要將該類放入到IOC 容器中
@Component
//2.再聲明為一個(gè)切面
@Aspect
public class LoggingAspect {
    
    //聲明該方法是一個(gè)前置通知：在目標(biāo)方法開始之前執(zhí)行 哪些類，哪些方法
    //作用：@before 當(dāng)調(diào)用目標(biāo)方法，而目標(biāo)方法與注解聲明的方法相匹配的時(shí)候，aop框架會(huì)自動(dòng)的為那個(gè)方法所在的類生成一個(gè)代理對(duì)象，在目標(biāo)方法執(zhí)行之前，執(zhí)行注解的方法
    //支持通配符
    //@Before("execution(public int com.jason.spring.aop.impl.ArithmeticCaculatorImpl.*(int, int))")
    @Before("execution(* com.jason.spring.aop.impl.*.*(int, int))")
    public void beforeMethod(JoinPoint joinPoint){
        String methodName = joinPoint.getSignature().getName();
        List<Object> args = Arrays.asList(joinPoint.getArgs());
        System.out.println("The method " + methodName + " begins " + args);
    }
    
    /**
     * @Description:  在方法執(zhí)行后執(zhí)行的代碼，無(wú)論該方法是否出現(xiàn)異常
     * @param joinPoint
     */
    @After("execution(* com.jason.spring.aop.impl.*.*(int, int))")
    public void afterMethod(JoinPoint joinPoint){
        String methodName = joinPoint.getSignature().getName();
        List<Object> args = Arrays.asList(joinPoint.getArgs());
        System.out.println("The method " + methodName + " end " + args);
    }
    
    /**
     * 
     * @Description:  在方法正常結(jié)束后執(zhí)行代碼，放回通知是可以訪問到方法的返回值
     *
     * @param joinPoint
     */
    @AfterReturning( value="execution(* com.jason.spring.aop.impl.*.*(..))", returning="result")
    public void afterReturning(JoinPoint joinPoint ,Object result){
        String methodName = joinPoint.getSignature().getName();
        System.out.println("The method " + methodName + " end with " + result);
    }
    
    /**
     * 
     * @Description:  在目標(biāo)方法出現(xiàn)異常時(shí)會(huì)執(zhí)行代碼，可以訪問到異常對(duì)象，且，可以指定出現(xiàn)特定異常時(shí)執(zhí)行通知代碼
     *
     * @param joinPoint
     * @param ex
     */
    @AfterThrowing(value="execution(* com.jason.spring.aop.impl.*.*(..))",throwing="ex")
    public void afterThrowting(JoinPoint joinPoint, Exception  ex){
        String methodName = joinPoint.getSignature().getName();
        System.out.println("The method " + methodName + " occurs exceptions " + ex);
    }
    
    /**
     * 
     * @Description: 環(huán)繞通知需要攜帶 ProceedingJoinPoint 類型的參數(shù)
     *                    環(huán)繞通知 類似于  動(dòng)態(tài)代理的全過程
     *                   ProceedingJoinPoint：可以決定是否執(zhí)行目標(biāo)方法
     *    環(huán)繞通知必須有返回值，返回值即為目標(biāo)方法的返回值
     *    
     * @param proceedingJoinPoint
     */
    @Around("execution(* com.jason.spring.aop.impl.*.*(..))")
    public Object around(ProceedingJoinPoint proceedingJoinPoint){
        
        Object result = null;
        String methodName = proceedingJoinPoint.getSignature().getName();
        
        //執(zhí)行目標(biāo)方法
        try {
            //前置通知
            System.out.println("The method " + methodName + "begin with" + Arrays.asList(proceedingJoinPoint.getArgs()));
            
            result = proceedingJoinPoint.proceed();
            
            //后置通知
            System.out.println("The method " + methodName + "end with" + result);
            
        } catch (Throwable e) {
            //異常通知
            System.out.println("The method occurs exception : " + e);
            throw new RuntimeException();
        }
            //后置通知
            
        System.out.println("The method " + methodName + "end with" + result);
        
        return result;        
    }
}

切點(diǎn)表達(dá)式參考

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容