快捷導(dǎo)航

SpringBoot中定位切點的兩種常用方法

更新時間：2021年06月09日 15:45:04 作者：LukeLong

有時候，我們使用AOP來進(jìn)行放的增強，編寫切面類的時候，需要定位在哪個方法上試用該切面進(jìn)行增強，本片文章主要講解兩種在SpringBoot中定位切點的方法，感興趣的可以了解一下

有時候，我們使用AOP來進(jìn)行放的增強，編寫切面類的時候，需要定位在哪個方法上試用該切面進(jìn)行增強，本片文章主要講解兩種在SpringBoot中定位切點的方法，一種是使用execution表達(dá)式的方法，一種則是利用自定義注解的方法。

接下來以一個簡單的例子來講解這兩種方法的使用方式。

<==========方法執(zhí)行前==========>
method();
<==========方法執(zhí)行后==========>

execution 表達(dá)式

execution表達(dá)式的方式主要是在定義切點的時候，通過表達(dá)式的方式選取到所需要增強的方法。

execution表達(dá)式解讀

execution(<修飾符模式>？<返回類型模式><方法名模式>(<參數(shù)模式>)<異常模式>?)

類型	解讀	是否必須	示例
<修飾符模式>	表示所選的修飾符類型	否	public/private/...
<返回類型模式>	表示所選的返回值類型	是	void/int/...
<方法名模式>	表示所選的包或者方法	是	com.luke.service/com.luke.controller.*/...
(<參數(shù)模式>)	表示所選方法的參數(shù)	是	(..)/(String name)/*(int size, ..)/...
<異常模式>	表示所選方法的異常類型	否	throws Exception/...

 // 匹配指定包中的所有方法
execution(* com.luke.service.*(..))

// 匹配當(dāng)前包中的所有public方法
execution(public * UserService.*(..))

// 匹配指定包中的所有public方法，并且返回值是int類型的方法
execution(public int com.luke.service.*(..))

// 匹配指定包中的所有public方法，并且第一個參數(shù)是String，返回值是int類型的方法
execution(public int com.luke.service.*(String name, ..))

自定義切面類：

@Aspect
@Component
public class LogAspect {

    @Pointcut("execution(* com.luke.springdata.controller.*.*(..))")
    public void operationLog(){}

    /**
     * 這里只定義一個Around的增強做展示
     */
    @Around("operationLog()")
    public Object doAround(ProceedingJoinPoint joinPoint) {
        Object proceed = null;
        try {
            System.out.println("方法執(zhí)行前");
            proceed = joinPoint.proceed();
            System.out.println("方法執(zhí)行后");
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }
        return proceed;
    }
}

此切點的execution表達(dá)式為com.luke.springdata.controller包下的所有方法。
使用**@Around**注解表明增強的方法，并且指定切點。

測試用Controller類

@RestController
@RequestMapping("/person")
public class PersonController {

    @GetMapping("/test")
    public void test(){
        System.out.println("方法執(zhí)行了");
    }
    
}

運行項目，調(diào)用該方法，查看結(jié)果。

方法執(zhí)行前
方法執(zhí)行了
方法執(zhí)行后

自定義注解的方法

自定義注解的方式就是在需要增強的方法上面加上自定義的注解即可。

自定義注解類：

@Documented
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Log{
    
}

這里自定義了一個注解Log，該注解只能加在方法上。
自定義切面類：

@Aspect
@Component
public class LogAspect {

    @Pointcut("@annotation(com.luke.springdata.annotation.Log)")
    public void operationLog(){}

    /**
     * 這里只定義一個Around的增強做展示
     */
    @Around("operationLog()")
    public Object doAround(ProceedingJoinPoint joinPoint) {
        Object proceed = null;
        try {
            System.out.println("方法執(zhí)行前");
            proceed = joinPoint.proceed();
            System.out.println("方法執(zhí)行后");
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }
        return proceed;
    }
}

這里編寫的自定義個切面類，用**@Pointcut注解定義一個切面，并且這次采用@annotation(xxx)**的方式表明如果哪個方法上添加了xxx注解，則就使用該切面做增強。

同時在每個增強的方法上使用該切面，隨后編寫正常的方法增強邏輯即可。

測試用Controller類

@RestController
@RequestMapping("/person")
public class PersonController {

    @Log
    @GetMapping("/test")
    public void test(){
        System.out.println("方法執(zhí)行了");
    }
    
}

此時在需要使用切面的方法上加入**@Log**注解，調(diào)用該方法，查看效果。