Spring Boot系列——AOP配自定義注解的最佳實踐

AOP(Aspect Oriented Programming)，即面向切面編程，是Spring框架的大殺器之一。

首先，我聲明下，我不是來系統介紹什么是AOP，更不是照本宣科講解什么是連接點、切面、通知和切入點這些讓人頭皮發麻的概念。

今天就來說說AOP的一些應用場景以及如何通過和其他特性的結合提升自己的靈活性。

AOP應用舉例

AOP的一大好處就是解耦。通過切面，我們可以將那些反復出現的代碼抽取出來，放在一個地方統一處理。

同時，抽出來的代碼很多是與業務無關的，這樣可以方便開發者更加專注自己的業務邏輯的開發。

一個AOP的典型應用場景就是日志打印。

下面是一個極端情況的Controller

@RestController
@RequestMapping("/")
public class HelloController {
    private static final Logger LOG = LoggerFactory.getLogger(HelloController.class);

    @GetMapping(value = "/index")
    public String index(HttpServletRequest request) {
        LOG.info("============打印日志開始============");
        LOG.info("URL: " + request.getRequestURL().toString());
        LOG.info("============打印日志結束============");
        return "hello jackie";
    }

    @GetMapping(value = "/test1")
    public String test1(HttpServletRequest request, String var1) {
        LOG.info("============打印日志開始============");
        LOG.info("URL: " + request.getRequestURL().toString());
        LOG.info("============打印日志結束============");
        return "test1";
    }

    @DemoAnnotation
    @GetMapping(value = "/test2")
    public String test2(HttpServletRequest request, String var1, String var2) {
        LOG.info("============打印日志開始============");
        LOG.info("URL: " + request.getRequestURL().toString());
        LOG.info("============打印日志結束============");
//        int i = 1/0;
        if (1<2)
            throw new IllegalArgumentException("exception");
        return "test2";
    }
}

HelloController中提供了三個Http接口，由於業務需要，所以每次進入某個方法的時候都需要打印請求的相關信息。

當然，如果只是上面的例子，我們完全可以通過其他手段讓代碼看着並不這么糟糕。我們可以抽象一個打印方法，將相同的代碼封裝在這個方法中，之后在各個方法中每次調用即可。

但是，這種處理方法似乎抽象的還不夠，因為我們在每個Http接口中還是要調用這個抽象的函數。而且，比較要命的是，這打印日志的代碼與其他業務代碼顯得有些格格不入。

所以，這時候，我們想到了AOP。

如何使用AOP

在Spring Boot項目中，只需要如下幾步，就可以輕松上手AOP。

添加maven依賴

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

編寫切面類

@Aspect
@Component
public class DemoAspect {
    private static final Logger LOG = LoggerFactory.getLogger(DemoAspect.class);

    @Pointcut("execution(public * com.jackie.springbootdemo.controller.HelloController.test*(..))")
    public void addAdvice(){}

    @Before("addAdvice()")
    public void before(JoinPoint joinPoint){
        Object[] args = joinPoint.getArgs();
        HttpServletRequest requests = (HttpServletRequest) args[0];
        LOG.info("============打印日志開始============");
        LOG.info("URL: " + requests.getRequestURL().toString());
        LOG.info("============打印日志結束============");
//        LOG.info("before....");
    }
}

結果驗證對比

啟動SpringBootDemoApplication，訪問url：http://localhost:8080/test2?var1=1&var2=2

未使用切面功能打印日志

使用切面功能打印日志

從上面的結果展示發現，最終的效果是一樣的，但是使用切面更加簡潔，而且可復用。

如上訪問的是test2接口，如果訪問test1接口也可以走切面類實現打印日志的需求，但是如果走index請求就不會打印日志了。

這是為什么呢？

AOP的局限

在切面類DemoAspect中，我們看到了切入點的設置

@Pointcut("execution(public * com.jackie.springbootdemo.controller.HelloController.test*(..))")
public void addAdvice(){}

其中Pointcut后面的表達式是用於控制切面的有效影響范圍。

**表達式中，第一個表示返回任意類型，第二個表示任意方法名，后面的小括號表示任意參數值，這里是以test為前綴的，所以可以匹配上test1和test2方法。

注意，在第二個之前也可以再有個，即HelloController所在位置，表示任意類名，假如這里是有兩個*.則表示包括包里面的子包。**

好了，明白了表達式的含義，我們自然就看到了AOP的局限性。

當我們要使用切面前，就要寫好表達式，但是項目一直在做，代碼一直在加，那誰能保證后面接收代碼的兄弟也正好知道這個test前綴的意義這么重大呢？

如果他非要用hello作為前綴，那么本應該匹配到的接口就匹配不上了，日志也就不能正常打印了。

這時候，自定義注解，就能夠很好的解決這個問題。

自定義注解配合AOP

新建一個自定義注解

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

}

自定義注解的花樣也很多，比如可以在注解中聲明變量等，但這些不是我們這次討論的重點。

將該注解添加到Http接口test2方法上

    @DemoAnnotation
    @GetMapping(value = "/test2")
    public String test2(HttpServletRequest request, String var1, String var2) {
//        LOG.info("============打印日志開始============");
//        LOG.info("URL: " + request.getRequestURL().toString());
//        LOG.info("============打印日志結束============");
//        int i = 1/0;
        if (1<2)
            throw new IllegalArgumentException("exception");
        return "test2";
    }

在切面類中將切入點的表達式改為

@Pointcut("execution(public * com.jackie.springbootdemo.controller.*.*(..)) && @annotation(com.jackie.springbootdemo.annotation.DemoAnnotation)")
public void addAdvice(){}

這樣，我們不需要限制在controller類中是以test作為前綴了，只要是在上面定義的類路徑下，並且掃描到注解DemoAnnotation就可以讓切面生效。

從結果可以看出，訪問http://localhost:8080/test1?var1=1並沒有經過切面處理，因為不滿足切入點中的表達式要求。

這樣做的好處在於，控制的粒度更細，也更加靈活，方便切面功能的實現和細分。

代碼已提交至rome

如果您覺得閱讀本文對您有幫助，請點一下“推薦”按鈕，您的“推薦”將是我最大的寫作動力！如果您想持續關注我的文章，請掃描二維碼，關注JackieZheng的微信公眾號，我會將我的文章推送給您，並和您一起分享我日常閱讀過的優質文章。