SpringBoot 配置aop

摘自：武偉峯原創文章

aop是spring的兩大功能模塊之一，功能非常強大，爲解耦提供了非常優秀的解決方案。
現在就以springboot中aop的使用來了解一下aop。

一：使用aop來完成全局請求日誌處理

創建一個springboot的web項目，勾選aop，pom如下：

<?xml version="1.0" encoding="UTF-8"?>  
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
        xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">  
        <modelVersion>4.0.0</modelVersion>  

        <groupId>com.example</groupId>  
        <artifactId>testaop</artifactId>  
        <version>0.0.1-SNAPSHOT</version>  
        <packaging>jar</packaging>  

        <name>testaop</name>  
        <description>Demo project for Spring Boot</description>  

        <parent>  
            <groupId>org.springframework.boot</groupId>  
            <artifactId>spring-boot-starter-parent</artifactId>  
            <version>1.5.3.RELEASE</version>  
            <relativePath/> <!-- lookup parent from repository -->  
        </parent>  

        <properties>  
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>  
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>  
            <java.version>1.8</java.version>  
        </properties>  

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

            <dependency>  
                <groupId>org.springframework.boot</groupId>  
                <artifactId>spring-boot-starter-test</artifactId>  
                <scope>test</scope>  
            </dependency>  
        </dependencies>  

        <build>  
            <plugins>  
                <plugin>  
                    <groupId>org.springframework.boot</groupId>  
                    <artifactId>spring-boot-maven-plugin</artifactId>  
                </plugin>  
            </plugins>  
        </build>  


    </project>  

創建個controller

package com.example.controller;  

    import org.springframework.web.bind.annotation.RequestMapping;  
    import org.springframework.web.bind.annotation.RestController;  

    /** 
     * Created by wuwf on 17/4/27. 
     * 
     */  
    @RestController  
    public class FirstController {  

        @RequestMapping("/first")  
        public Object first() {  
            return "first controller";  
        }  

        @RequestMapping("/doError")  
        public Object error() {  
            return 1 / 0;  
        }  
    }  

創建一個aspect切面類

    package com.example.aop;  

    import org.aspectj.lang.JoinPoint;  
    import org.aspectj.lang.ProceedingJoinPoint;  
    import org.aspectj.lang.annotation.*;  
    import org.springframework.stereotype.Component;  
    import org.springframework.web.context.request.RequestContextHolder;  
    import org.springframework.web.context.request.ServletRequestAttributes;  

    import javax.servlet.http.HttpServletRequest;  
    import java.util.Arrays;  

    /** 
     * Created by wuwf on 17/4/27. 
     * 日誌切面 
     */  
    @Aspect  
    @Component  
    public class LogAspect {  
        @Pointcut("execution(public * com.example.controller.*.*(..))")  
        public void webLog(){}  

        @Before("webLog()")  
        public void deBefore(JoinPoint joinPoint) throws Throwable {  
            // 接收到請求，記錄請求內容  
            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();  
            HttpServletRequest request = attributes.getRequest();  
            // 記錄下請求內容  
            System.out.println("URL : " + request.getRequestURL().toString());  
            System.out.println("HTTP_METHOD : " + request.getMethod());  
            System.out.println("IP : " + request.getRemoteAddr());  
            System.out.println("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());  
            System.out.println("ARGS : " + Arrays.toString(joinPoint.getArgs()));  

        }  

        @AfterReturning(returning = "ret", pointcut = "webLog()")  
        public void doAfterReturning(Object ret) throws Throwable {  
            // 處理完請求，返回內容  
            System.out.println("方法的返回值 : " + ret);  
        }  

        //後置異常通知  
        @AfterThrowing("webLog()")  
        public void throwss(JoinPoint jp){  
            System.out.println("方法異常時執行.....");  
        }  

        //後置最終通知,final增強，不管是拋出異常或者正常退出都會執行  
        @After("webLog()")  
        public void after(JoinPoint jp){  
            System.out.println("方法最後執行.....");  
        }  

        //環繞通知,環繞增強，相當於MethodInterceptor  
        @Around("webLog()")  
        public Object arround(ProceedingJoinPoint pjp) {  
            System.out.println("方法環繞start.....");  
            try {  
                Object o =  pjp.proceed();  
                System.out.println("方法環繞proceed，結果是 :" + o);  
                return o;  
            } catch (Throwable e) {  
                e.printStackTrace();  
                return null;  
            }  
        }  
    }  

啓動項目
模擬正常執行的情況，訪問http://localhost:8080/first，看控制檯結果：

方法環繞start…..
URL : http://localhost:8080/first
HTTP_METHOD : GET
IP : 0:0:0:0:0:0:0:1
CLASS_METHOD : com.example.controller.FirstController.first
ARGS : []
方法環繞proceed，結果是 :first controller
方法最後執行…..
方法的返回值 : first controller
/******************分割線******************/
模擬出現異常時的情況，訪問http://localhost:8080/doError，看控制檯結果：
方法環繞start…..
URL : http://localhost:8080/doError
HTTP_METHOD : GET
IP : 0:0:0:0:0:0:0:1
CLASS_METHOD : com.example.controller.FirstController.error
ARGS : []
java.lang.ArithmeticException: / by zero
……
方法最後執行…..
方法的返回值 : null
/******************分割線******************/
通過上面的簡單的例子，可以看到aop的執行順序。知道了順序後，就可以在相應的位置做切面處理了。

二： 切面方法說明

@Aspect
作用是把當前類標識爲一個切面供容器讀取
@Before
標識一個前置增強方法，相當於BeforeAdvice的功能
@AfterReturning
後置增強，相當於AfterReturningAdvice，方法退出時執行
@AfterThrowing
異常拋出增強，相當於ThrowsAdvice
@After
final增強，不管是拋出異常或者正常退出都會執行
@Around
環繞增強，相當於MethodInterceptor
/******************分割線******************/
各方法參數說明：
除了@Around外，每個方法裏都可以加或者不加參數JoinPoint，如果有用JoinPoint的地方就加，不加也可以，JoinPoint裏包含了類名、被切面的方法名，參數等屬性，可供讀取使用。@Around參數必須爲ProceedingJoinPoint，pjp.proceed相應於執行被切面的方法。@AfterReturning方法裏，可以加returning = “XXX”，XXX即爲在controller裏方法的返回值，本例中的返回值是“first controller”。@AfterThrowing方法裏，可以加throwing = “XXX”，供讀取異常信息，如本例中可以改爲：

    //後置異常通知  
   @AfterThrowing(throwing = "ex", pointcut = "webLog()")  
   public void throwss(JoinPoint jp, Exception ex){  
      System.out.println("方法異常時執行.....");  
    }  

一般常用的有before和afterReturn組合，或者單獨使用Around，即可獲取方法開始前和結束後的切面。

三：關於切面PointCut的切入點

execution切點函數

execution函數用於匹配方法執行的連接點，語法爲：
execution(方法修飾符(可選) 返回類型 方法名 參數 異常模式(可選))
參數部分允許使用通配符：
* 匹配任意字符，但只能匹配一個元素
.. 匹配任意字符，可以匹配任意多個元素，表示類時，必須和*聯合使用
+ 必須跟在類名後面，如Horseman+，表示類本身和繼承或擴展指定類的所有類
參考：http://blog.csdn.net/autfish/article/details/51184405

除了execution()，Spring中還支持其他多個函數，這裏列出名稱和簡單介紹，以方便根據需要進行更詳細的查詢
@annotation()
表示標註了指定註解的目標類方法
例如 @annotation(org.springframework.transaction.annotation.Transactional) 表示標註了@Transactional的方法
args()
通過目標類方法的參數類型指定切點
例如 args(String) 表示有且僅有一個String型參數的方法
@args()
通過目標類參數的對象類型是否標註了指定註解指定切點
如 @args(org.springframework.stereotype.Service) 表示有且僅有一個標註了@Service的類參數的方法
within()
通過類名指定切點
如 with(examples.chap03.Horseman) 表示Horseman的所有方法
target()
通過類名指定，同時包含所有子類
如 target(examples.chap03.Horseman) 且Elephantman extends Horseman，則兩個類的所有方法都匹配
@within()
匹配標註了指定註解的類及其所有子類
如 @within(org.springframework.stereotype.Service) 給Horseman加上@Service標註，則Horseman和Elephantman 的所有方法都匹配
@target()
所有標註了指定註解的類
如 @target(org.springframework.stereotype.Service) 表示所有標註了@Service的類的所有方法
this()
大部分時候和target()相同，區別是this是在運行時生成代理類後，才判斷代理類與指定的對象類型是否匹配

/******************分割線******************/

邏輯運算符
表達式可由多個切點函數通過邏輯運算組成
&&
與操作，求交集，也可以寫成and
例如 execution(* chop(..)) && target(Horseman) 表示Horseman及其子類的chop方法
||
或操作，求並集，也可以寫成or
例如 execution(* chop(..)) || args(String) 表示名稱爲chop的方法或者有一個String型參數的方法
!
非操作，求反集，也可以寫成not
例如 execution(* chop(..)) and !args(String) 表示名稱爲chop的方法但是不能是隻有一個String型參數的方法

execution常用於匹配特定的方法，如update時怎麼處理，或者匹配某些類，如所有的controller類，是一種範圍較大的切面方式，多用於日誌或者事務處理等。
其他的幾個用法各有千秋，視情況而選擇。
以上標紅的比較常用。下面來看annotation的。

四：自定義註解

一般多用於某些特定的功能，比較零散的切面，譬如特定的某些方法需要處理，就可以單獨在方法上加註解切面。
我們來自定義一個註解：

package com.example.aop;  

    import java.lang.annotation.ElementType;  
    import java.lang.annotation.Retention;  
    import java.lang.annotation.RetentionPolicy;  
    import java.lang.annotation.Target;  

    /** 
     * Created by wuwf on 17/4/27. 
     */  
    @Target({ElementType.METHOD, ElementType.TYPE})  
    @Retention(RetentionPolicy.RUNTIME)  
    public @interface UserAccess {  
        String desc() default "無信息";  
    }  

註解裏提供了一個desc的方法，供被切面的地方傳參，如果不需要傳參可以不寫。

在Controller里加個方法

    @RequestMapping("/second")  
        @UserAccess(desc = "second")  
        public Object second() {  
            return "second controller";  
        }  

切面類：

    @RequestMapping("/second")  
        @UserAccess(desc = "second")  
        public Object second() {  
            return "second controller";  
        }  

主要看一下@Around註解這裏，如果需要獲取在controller註解中賦給UserAccess的desc裏的值，就需要這種寫法，這樣UserAccess參數就有值了。
/******************分割線******************/
啓動項目，訪問http://localhost:8080/second，看控制檯：

方法環繞start…..
URL : http://localhost:8080/second
HTTP_METHOD : GET
IP : 0:0:0:0:0:0:0:1
CLASS_METHOD : com.example.controller.FirstController.second
ARGS : []
second around:second
second before
方法環繞proceed，結果是 :second controller
方法最後執行…..
方法的返回值 : second controller
/******************分割線******************/
通知結果可以看到，兩個aop切面類都工作了，順序呢就是下面的

spring aop就是一個同心圓，要執行的方法爲圓心，最外層的order最小。從最外層按照AOP1、AOP2的順序依次執行doAround方法，doBefore方法。然後執行method方法，最後按照AOP2、AOP1的順序依次執行doAfter、doAfterReturn方法。也就是說對多個AOP來說，先before的，一定後after。
對於上面的例子就是，先外層的就是對所有controller的切面，內層就是自定義註解的。
那不同的切面，順序怎麼決定呢，尤其是同格式的切面處理，譬如兩個execution的情況，那spring就是隨機決定哪個在外哪個在內了。
所以大部分情況下，我們需要指定順序，最簡單的方式就是在Aspect切面類上加上@Order(1)註解即可，order越小最先執行，也就是位於最外層。像一些全局處理的就可以把order設小一點，具體到某個細節的就設大一點。