一文講解到底什麼是“SpringBoot使用AOP”

AOP SpringBoot · 發表 2018-09-20 11:15:02

摘要： AOP簡介 AOP可能對於廣大開發者耳熟能詳，它是Aspect Oriented Programming的縮寫，翻譯成中文就是：面向切面程式設計。這個可能是面試中經常提到的問題，同時它也是Spring框架中一個重大的特性，AOP主要實現的目的是針對業務處理過程中的切面進行提...

AOP簡介

AOP可能對於廣大開發者耳熟能詳，它是Aspect Oriented Programming的縮寫，翻譯成中文就是：面向切面程式設計。這個可能是面試中經常提到的問題，同時它也是Spring框架中一個重大的特性，AOP主要實現的目的是針對業務處理過程中的切面進行提取，它所面對的是處理過程中的某個步驟或階段，以獲得邏輯過程中各部分之間低耦合性的隔離效果，對於我們開發中最常見的可能就是日誌記錄，事務處理，異常處理等等。

SpringBoot中使用AOP

接下來介紹SpringBoot專案中如何運用AOP。

新建專案

新建一個SpringBoot專案，在pom檔案中加入AOP依賴，完整程式碼如下：

<?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.dalaoyang</groupId>
 <artifactId>springboot_aop</artifactId>
 <version>0.0.1-SNAPSHOT</version>
 <packaging>jar</packaging>
 <name>springboot_aop</name>
 <description>springboot_aop</description>
 <parent>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-parent</artifactId>
 <version>2.0.4.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-web</artifactId>
 </dependency>
 <dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-aop</artifactId>
 </dependency>
 <dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-devtools</artifactId>
 <scope>runtime</scope>
 </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>

建立切面

一直接使用切面

新建一個日誌切面類，假設我們需要一個類來列印進入方法或方法執行後需要列印的日誌。

新建一個切面類

新建類LogAspect，完整程式碼如下：

package com.dalaoyang.aspect;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.springframework.stereotype.Component;
import org.aspectj.lang.annotation.*;
@Aspect
@Component
public class LogAspect {
 @Pointcut("execution(public * com.dalaoyang.controller.*.*(..))")
 public void LogAspect(){}
 @Before("LogAspect()")
 public void doBefore(JoinPoint joinPoint){
 System.out.println("doBefore");
 }
 @After("LogAspect()")
 public void doAfter(JoinPoint joinPoint){
 System.out.println("doAfter");
 }
 @AfterReturning("LogAspect()")
 public void doAfterReturning(JoinPoint joinPoint){
 System.out.println("doAfterReturning");
 }
 @AfterThrowing("LogAspect()")
 public void deAfterThrowing(JoinPoint joinPoint){
 System.out.println("deAfterThrowing");
 }
 @Around("LogAspect()")
 public Object deAround(ProceedingJoinPoint joinPoint) throws Throwable{
 System.out.println("deAround");
 return joinPoint.proceed();
 }
}

其中：

@Aspect 表明是一個切面類

@Component 將當前類注入到Spring容器內

@Pointcut 切入點，其中execution用於使用切面的連線點。使用方法：execution(方法修飾符(可選) 返回型別方法名引數異常模式(可選)) ，可以使用萬用字元匹配字元，*可以匹配任意字元。

@Before 在方法前執行

@After 在方法後執行

@AfterReturning 在方法執行後返回一個結果後執行

@AfterThrowing 在方法執行過程中丟擲異常的時候執行

@Around 環繞通知，就是可以在執行前後都使用，這個方法引數必須為ProceedingJoinPoint，proceed()方法就是被切面的方法，上面四個方法可以使用JoinPoint，JoinPoint包含了類名，被切面的方法名，引數等資訊。

二利用自定義註解使用AOP

新建自定義註解

新建自定義註解，新建註解與新建介面類似，將interface改為@interface即可。

package com.dalaoyang.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface DoneTime {
 String param() default "";
}

建立自定義註解對應切面

建立自定義註解對應切面，與上一中情況的切面類似，這裡就不在贅述了，程式碼如下:

package com.dalaoyang.aspect;
import com.dalaoyang.annotation.DoneTime;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;
import java.util.Date;
@Aspect
@Component
public class DoneTimeAspect {
 @Around("@annotation(doneTime)")
 public Object around(ProceedingJoinPoint joinPoint, DoneTime doneTime) throws Throwable {
 System.out.println("方法開始時間是:"+new Date());
 Object o = joinPoint.proceed();
 System.out.println("方法結束時間是:"+new Date()) ;
 return o;
 }
}

建立Controller測試

建立一個IndexController進行測試，其實就是兩個普通的Web請求方法，其中index使用了自定義註解，index2沒有使用自定義註解，完整程式碼如下：

package com.dalaoyang.controller;
import com.dalaoyang.annotation.DoneTime;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class IndexController {
 @GetMapping("/index")
 @DoneTime(param = "IndexController")
 public String index(){
 System.out.println("方法執行");
 return "hello dalaoyang";
 }
 @GetMapping("/index2")
 public String index2(){
 System.out.println("方法2執行");
 return "hello dalaoyang";
 }
}

總結

本文只是簡單介紹一下SpringBoot使用Spring AOP，當然它可能還有其他使用方法，具體的情況需要根據我們實際情況來使用。

寫在最後：歡迎留言討論，加關注，持續更新！