約定編程與Sping AOP

来源:https://www.cnblogs.com/ImBit/archive/2022/04/12/16100459.html
-Advertisement-
Play Games

一、約定編程 Spring AOP是一種約定流程的編程，咱們可以先通過動態代理模式的實現來理解Spring AOP的概念。 代理的邏輯很簡單，例如，當你需要採訪一名兒童時，首先需要經過他父母的同意，在一些問題上父母也許會替他回答，而對於另一些問題，也許父母覺得不太適合這個小孩會拒絕掉，顯然這時父母就 ...


 

一、約定編程

Spring AOP是一種約定流程的編程，咱們可以先通過動態代理模式的實現來理解Spring AOP的概念。

代理的邏輯很簡單，例如，當你需要採訪一名兒童時，首先需要經過他父母的同意，在一些問題上父母也許會替他回答，而對於另一些問題，也許父母覺得不太適合這個小孩會拒絕掉，顯然這時父母就是這名兒童的代理（proxy）了。通過代理可以增強或者控制對兒童這個真實對象（target）的訪問。

 

 

 

 

1. 首先實現攔截器介面Interceptor（自己定義的介面）

下麵代碼均使用spring boot 2.6.2

package com.springboot.chapter4.intercept;

import java.lang.reflect.InvocationTargetException;
import com.springboot.chapter4.invoke.Invocation;

public class MyInterceptor implements Interceptor {

    @Override
    public boolean before() {
        System.out.println("before ......");
        return true;
    }

    @Override
    public boolean useAround() {
        return true;
    }

    @Override
    public void after() {
        System.out.println("after ......");
    }

    @Override
    public Object around(Invocation invocation) 
           throws InvocationTargetException, IllegalAccessException 
   {
        System.out.println("around before ......");
        Object obj = invocation.proceed();
        System.out.println("around after ......");
        return obj;
    }

    @Override
    public void afterReturning() {
        System.out.println("afterReturning......");

    }

    @Override
    public void afterThrowing() {
        System.out.println("afterThrowing......");
    }

}

 

 

 

 2 創建代理對象

在Java的JDK中，提供了類Proxy的靜態方法——newProxyInstance，給予我們來生成一個代理對象（proxy）：

public static Object  newProxyInstance(ClassLoader classLoader, Class<?>[] interfaces, 
    InvocationHandler invocationHandler) throws IllegalArgumentException

它有3個參數：

•classLoader——類載入器；（被代理的類）

•interfaces——綁定的介面，也就是把代理對象綁定到哪些介面下，可以是多個；（被代理的類實現的介面列表）

•invocationHandler ——綁定代理對象邏輯實現。

這裡的invocationHandler是一個介面InvocationHandler對象，它定義了一個invoke方法，這個方法就是實現代理對象的約定流程

package com.springboot.chapter4.proxy;
package com.springboot.chapter4.proxy;
/**** imports ****/
public class ProxyBean implements InvocationHandler {

     private Object target = null;//代理對象
     private Interceptor interceptor = null;//攔截器

     public ProxyBean (Object target,Interceptor interceptor){
       this.target=target;
       this.interceptor=interceptor;
     }

     /**
     * 處理代理對象方法邏輯
     * @param proxy 代理對象
     * @param method 當前方法
     * @param args  運行參數
     * @return 方法調用結果
     * @throws Throwable 異常
     */
    @Override
    public Object invoke(Object proxy, Method method, Object[] args)  {
        // 異常標識
        boolean exceptionFlag = false;
        Invocation invocation = new Invocation(target, method, args);
        Object retObj = null; 
        try {
            if (this.interceptor.before()) {
                retObj = this.interceptor.around(invocation);
            } else {
                retObj = method.invoke(target, args);
            }
        } catch (Exception ex) {
            // 產生異常
            exceptionFlag = true;
        }
        this.interceptor.after();
        if (exceptionFlag) {
            this.interceptor.afterThrowing();
        } else {
            this.interceptor.afterReturning();
            return retObj;
        }
        return null;
    }

}

從上面例子可以看到：代理對象proxyBean定義了織入流程即invoke方法，將攔截器MyInterceptor包裝到目標對象tagert的method上。

 

3. 測試效果

/**
     * 綁定代理對象
     * @param target 被代理對象
     * @param interceptor 攔截器
     * @return 代理對象
     */
    public static Object getProxyObject(Object target, Interceptor interceptor) {
        ProxyBean proxyBean = new ProxyBean(target,interceptor);//proxyBean定義了織入流程即invoke方法
        // 生成代理對象
        Object proxy = Proxy.newProxyInstance(
                       target.getClass().getClassLoader(), 
                       target.getClass().getInterfaces(),
                       proxyBean);//proxyBean實現target對象的介面列表，實現方式為調用代理對象的方法時通過invoke（invoke可調用target對象的方法）調用target對象對應的方法。
        // 返回代理對象
        return proxy;
    }
private static void testProxy() {
    IHelloService helloService = new HelloServiceImpl();//被代理對象
    // 按約定獲取proxy
    IHelloService proxy = (IHelloService) getProxyObject(
        helloService, new MyInterceptor());
    proxy.sayHello("zhangsan");
    System.out.println("\n###############name is null!!#############\n");

    proxy.sayHello(null);
}

 

 

二、Spring AOP概念和術語

Spring AOP是一種基於方法的AOP，它只能應用於方法上。在Spring中可以使用多種方式配置AOP，因為Spring Boot採用註解方式，所以這裡只介紹使用@AspectJ註解的方式。AOP可以減少大量重覆的工作，最為典型的應用場景就是資料庫事務的管控。比如資料庫的打開和關閉以及事務的提交和回滾都有流程預設給你實現。換句話說，你都不需要完成它們，你需要完成的任務是編寫SQL這一步而已，然後織入流程中。

 

 

 

@Autowired
private UserDao = null;
......

@Transactional
public int inserUser(User user) {
    return userDao.insertUser(user);
}

這裡可以看到僅僅使用了一個註解@Transactional，表明該方法需要事務運行，沒有任何資料庫打開和關閉的代碼，也沒有事務回滾和提交的代碼，卻實現了資料庫資源的打開和關閉、事務的回滾和提交。

 

1.AOP術語：

•連接點（join point）：對應的是具體被攔截的對象，因為Spring只能支持方法，所以被攔截的對象往往就是指特定的方法，例如，我們前面提到的HelloServiceImpl的sayHello方法就是一個連接點，AOP將通過動態代理技術把它織入對應的流程中。

•切點（point cut）：有時候，我們的切麵不單單應用於單個方法，也可能是多個類的不同方法，這時，可以通過正則式和指示器的規則去定義，從而適配連接點。切點就是提供這樣一個功能的概念。

•通知（advice）：就是按照約定的流程下的方法，分為前置通知（beforeadvice）、後置通知（after advice）、環繞通知（around advice）、事後返回通知（afterReturning advice）和異常通知（afterThrowing advice），它會根據約定織入流程中，需要弄明白它們在流程中的順序和運行的條件。

•目標對象（target）：即被代理對象，例如，約定編程中的HelloServiceImpl實例就是一個目標對象，它被代理了。

•引入（introduction）：是指引入新的類和其方法，增強現有Bean的功能。

•織入（weaving）：它是一個通過動態代理技術，為原有服務對象生成代理對象，然後將與切點定義匹配的連接點攔截，並按約定將各類通知織入約定流程的過程。

•切麵（aspect）：是一個可以定義切點、各類通知和引入的內容，Spring AOP將通過它的信息來增強Bean的功能或者將對應的方法織入流程。

2.具體實現

2.1.添加maven依賴

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

 

2.2. 定義切麵

首先Spring是以@Aspect作為切麵聲明的，當以@Aspect作為註解時，Spring就會知道這是一個切麵，然後我們就可以通過各類註解（@Before、@After、@AfterReturning和@AfterThrowing）來定義各類的通知了。

package com.springboot.chapter4.aspect;
/**** imports ****/
@Component //註入到Spring IOC
@Aspect //定義切麵
public class MyAspect {

    //引入
    @DeclareParents(value= "co.springboot.chapter4.aspect.service.impl.UserServiceImpl",defaultImpl=UserValidatorImpl.class) 
    public UserValidator userValidator;

    //定義切點
    @Pointcut("execution(* com.springboot.chapter4.aspect.service.impl.UserServiceImpl.printUser(..))")
    public void pointCut() {
    }

    //無參模式
    @Before("pointCut()")
    public void before() {
        System.out.println("before ......");
    }

    //獲取參數模式
    //方式1：切點處加入對應的正則式
    //方式2：對於非環繞通知還可以使用一個連接點（JoinPoint）類型的參數，通過它也可以獲取參數
    //正則式pointCut() && args(user)中，pointCut()表示啟用原來定義切點的規則，並且約定將連接點（目標對象方法）名稱為user的參數傳遞進來。這裡要註意，JoinPoint類型的參數對於非環繞通知而言，Spring AOP會自動地把它傳遞到通知中；對於環繞通知而言，可以使用ProceedingJoinPoint類型的參數。
    @Before("pointCut() && args(user)") 
    public void beforeParam(JoinPoint point, User user) {
        Object[] args = point.getArgs();
        System.out.println("before ......");
    }  

    //環繞通知
    //註意：用環繞通知註解測試的時候總是不按順序執行，估計是Spring版本之間的差異留下的問題，這是在使用時需要註意的。所以在沒有必要的時候，應儘量不要使用環繞通知，它很強大，但是也很危險。
   @Around("pointCut()")
   public void around(ProceedingJoinPoint jp) throws Throwable {
       System.out.println("around before......");
       jp.proceed();//回調目標對象的原有方法

      System.out.println("around after......");
   }

    @After("pointCut()")
    public void after() {
        System.out.println("after ......");
    }

    @AfterReturning("pointCut()")
    public void afterReturning() {
        System.out.println("afterReturning ......");
    }

    @AfterThrowing("pointCut()")
    public void afterThrowing() {
        System.out.println("afterThrowing ......");
    }    
}

 

上述例子用到的基礎類如下

View Code

 

2.3 定義切點

execution(* com.springboot.chapter4.aspect.service.impl.UserServiceImpl.printUser(..))

•execution表示在執行的時候，攔截裡面的正則匹配的方法；　　
•* 表示任意返回類型的方法；

•com.springboot.chapter4.aspect.service.impl.UserServiceImpl 指定目標對象的全限定名稱；

•printUser指定目標對象的方法；

•(..)表示任意參數進行匹配。

 

2.4 使用@DeclareParents 定義引入

@DeclareParents，它的作用是在不侵入原有業務的前提上對原有的服務進行增強，它有兩個必須配置的屬性value和defaultImpl。

•value：指向你要增強功能的目標對象，這裡是要增強UserServiceImpl對象，因此可以看到配置為com.springboot.chapter4.aspect.service.impl.UserServiceImpl+。

•defaultImpl：引入增強功能的類，這裡配置為UserValidatorImpl，用來提供校驗用戶是否為空的功能。

 

 2.5 使用切麵的指示器

切麵中可以使用的指示器如下，比如上述例子中arg()獲取切點的參數值

 

 

 

 

3.測試效果

package com.springboot.chapter4.aspect.controller;
/**** imports ****/
// 定義控制器
@Controller
// 定義類請求路徑
@RequestMapping("/user")
public class UserController {

    // 註入用戶服務
    @Autowired
    private UserService userService = null;

    // 定義請求
    @RequestMapping("/print")
    // 轉換為JSON
    @ResponseBody
    public User printUser(Long id, String userName, String note) {
        User user = new User();
        user.setId(id);
        user.setUsername(userName);
        user.setNote(note);
        userService.printUser(user);// 若user=null，則執行afterthrowing方法

        //測試引入
        UserValidator userValidator = (UserValidator)userService;
        if (userValidator.validate(user)) {
            userService.printUser(user);
        }
 
        return user;// 加入斷點
    }
}

 

3.1未引入效果

before ......
id =1 username =user_name_1 note =2323
after ......
afterReturning ......

 

3.2引入效果

引入新的介面：UserValidator
around before......
before ......
id =1 username =user_name_1 note =2323
around after......
after ......
afterReturning ......

 

 

3.4 引入原理

這裡的newProxyInstance的第二個參數為一個對象數組，也就是說這裡生產代理對象時，Spring會把UserService和UserValidator兩個介面傳遞進去，讓代理對象下掛到這兩個介面下，這樣這個代理對象就能夠相互轉換並且使用它們的方法了。

Object proxy = Proxy.newProxyInstance(
    target.getClass().getClassLoader(), 
    target.getClass().getInterfaces(),
    proxyBean);

 

3.5 織入方式

上面我們都是採用介面（如UserService）+實現類（如UserServiceImpl）的模式，這是Spring推薦的方式，本書也遵循這樣的方式。但是對於是否擁有介面則不是Spring AOP的強制要求，對於動態代理的也有多種實現方式，我們之前談到的JDK只是其中的一種，業界比較流行的還有CGLIB、Javassist、ASM等。Spring採用了JDK和CGLIB，對於JDK而言，它是要求被代理的目標對象必須擁有介面，而對於CGLIB則不做要求。因此在預設的情況下，Spring會按照這樣的一條規則處理，即當你需要使用AOP的類擁有介面時，它會以JDK動態代理運行，否則以CGLIB運行。

不使用介面例子

......
// 定義控制器
@Controller
// 定義類請求路徑
@RequestMapping("/user")
public class UserController {
    // 使用非介面註入
    @Autowired
    private UserServiceImpl userService = null;

    // 定義請求
    @RequestMapping("/print")
    // 返回JSON
    @ResponseBody
    public User printUser(Long id, String userName, String note) {
        User user = new User();
        user.setId(id);
        user.setUsername(userName);
        user.setNote(note);
        userService.printUser(user);
        return user;// 加入斷點測試
     }
     ......
}

 

 此時Spring已經使用了CGLIB為我們生成代理對象，從而將切麵的內容織入對應的流程中。當使用介面時，用JDK為我們生成代理對象。

 

 

4. 多個切麵

Spring提供了一個註解@Order和一個介面Ordered，我們可以使用它們的任意一個指定切麵的順序。

......
@Aspect
@Order(1)
public class MyAspect1 {
......
}

//或者

......
@Aspect
public class MyAspect1 implements Ordered {
    // 指定順序
    @Override
    public int getOrder() {
        return 1;
    }
    ....
}

 

效果如下

MyAspect1 before ......
MyAspect2 before ......
MyAspect3 before ......
測試多個切麵順序
MyAspect3 after ......
MyAspect3 afterReturning ......
MyAspect2 after ......
MyAspect2 afterReturning ......
MyAspect1 after ......
MyAspect1 afterReturning ......

 

核心技術(http://www.localyc.com)
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 利用css來製作小三角形樣式
    1. 首先我們先準備一個盒子，讓盒子的寬高等於零，分別給定四個方向的邊框大小、實線、邊框顏色；讓邊框來充當內容。 1 <!DOCTYPE html> 2 <html lang="en"> 3 4 <head> 5 <meta charset="UTF-8"> 6 <meta http-equiv=" ...
  • 有關“Vue.js devtools插件Root點擊失效或不顯示問題”的解決方法
    才學習Vue.js，跟著b站視頻學習，視頻中用到了Vue.js的Chrome調試插件——Vue.js devtools，我下載的是官方正式版，其他版本不一定適合本教程。 首先，有關安裝Vue.js devtools不能用的問題，我在這裡簡單過一下，因為很容易百度到解決辦法。 Chrome安裝好Vue ...
  • node.js - http、模塊化、npm
    今天是node學習的第二天，其實越往後面學越感覺有點熟悉的味道了，光針對於node來說哈，為什麼呢，因為我之前學過一點雲計算的東西，當時感覺沒什麼用搞了下伺服器客戶端這些，沒想到這裡還能用一用，至少看到伺服器這些概念一點不陌生，看到npm一點不奇怪，我當時用的都是yum。 1. 我們今天先看到htt ...
  • 關於 display: inline-block; 中間有間隙的問題
    當我們給一個元素的一系列子元素設置display: inline-block; 時，會發現子元素之間存在間隙，如 <style> div { display: inline-block; width: 100px; height: 100px; background-color: yellow; } ...
  • 2022最新JavaScript+jQuery筆記
    初識JavaScript 瀏覽器執行js簡介 渲染引擎：解析css和html js引擎：編譯js代碼，逐行解析 <script type="null"> alert('我是編程語言，用來控制電腦網頁彈出你好'); alert('我是編程語言，用來控制電腦網頁彈出你好'); </script> js組 ...
  • vue開發環境搭建及配置（windows）
    一、安裝node.js 參考教程：https://www.runoob.com/nodejs/nodejs-install-setup.html 中文官網：https://nodejs.org/zh-cn/download/ 歷史版本：https://nodejs.org/zh-cn/downloa ...
  • 不藉助 Javascript，利用 SVG 快速構建馬賽克效果
    之前在公眾號轉發了好友 Vajoy 的一篇文章 -- 巧用 CSS 把圖片馬賽克風格化。 核心是利用了 CSS 中一個很有意思的屬性 -- image-rendering，它可以用於設置圖像縮放演算法。 何為 image-rendering？ CSS 屬性 image-rendering 用於設置圖像 ...
  • 行為型：二. 模板方法模式
    模板方法模式是什麼 模版方法模式是設計模式中的行為型的一種模式，它在基類中定義了一個演算法的框架，允許子類在不修改結構的情況下重寫演算法的特定步驟。 為什麼要用模板方法模式 模板方法將整個演算法轉換為一系列獨立的步驟，以便子類能對其進行擴展，同時還可讓超類中所定義的結構保持完整。或者當多個類的演算法步驟一致 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 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 ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類