SpringBoot切面Aop的demo簡單講解

前言

本篇文章主要介紹的是SpringBoot切面Aop的demo簡單講解。

SpringBoot Aop

說明：如果想直接獲取工程那麼可以直接跳到底部，通過連結下載工程程式碼。

切面(Aop)

一、概念

AOP（Aspect OrientedProgramming）：面向切面程式設計，面向切面程式設計（也叫面向方面程式設計），是目前軟體開發中的一個熱點，也是Spring框架中的一個重要內容。利用AOP可以對業務邏輯的各個部分進行隔離，從而使得業務邏輯各部分之間的耦合度降低，提高程式的可重用性，同時提高了開發的效率。

二、用途

日誌記錄，效能統計，安全控制，許可權管理，事務處理，異常處理，資源池管理。

三、詳解

1.切面（Aspect）:
官方的抽象定義為“一個關注點的模組化，這個關注點可能會橫切多個物件”，在本例中，“切面”就是類TestAspect所關注的具體行為，例如：AServiceImpl.barA()的呼叫就是切面TestAspect所關注的行為之一。“切面”在ApplicationContext中aop:aspect來配置。

2.連線點（Joinpoint）:
程式執行過程中的某一行為，例如，AServiceImpl.barA()的呼叫或者BServiceImpl.barB(String _msg, int _type)丟擲異常等行為。

3.通知（Advice）:
“切面”對於某個“連線點”所產生的動作，例如，TestAspect中對com.spring.service包下所有類的方法進行日誌記錄的動作就是一個Advice。其中，一個“切面”可以包含多個“Advice”，例如TestAspect。Advice共有如下5種型別：

• A 前置通知（Before advice） ：在某連線點（JoinPoint）之前執行的通知，但這個通知不能阻止連線點前的執行。xml中在aop:aspect裡面使用aop:before元素進行宣告；例如，TestAspect中的doBefore方法。註解中使用@Before宣告；例如，TestAnnotationAspect中的doBefore方法。
• B 後通知（After advice）：當某連線點退出的時候執行的通知（不論是正常返回還是異常退出）。xml中在aop:aspect裡面使用aop:after元素進行宣告。例如，TestAspect中的doAfter方法，所以AOPTest中呼叫BServiceImpl.barB丟擲異常時，doAfter方法仍然執行。註解中使用@After宣告。
• C 返回後通知（After return advice）：在某連線點正常完成後執行的通知，不包括丟擲異常的情況。xml中在aop:aspect裡面使用元素進行宣告。註解中使用@AfterReturning宣告；
• D 環繞通知（Around advice） ：包圍一個連線點的通知，類似Web中Servlet規範中的Filter的doFilter方法。可以在方法的呼叫前後完成自定義的行為，也可以選擇不執行。xml中在aop:aspect裡面使用aop:around元素進行宣告。例如，TestAspect中的doAround方法。註解中使用@Around宣告。
• E 丟擲異常後通知（After throwing advice） ： 在方法丟擲異常退出時執行的通知。xml中在aop:aspect裡面使用aop:after-throwing元素進行宣告。例如，TestAspect中的doThrowing方法。註解中使用@AfterThrowing宣告。
• 通知執行順序：前置通知→環繞通知連線點之前→連線點執行→環繞通知連線點之後→返回通知→後通知 →(如果發生異常)異常通知→後通知。

4.切入點（Pointcut）
匹配連線點的斷言，在AOP中通知和一個切入點表示式關聯。例如，TestAspect中的所有通知所關注的連線點，都由切入點表示式execution(* com.spring.service..(..))來決定。

注:以上的理論知識參考:https://www.cnblogs.com/yepei/p/4735298.html

開發準備

環境要求

JDK：1.8

SpringBoot：2.2.6.RELEASE

首先還是Maven的相關依賴，基本和普通springboot專案一樣，就是多了spring-boot-starter-aop這jar的依賴。

pom.xml檔案如下:

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

<parent>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-parent</artifactId>
	<version>2.2.6.RELEASE</version>
	<relativePath/>
</parent>

<dependencies>
	<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>
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-aop</artifactId>
	</dependency>
	<dependency>
		<groupId>com.alibaba</groupId>
		<artifactId>fastjson</artifactId>
		<version>1.2.68</version>
	</dependency>
     <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <optional>true</optional>
        <scope>test</scope>
	</dependency>
</dependencies>

application.properties的檔案的配置:

banner.charset=UTF-8
server.tomcat.uri-encoding=UTF-8
spring.http.encoding.charset=UTF-8
spring.http.encoding.enabled=true
spring.http.encoding.force=true
spring.messages.encoding=UTF-8
spring.application.name=springboot-aspect
server.port=8180

程式碼編寫

SpringBoot在使用切面的時候，只需要在自定義的一個切面類中加上 @Aspect 註解進行宣告，然後在自定義切面的類方法中加上對應的註解即可。
比如這裡的示例我們想做一個請求響應的加解密切面處理，業務層只需關心程式碼邏輯實現，而不用關心請求引數和響應引數的加解密實現。那麼首先我們需要自定義一個加解密的切面類，在該類新增@Aspect註解，然後在定義一個公共的切入點（Pointcut），指向需要處理的包，然後在定義一個前置通知(新增@Before註解)和後置通知(新增@AfterReturning)方法實現即可。

這裡我們就將切入點設定為控制層包裡所有的請求。

切入點程式碼示例:

	 	 @Pointcut("execution(public * com.pancm.web.*.*(..))")
  			  public void doOperation() {
   		 }

然後在定義一個前置通知，實現對請求引數的資料解密，這裡我們就用User這個實體類的名稱，對該資料進行解密。實際在運用是可以根據自身的情況來編寫。

前置通知程式碼示例:

	@Before("doOperation()")
    public void before(JoinPoint joinPoint) throws Throwable{
        Object[] objs = joinPoint.getArgs();
        for (Object obj : objs) {
            User user =(User) obj;
            System.out.println("前置通知接受的引數:"+user);
            String name =base64DeStr(user.getName());
            user.setName(name);
        }
    }

在編寫完前置通知的方法之後，我們在編寫後置通知的程式碼，這塊基本和前置通知的一樣，就是把返回的資料進行加密而已。

後置通知程式碼示例:

    @AfterReturning(returning = "object", pointcut = "doOperation()")
    public void doAfterReturning(Object object) {
        ResultBody resultBody = (ResultBody) object;
        String str =null;
        try {
             str=base64EnStr(resultBody.getResult());
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
        }
        resultBody.setResult(str);
        System.out.println("後通知響應的引數:"+resultBody);
    }

完整程式碼示例:

@Aspect
@Component
public class ParamAspect {

    @Pointcut("execution(public * com.pancm.web.*.*(..))")
    public void doOperation() {

    }


    @Before("doOperation()")
    public void before(JoinPoint joinPoint) throws Throwable{
        Object[] objs = joinPoint.getArgs();
        for (Object obj : objs) {
            User user =(User) obj;
            System.out.println("前置通知接受的引數:"+user);
            String name =base64DeStr(user.getName());
            user.setName(name);
        }
    }


    @AfterReturning(returning = "object", pointcut = "doOperation()")
    public void doAfterReturning(Object object) {
        ResultBody resultBody = (ResultBody) object;
        String str =null;
        try {
             str=base64EnStr(resultBody.getResult());
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
        }
        resultBody.setResult(str);
        System.out.println("前置通知響應的引數:"+resultBody);
    }


    public  String base64EnStr(String str) throws UnsupportedEncodingException {
        return Base64.getEncoder().encodeToString(str.getBytes("UTF-8"));
    }


    public static String base64DeStr(String encodeStr) throws UnsupportedEncodingException {
        byte[] decodeStr = Base64.getDecoder().decode(encodeStr);
        return new String(decodeStr, "UTF-8");
    }

實體類程式碼

	public class User {
		
		 private Long id;
	
		 private String name;
		 
		 private Integer age;
		 
		//getter 和 setter 略
		
	}

控制層z這塊的程式碼和普通的一樣，我們這裡只需簡單的做下處理即可，這裡為了方便理解，沒有編寫service層和dao的程式碼。:

** 控制層程式碼**

@RestController
@RequestMapping(value = "/api")
public class UserRestController {

    @GetMapping("/user")
    public ResultBody findByUser(User  user) {
        System.out.println("使用者查詢介面請求的引數:"+user);
        ResultBody resultBody = new ResultBody();
        List<User> userList =new ArrayList<>();
        User user2=new User();
        user2.setId(1L);
        user2.setName("xuwujing");
        user2.setAge(18);
        userList.add(user2);
        resultBody.setCode("0");
        resultBody.setResult(userList.toString());
        System.out.println("使用者查詢介面響應的引數:"+resultBody);
        return resultBody;
    }
}

App 入口

和普通的SpringBoot專案基本一樣！

程式碼如下:

	@SpringBootApplication
	public class AspectApp
	{
	    public static void main( String[] args )
	    {
			SpringApplication.run(AspectApp.class, args);
			System.out.println("Aspect啟動成功！");
	    }
	}

功能測試

編寫完程式碼之後，我們啟動程式，因為是Get請求，在瀏覽器或者使用Postman輸入地址都可以進行測試，需要注意的是這裡我們需要對name的值進行base64加密請求。

輸入:

http://localhost:8180/api/user?name=eHV3dWppbmc=

控制檯列印:

前置通知接受的引數:{"name":"eHV3dWppbmc="}
使用者查詢介面請求的引數:{"name":"xuwujing"}
使用者查詢介面響應的引數:{"code":"0","result":"[{"age":18,"id":1,"name":"xuwujing"}]"}
後通知響應的引數:{"code":"0","result":"W3siYWdlIjoxOCwiaWQiOjEsIm5hbWUiOiJ4dXd1amluZyJ9XQ=="}

請求響應引數:

{
"code": "0",
"message": null,
"result": "W3siYWdlIjoxOCwiaWQiOjEsIm5hbWUiOiJ4dXd1amluZyJ9XQ=="
}

示例圖:

其它

關於SpringBoot切面Aop的demo簡單講解的文章就講解到這裡了，如有不妥，歡迎指正！

專案地址

SpringBoot 的aop的專案工程地址:
https://github.com/xuwujing/springBoot-study/tree/master/springboot-aspect

SpringBoot整個集合的地址:
https://github.com/xuwujing/springBoot-study

SpringBoot整合系列的文章

• springBoot配置檔案的讀取以及過濾器和攔截器的使用

• SpringBoot的Restful風格的服務

• SpringBoot+Mybatis+ Druid+PageHelper實現多資料來源並分頁

• SpringBoot整合ElasticSearch實現多版本的相容

• SpringBoot整合Kafka和Storm

• SpringBoot整合Jsp和Thymeleaf

• SpringBoot整合Netty並使用Protobuf進行資料傳輸

• SpringBoot簡單打包部署

• SpringBoot整合Redis使用Restful風格實現CRUD功能

• SpringBoot優雅的全域性異常處理

• SpringBoot專案實現檔案上傳和郵件傳送

• SpringBoot整合Swagger和Actuator

• SpringBoot事物Transaction實戰講解教程

音樂推薦

翩若驚鴻，婉若游龍，榮曜秋菊，華茂春鬆。彷彿兮若輕雲之蔽月，飄飄兮若流風之迴雪。遠而望之，皎若太陽升朝霞；迫而察之，灼若芙蕖出淥波。--網易雲網友評論

原創不易，如果感覺不錯，希望給個推薦！您的支援是我寫作的最大動力！
版權宣告:
作者：虛無境
部落格園出處：http://www.cnblogs.com/xuwujing
CSDN出處：http://blog.csdn.net/qazwsxpcm　　　　
個人部落格出處：http://www.panchengming.com