Spring Boot2(六):使用Spring Boot整合AOP面向切麵編程

来源:https://www.cnblogs.com/niaobulashi/archive/2019/07/04/springboot-aop.html
-Advertisement-
Play Games

一、前言 眾所周知,spring最核心的兩個功能是aop和ioc,即面向切麵和控制反轉。本文會講一講SpringBoot如何使用AOP實現面向切麵的過程原理。 二、何為aop ​ aop全稱 ,面向切麵,AOP主要實現的目的是針對業務處理過程中的切麵進行提取,它所面對的是處理過程中的某個步驟或階段, ...


一、前言

眾所周知,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請求日誌


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 1. 為什麼是Spring Cloud Gateway 一句話,Spring Cloud已經放棄Netflix Zuul了。現在Spring Cloud中引用的還是Zuul 1.x版本,而這個版本是基於過濾器的,是阻塞IO,不支持長連接。Zuul 2.x版本跟1.x的架構大一樣,性能也有所提升。既然 ...
  • ​ 1.python的歷史 python2和python3的區別 python2 源碼不統一,重覆代碼 python 源碼統一,沒有重覆代碼 2004 Django框架的誕生 2.python是編程語言 3.python的種類 4.變數 變數定義的規則: 一個變數名在記憶體中只有一個。 5.常量 變數 ...
  • 一、Redis集群簡介 1、RedisCluster概念 Redis的分散式解決方案,在3.0版本後推出的方案,有效地解決了Redis分散式的需求,當一個服務宕機可以快速的切換到另外一個服務。redis cluster主要是針對海量數據+高併發+高可用的場景。 二、與SpringBoot2.0整合 ...
  • 下載地址 ...
  • 提交leetcode的時候遇到了問題,一直說訪問越界,但仔仔細細檢查n多遍,就是檢查不出來。 因為我用到了count全局變數,自加一來表明當前數組訪問的位置, 後來突然想到,是不是在運行的時候沒有對這個全局變數清零…… 果然,清零之後就可以了……已經3:47了,這裡先上代碼,明天再詳細說吧…… ch ...
  • 1.什麼是Redis? Redis(Remote Dictionary Server)遠程字典伺服器。 是完全開源免費的,用C語言編寫的,遵守BSD協議,是一個高性能的(key/value)分散式記憶體資料庫,基於記憶體運行並支持持久化的NoSql資料庫,是當前最熱門的NoSql資料庫之一,也被人們稱為 ...
  • 最近公司需要開發一個公司內部使用的快遞下單系統,給我的開發任務中有一個生成電子面單功能,為了下單時更方便,利用此功能使用快遞公司給我們的印表機直接列印出電子面單,剛接到這個任務時我想這應該很簡單,不就是做一個表格列印出來嗎,原本以為使用excel或者word等工具直接生成一個文檔,後來經理說不用ex ...
  • 0x00 問題重現 VS COde 打開 .go 文件會自動安裝插件,但是出現了一些工具的下載失敗。 換上全局代理也無法下載。 找了許多教程,但可能由於一些版本的問題,目錄已經變更了,導致吾卡在這裡許久。尤其是 github.com/stamblerre/gocode 。 0x01 解決 MacOS ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...