一、前言

眾所周知，spring最核心的兩個功能是aop和ioc，即面向切面和控制反轉。本文會講一講SpringBoot如何使用AOP實現面向切面的過程原理。

二、何為aop

​ aop全稱Aspect Oriented Programming，面向切面，AOP主要實現的目的是針對業務處理過程中的切面進行提取，它所面對的是處理過程中的某個步驟或階段，以獲得邏輯過程中各部分之間低耦合性的隔離效果。其與設計模式完成的任務差不多，是提供另一種角度來思考程式的結構，來彌補面向物件程式設計的不足。

　　通俗點講就是提供一個為一個業務實現提供切面注入的機制，通過這種方式，在業務執行中將定義好的切面通過切入點繫結到業務中，以實現將一些特殊的邏輯繫結到此業務中。

　　舉個栗子，專案中有記錄操作日誌的需求、或者流程變更是記錄變更履歷，無非就是插表操作，很簡單的一個save操作，都是一些記錄日誌或者其他輔助性的程式碼。一遍又一遍的重寫和呼叫。不僅浪費了時間，又將專案變得更加的冗餘，實在得不償失。

　　所以就需要面向切面aop就出場了。

三、aop相關名詞

​ 要理解SpringBoot整合aop的實現，就必須先對面向切面實現的一些aop的名稱有所瞭解，不然也是雲裡霧裡。

• 切面（Aspect）：一個關注點的模組化。以註解@Aspect的形式放在類上方，宣告一個切面。

• 連線點（Joinpoint）：在程式執行過程中某個特定的點，比如某方法呼叫的時候或者處理異常的時候都可以是連線點。

• 通知（Advice）：通知增強，需要完成的工作叫做通知，就是你寫的業務邏輯中需要比如事務、日誌等先定義好，然後需要的地方再去用。

  主要包括5個註解：Before，After，AfterReturning，AfterThrowing，Around。

  @Before：在切點方法之前執行。

  @After：在切點方法之後執行

  @AfterReturning：切點方法返回後執行

  @AfterThrowing：切點方法拋異常執行

  @Around：屬於環繞增強，能控制切點執行前，執行後，用這個註解後，程式拋異常，會影響@AfterThrowing這個註解

• 切點（Pointcut）：其實就是篩選出的連線點，匹配連線點的斷言，一個類中的所有方法都是連線點，但又不全需要，會篩選出某些作為連線點做為切點。如果說通知定義了切面的動作或者執行時機的話，切點則定義了執行的地點。切入點表示式如何和連線點匹配是AOP的核心：Spring預設使用AspectJ切入點語法。

• 引入（Introduction）：在不改變一個現有類程式碼的情況下，為該類新增屬性和方法,可以在無需修改現有類的前提下，讓它們具有新的行為和狀態。其實就是把切面（也就是新方法屬性：通知定義的）用到目標類中去。

• 目標物件（Target Object）：被一個或者多個切面所通知的物件。也被稱做被通知（adviced）物件。既然Spring AOP是通過執行時代理實現的，這個物件永遠是一個被代理（proxied）物件。

• AOP代理（AOP Proxy）：AOP框架建立的物件，用來實現切面契約（例如通知方法執行等等）。在Spring中，AOP代理可以是JDK動態代理或者CGLIB代理。

• 織入（Weaving）：把切面連線到其它的應用程式型別或者物件上，並建立一個被通知的物件。這些可以在編譯時（例如使用AspectJ編譯器），類載入時和執行時完成。Spring和其他純Java AOP框架一樣，在執行時完成織入。

​ 其中重要的名詞有：切面（Aspect），切入點（Pointcut）

四、程式碼實現

以處理業務邏輯日誌為例，新增日誌處理的面向切面處理。

1.新增maven依賴

<!--引入AOP依賴-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
    <version>2.1.6.RELEASE</version>
</dependency>

2.新增系統日誌註解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SysLog {
    String value() default "";
}

3.新增系統日誌實體類

@Data
public class SysLogEntity {
    private String className;
    private String methodName;
    private String params;
    private Long exeuTime;
    private String remark;
    private String createDate;
}

4.新增Service邏輯處理層

@Slf4j
@Service
public class SysLogService {
    public boolean save(SysLogEntity sysLogEntity){
        // 這裡就不做具體實現了
        log.info(sysLogEntity.getParams());
        return true;
    }
}

此處用了@Slf4j日誌註解

相當於private final Logger logger = LoggerFactory.getLogger(XXX.class);

簡化了程式碼，怎麼簡化怎麼來~

這裡主要是研究aop的怎麼實現的，就不具體寫Service層的程式碼了。

5.Controller層

@RestController
@RequestMapping("/aop")
public class AopController {
    @SysLog("測試")
    @GetMapping("/test")
    public String test(@RequestParam("name") String name, @RequestParam("age") int age){
        return name + ", " + age;
    }
}

6.切面處理

來咯來咯，關鍵處理來咯，客官下面的程式碼

首先在類上方宣告

@Aspect //使用@Aspect
@Component

呼叫Service服務

@Autowired
private SysLogService sysLogService;

新增切點表示式@Pointcut

/**
 * 這裡我們使用註解的形式
 * 當然，我們也可以通過切點表示式直接指定需要攔截的package,需要攔截的class 以及 method
 * 切點表示式:   execution(...)
 */
@Pointcut("@annotation(com.niaobulashi.anno.SysLog)")
public void logPointCut() {}

新增環繞通知@Around

@Around("logPointCut()")
    public Object around(ProceedingJoinPoint point) throws Throwable {
        long beginTime = System.currentTimeMillis();
        Object result = point.proceed();
        long time = System.currentTimeMillis() - beginTime;
        try {
            //實現儲存日誌邏輯
            saveLog(point, time);
        } catch (Exception e) {
            
        }
        return result;
    }

實現儲存日誌邏輯saveLog

private void saveLog(ProceedingJoinPoint joinPoint, long time) {

    // 獲取方法的關鍵資訊，類，包
    MethodSignature signature = (MethodSignature) joinPoint.getSignature();
    Method method = signature.getMethod();
    SysLogEntity sysLogEntity = new SysLogEntity();
    sysLogEntity.setExeuTime(time);
    SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd hh:mm:ss");
    sysLogEntity.setCreateDate(dateFormat.format(new Date()));
    SysLog sysLog = method.getAnnotation(SysLog.class);
    if(sysLog != null) {
        //註解上的描述
        sysLogEntity.setRemark(sysLog.value());
    }
    //請求的 類名、方法名
    String className = joinPoint.getTarget().getClass().getName();
    String methodName = signature.getName();
    sysLogEntity.setClassName(className);
    sysLogEntity.setMethodName(methodName);
    //請求的引數
    Object[] args = joinPoint.getArgs();
    try {
        List<String> list = new ArrayList<String>();
        for (Object o : args) {
            list.add(o.toString());
        }
        sysLogEntity.setParams(list.toString());
    } catch (Exception e){

    }
    sysLogService.save(sysLogEntity);
}

MethodSignature主要實現的是返回值類，方法名和形式引數

五、測試

通過傳送get請求：127.0.0.1:8081/aop/test?name=Tom&age=18

同時以debug模式執行專案，打點檢視引數

可以看到MethodSignature中的引數

以及sysLogEntity賦值的各個引數。

六、總結

1、橫切關注點
對哪些方法進行攔截，攔截後怎麼處理，這些關注點稱之為橫切關注點

2、切面（aspect）->（通知+切點）
類是對物體特徵的抽象，切面就是對橫切關注點的抽象。
通知+切點
意思就是所有要被應用到增強（advice）程式碼的地方。(包括方法的方位資訊)

3、連線點（joinpoint）->（被攔截的方法）
被攔截到的點，因為Spring只支援方法型別的連線點，所以在Spring中連線點指的就是被攔截的方法，實際上連線點還可以是欄位或者構造器

4、切入點（pointcut）->（描述攔截那些方法的部分）
對連線點進行攔截的定義

5、通知（advice）->（攔截後執行自己業務邏輯的那些部分）
所謂通知指的就是指攔截到連線點之後要執行的程式碼，通知分為前置、後置、異常、最終、環繞通知五類
這玩意也叫 增強

在邏輯層次上包括了我們抽取的公共邏輯和方位資訊。因為Spring只能方法級別的應用AOP,也就是我們常見的before,after,after-returning,after-throwing,around五種，意思就是在方法呼叫前後，異常時候執行我這段公共邏輯唄。

推薦閱讀

【spring-boot】spring aop 面向切面程式設計初接觸

Spring Boot中使用AOP統一處理Web請求日