1. 程式人生 > >Spring AOP 基於AspectJ

Spring AOP 基於AspectJ

簡介

AspectJ是一個基於Java語言的AOP框架,Spring2.0以後新增了對AspectJ切點表示式支援。因為Spring1.0的時候Aspectj還未出現;

AspectJ1.5中新增了對註解的支援,允許直接在Bean類中定義切面。新版本的Spring框架建
議我們都使用AspectJ方式來開發AOP,並提供了非常靈活且強大的切點表示式 ;

當然無論使用Spring自己的AOP還是AspectJ相關的概念都是相同的;

註解配置

依賴匯入:

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-aspects</artifactId>
    <version>5.2.2.RELEASE</version>
</dependency>

通知型別

@AspectJ提供的通知型別:

  1. @Before 前置通知 在原始方法執行前執行

  2. @AfterReturning 後置通知 在原始方法執行前執行

  3. @Around 環繞通知 徹底攔截原始方法的執行,執行前後都可以增加邏輯,也可以不執行原始方法

  4. @AfterThrowing丟擲通知,執行原始方法出現異常時執行

  5. @After 最終final通知,不管是否異常,原始方法呼叫後都會執行

  6. @DeclareParents 引介通知,相當於IntroductionInterceptor (瞭解即可)

定義切點

通過execution函式來定義切點

語法:execution(訪問修飾符 返回型別 方法名 引數 異常)

表示式示例:

匹配所有類public方法:execution(public * *(..))第一個*表示返回值 ..表示任意個任意型別引數

匹配指定包下所有方法: execution(* cn.xxx.dao.*(..)) 第一個想*表示忽略許可權和返回值型別

匹配指定包下所有方法:execution(* cn.xxx.dao..*(..))包含子包

匹配指定類所有方法: execution(* cn.xxx.service.UserService.*(..))

匹配實現特定介面所有類方法 : execution(* cn.xxx.dao.GenericDAO+.*(..))

匹配所有save開頭的方法: execution(* save*(..))

前置通知

pom依賴:

    <dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>5.2.2.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aspects</artifactId>
            <version>5.2.2.RELEASE</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.springframework/spring-test -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-test</artifactId>
            <version>5.2.2.RELEASE</version>
            <scope>test</scope>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.springframework/spring-test -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-test</artifactId>
            <version>5.2.2.RELEASE</version>
            <scope>test</scope>
        </dependency>
        <!-- https://mvnrepository.com/artifact/junit/junit -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

xml需要新增aop名稱空間及xsd:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
                           http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">
<!--    啟用aspectj    -->
    <aop:aspectj-autoproxy/>
<!--    目標-->
    <bean id="personDao" class="com.yh.demo1.PersonDao"/>
<!--    切面-->
    <bean class="com.yh.demo1.MyAspect"/>
</beans>

test:

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("classpath:applicationContext.xml")
public class Test1 {
    @Autowired
    PersonDao personDao;

    @Test
    public void test(){
        personDao.delete();
        personDao.update();
    }
}

切面類:

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;

@Aspect
public class MyAspect {
      //表示PersonDao下所有方法都作為切點
    @Before(value = "execution(* com.yh.demo1.PersonDao.*(..))")
    public void beforeAdvice(){
        System.out.println("before code run.....");
    }
}

當我們需要獲取切點資訊(被增強的程式碼)時,可以在通知新增引數,想下面這樣

@Aspect
public class MyAspect {
    @Before(value = "execution(* com.yh.demo1.PersonDao.*(..))")
    public void beforeAdvice2(JoinPoint point){
        System.out.println("before code run2....." + point);
    }
}

後置通知:

//當需要獲取原始方法的返回值時可以在註解中新增returning引數來指定引數名  Aspectj會自動將返回值放到引數中
@AfterReturning(value = "execution(* com.yh.demo1.PersonDao.delete(..))",returning = "result")
public void afterAdvice(Object result){
    System.out.println("刪除方法執行後 .....   返回值為:"+ result);
}

後置通知可以獲取目標方法的返回值

環繞通知:

@Around(value = "execution(* com.yh.demo1.PersonDao.insert(..))")
public void aroundAdvice(ProceedingJoinPoint point) throws Throwable {
    //code............
    System.out.println("環繞前置..");

    //執行原始方法 __當需要獲取返回值時可以宣告變數接收
    Object result = point.proceed();
    System.out.println("原始方法返回值: "+result);
    //code............
    System.out.println("環繞後置..");
}

環繞通知與其他通知最大的區別在於環繞通知可以控制是否呼叫原始方法

注意:引數型別必須為ProceedingJoinPoint,否則 無法執行原始方法,

異常通知

@AfterThrowing(value = "execution(* com.yh.demo1.PersonDao.save(..))",throwing = "e")
public void exceptionHandler(JoinPoint point,Exception e){
    System.out.println(point + " 方法出現"+e.getMessage()+"異常");
}

當方法中出現時才會執行該通知,若需要獲取異常資訊,可在註解中新增throwing指定引數名稱

我們可以使用環繞+異常通知來處理資料庫事務,在環繞中開啟事務以及提交事務,異常通知中回滾事務,當然Spring已經對事務進行了封裝不需要自己寫

最終通知

@After(value = "execution(* *delete(..))")
public void afterRun(){
    System.out.println("最終");
}

最終通知叫做after 即呼叫原始方法之後執行無論原始方法中是否出現異常

而後置叫做afterReturning表示在成功返回後才會執行執行

帶有邏輯符的表示式:

在表示式中可以使使用者邏輯操運算子,與&&||!

示例:

/*
execution(* cn.xxx.service.UserDao.insert(..))||execution(* cn.xxx.service.UserDao.delete(..))

execution(* cn.xxx.service.UserDao.*nsert(..))&&execution(* cn.xxx.service.UserDao.inser*(..))

!execution(* cn.xxx.service.UserDao.insert(..))
*/

切點命名

假設有多個通知應用在同一個切點上時,我們需要重複編寫execution表示式,且後續要修改切點時則多個通知都需要修改,維護起來非常麻煩,我們可以通過給切點指定名稱從而完成對切點的重複使用和統一操作,以提高開發維護效率;

//定義命名切點  方法名稱即切點名稱
@Pointcut(value = "execution(* com.yh.demo1.PersonDao.save(..))")
private void savePointcut(){}

@Pointcut(value = "execution(* com.yh.demo1.PersonDao.delete(..))")
private void deletePointcut(){}

多個通知應用到同一個切點:

//使用命名切點
@Before(value = "savePointcut()")
public void beforeAdvice(){
    System.out.println("before code run.....");
}
//使用命名切點
@Around(value = "savePointcut()")
public void beforeAdvice2(ProceedingJoinPoint point) throws Throwable {
    System.out.println("環繞前");
    point.proceed();
    System.out.println("環繞後");

一個通知應用到多個切點

//同一個通知對應多個切點
@After(value = "savePointcut()||deletePointcut()")
public void afterAdvice(){
    System.out.println("after code run.....");
}

XML配置

XML配置所需的jar 以及各個物件之間的依賴關以及表示式的寫法都是一樣的,僅僅是換種方式來寫而已;

xml:

        <!--目標-->
    <bean id="studentDao" class="com.yh.demo2.StudentDao"/>
        <!--通知-->
    <bean id="advices" class="com.yh.demo2.XMLAdvice"/>

        <!--織入資訊-->
    <aop:config>
                <!--切點定義-->
        <aop:pointcut id="select" expression="execution(* com.yh.demo2.StudentDao.select(..))"/>
                <!--切面定義-->
        <aop:aspect ref="advices">
            <aop:before method="before" pointcut-ref="select"/>
            <aop:after-returning method="afterReturning" pointcut-ref="select" returning="result"/>
            <aop:after method="after" pointcut-ref="select" />
            <aop:after-throwing method="exception" pointcut-ref="select" throwing="e"/>
            <aop:around method="around" pointcut-ref="select"/>
        </aop:aspect>
      
        <!--入侵式通知 即通知需要實現指定介面 兩種不能同時使用 -->
        <aop:advisor advice-ref="advice2" pointcut-ref="select"/>
    </aop:config>
  <!--入侵式通知Bean-->
  <bean id="advice2" class="com.yh.demo2.XMLAdvice2"/>

通知類:

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.JoinPoint;

public class XMLAdvice {
    public void before(JoinPoint pointcut){ System.out.println("前置通知 切點:"+pointcut); }

    public void afterReturning(JoinPoint point,Object result){
        System.out.println("後置通知 切點:"+point);
    }

    public void after(JoinPoint point){ System.out.println("最終通知 切點:"+point); }

    public void exception(JoinPoint point,Throwable e){
        System.out.println("異常通知: " + e+"切點:"+point);
    }

    public void around(ProceedingJoinPoint point) throws Throwable {
        System.out.println("環繞前");
        point.proceed();
        System.out.println("環繞後");
    }
}

你會發現 ,無論是XML還是註解都不需要手動指定代理,以及目標物件,Aspectj會從切點中獲取目標物件資訊並自動建立代理;

AspectJ是目前更流行的方式,具體採用XML還是註解需要根據專案具體情況,小組協作開發推薦x