Spring AOP AspectJ使用及配置過程解析

更新時(shí)間：2020年01月13日 14:35:14 投稿：yaominghui

這篇文章主要介紹了Spring AOP AspectJ使用及配置過程解析,文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下

AspectJ是一個(gè)基于Java語言的AOP框架，Spring2.0以后新增了對(duì)AspectJ切點(diǎn)表達(dá)式支持。因?yàn)镾pring1.0的時(shí)候Aspectj還未出現(xiàn);

AspectJ1.5中新增了對(duì)注解的支持，允許直接在Bean類中定義切面。新版本的Spring框架建
議我們都使用AspectJ方式來開發(fā)AOP,并提供了非常靈活且強(qiáng)大的切點(diǎn)表達(dá)式 ;

當(dāng)然無論使用Spring自己的AOP還是AspectJ相關(guān)的概念都是相同的;

注解配置

依賴導(dǎo)入:

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

通知類型

@AspectJ提供的通知類型:
@Before 前置通知在原始方法執(zhí)行前執(zhí)行
@AfterReturning 后置通知在原始方法執(zhí)行前執(zhí)行
@Around 環(huán)繞通知徹底攔截原始方法的執(zhí)行,執(zhí)行前后都可以增加邏輯,也可以不執(zhí)行原始方法
@AfterThrowing拋出通知，執(zhí)行原始方法出現(xiàn)異常時(shí)執(zhí)行
@After 最終final通知，不管是否異常,原始方法調(diào)用后都會(huì)執(zhí)行
@DeclareParents 引介通知，相當(dāng)于IntroductionInterceptor (了解即可)

定義切點(diǎn)

通過execution函數(shù)來定義切點(diǎn)

語法:execution(訪問修飾符返回類型方法名參數(shù) 異常)

表達(dá)式示例:

匹配所有類public方法:execution(public * *(..))第一個(gè)*表示返回值 ..表示任意個(gè)任意類型參數(shù)
匹配指定包下所有方法: execution(* cn.xxx.dao.*(..)) 第一個(gè)想*表示忽略權(quán)限和返回值類型
匹配指定包下所有方法:execution(* cn.xxx.dao..*(..))包含子包
匹配指定類所有方法: execution(* cn.xxx.service.UserService.*(..))
匹配實(shí)現(xiàn)特定接口所有類方法 : 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/>
<!--  目標(biāo)-->
  <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下所有方法都作為切點(diǎn)
  @Before(value = "execution(* com.yh.demo1.PersonDao.*(..))")
  public void beforeAdvice(){
    System.out.println("before code run.....");
  }
}

當(dāng)我們需要獲取切點(diǎn)信息(被增強(qiáng)的代碼)時(shí),可以在通知添加參數(shù),想下面這樣

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

后置通知:

//當(dāng)需要獲取原始方法的返回值時(shí)可以在注解中添加returning參數(shù)來指定參數(shù)名 Aspectj會(huì)自動(dòng)將返回值放到參數(shù)中
@AfterReturning(value = "execution(* com.yh.demo1.PersonDao.delete(..))",returning = "result")
public void afterAdvice(Object result){
  System.out.println("刪除方法執(zhí)行后 .....  返回值為:"+ result);
}

后置通知可以獲取目標(biāo)方法的返回值

環(huán)繞通知:

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

  //執(zhí)行原始方法 __當(dāng)需要獲取返回值時(shí)可以聲明變量接收
  Object result = point.proceed();
  System.out.println("原始方法返回值: "+result);
  //code............
  System.out.println("環(huán)繞后置..");
}

環(huán)繞通知與其他通知最大的區(qū)別在于環(huán)繞通知可以控制是否調(diào)用原始方法

注意:參數(shù)類型必須為ProceedingJoinPoint,否則無法執(zhí)行原始方法,

異常通知

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

當(dāng)方法中出現(xiàn)時(shí)才會(huì)執(zhí)行該通知,若需要獲取異常信息,可在注解中添加throwing指定參數(shù)名稱

我們可以使用環(huán)繞+異常通知來處理數(shù)據(jù)庫事務(wù),在環(huán)繞中開啟事務(wù)以及提交事務(wù),異常通知中回滾事務(wù),當(dāng)然Spring已經(jīng)對(duì)事務(wù)進(jìn)行了封裝不需要自己寫

最終通知

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

最終通知叫做after 即調(diào)用原始方法之后執(zhí)行無論原始方法中是否出現(xiàn)異常

而后置叫做afterReturning表示在成功返回后才會(huì)執(zhí)行執(zhí)行

帶有邏輯符的表達(dá)式:
在表達(dá)式中可以使用戶邏輯操運(yùn)算符,與&& 或|| 非!

示例:

/*
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(..))
*/
2|4切點(diǎn)命名

切點(diǎn)命名

假設(shè)有多個(gè)通知應(yīng)用在同一個(gè)切點(diǎn)上時(shí),我們需要重復(fù)編寫execution表達(dá)式,且后續(xù)要修改切點(diǎn)時(shí)則多個(gè)通知都需要修改,維護(hù)起來非常麻煩,我們可以通過給切點(diǎn)指定名稱從而完成對(duì)切點(diǎn)的重復(fù)使用和統(tǒng)一操作,以提高開發(fā)維護(hù)效率;

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

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

多個(gè)通知應(yīng)用到同一個(gè)切點(diǎn):

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

一個(gè)通知應(yīng)用到多個(gè)切點(diǎn)

//同一個(gè)通知對(duì)應(yīng)多個(gè)切點(diǎn)
@After(value = "savePointcut()||deletePointcut()")
public void afterAdvice(){
  System.out.println("after code run.....");
}

XML配置

XML配置所需的jar 以及各個(gè)對(duì)象之間的依賴關(guān)以及表達(dá)式的寫法都是一樣的,僅僅是換種方式來寫而已;

xml:

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

    <!--織入信息-->
  <aop:config>
        <!--切點(diǎn)定義-->
    <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>
   
    <!--入侵式通知 即通知需要實(shí)現(xiàn)指定接口 兩種不能同時(shí)使用 -->
    <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("前置通知 切點(diǎn):"+pointcut); }

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

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

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

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

你會(huì)發(fā)現(xiàn) ,無論是XML還是注解都不需要手動(dòng)指定代理,以及目標(biāo)對(duì)象,Aspectj會(huì)從切點(diǎn)中獲取目標(biāo)對(duì)象信息并自動(dòng)創(chuàng)建代理;

AspectJ是目前更流行的方式,具體采用XML還是注解需要根據(jù)項(xiàng)目具體情況,小組協(xié)作開發(fā)推薦xml;

以上就是本文的全部內(nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: