一篇文章帶你瞭解Spring AOP 的註解

Posted on by

1、xml 的方式實現 AOP

①、接口 UserService

package com.ys.aop;
public interface UserService {
    //添加 user
    public void addUser();
    //刪除 user
    public void deleteUser();
}

②、實現類 UserServiceImpl

package com.ys.aop;
public class UserServiceImpl implements UserService{
    @Override
    public void addUser() {
        System.out.println("增加 User");
    }
    @Override
    public void deleteUser() {
        System.out.println("刪除 User");
    }
}

③、切面類，也就是通知類 MyAspect

package com.ys.aop;
import org.aspectj.lang.JoinPoint;
public class MyAspect {
    /**
     * JoinPoint 能獲取目標方法的一些基本信息
     * @param joinPoint
     */
    public void myBefore(JoinPoint joinPoint){
        System.out.println("前置通知 ： " + joinPoint.getSignature().getName());
    }
    public void myAfterReturning(JoinPoint joinPoint,Object ret){
        System.out.println("後置通知 ： " + joinPoint.getSignature().getName() + " , -->" + ret);
    }
    public void myAfterThrowing(JoinPoint joinPoint,Throwable e){
        System.out.println("拋出異常通知 ： " + e.getMessage());
    }
    public void myAfter(){
        System.out.println("最終通知");
    }
}

④、AOP配置文件 applicationContext.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:aop="http://www.springframework.org/schema/aop"
       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
                           http://www.springframework.org/schema/context
                           http://www.springframework.org/schema/context/spring-context.xsd">   
    <!--1、創建目標類 -->
    <bean id="userService" class="com.ys.aop.UserServiceImpl"></bean>  
    <!--2、創建切面類（通知）  -->
    <bean id="myAspect" class="com.ys.aop.MyAspect"></bean>
    <!--3、aop編程 
        3.1 導入命名空間
        3.2 使用 <aop:config>進行配置
                proxy-target-class="true" 聲明時使用cglib代理
                如果不聲明，Spring 會自動選擇cglib代理還是JDK動態代理
            <aop:pointcut> 切入點 ，從目標對象獲得具體方法
            <aop:advisor> 特殊的切面，隻有一個通知 和 一個切入點
                advice-ref 通知引用
                pointcut-ref 切入點引用
        3.3 切入點表達式
            execution(* com.ys.aop.*.*(..))
            選擇方法         返回值任意   包             類名任意   方法名任意   參數任意
    -->
    <aop:config>
        <aop:aspect ref="myAspect">
        <!-- 切入點表達式 -->
        <aop:pointcut expression="execution(* com.ys.aop.*.*(..))" id="myPointCut"/>
        <!-- 3.1 前置通知
                <aop:before method="" pointcut="" pointcut-ref=""/>
                    method : 通知，及方法名
                    pointcut :切入點表達式，此表達式隻能當前通知使用。
                    pointcut-ref ： 切入點引用，可以與其他通知共享切入點。
                通知方法格式：public void myBefore(JoinPoint joinPoint){
                    參數1：org.aspectj.lang.JoinPoint  用於描述連接點（目標方法），獲得目標方法名等
        -->
        <aop:before method="myBefore" pointcut-ref="myPointCut"/>
        <!-- 3.2後置通知  ,目標方法後執行，獲得返回值
                <aop:after-returning method="" pointcut-ref="" returning=""/>
                    returning 通知方法第二個參數的名稱
                通知方法格式：public void myAfterReturning(JoinPoint joinPoint,Object ret){
                    參數1：連接點描述
                    參數2：類型Object，參數名 returning="ret" 配置的
        -->
        <aop:after-returning method="myAfterReturning" pointcut-ref="myPointCut" returning="ret" />
        <!-- 3.3 最終通知 -->        
        <aop:after method="myAfter" pointcut-ref="myPointCut"/>  
        </aop:aspect>
    </aop:config>
</beans>

⑤、測試

@Test
public void testAop(){
    ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
    UserService useService = (UserService) context.getBean("userService");
    useService.addUser();
    useService.deleteUser();
}

⑥、控制臺打印結果

上面的例子很簡單，就是在 UserService 的 addUser()方法和 deleteUser()方法增加前置通知和後置通知，這在實際操作中很好理解。比如這是和數據庫打交道的話，那麼我們在addUser() 或者deleteUser() 時，必須要在前面開始事務，操作完畢後提交事務。下面我們就用註解的方式來配置。

2、註解實現 AOP

①、導入相應的 jar 包，以及在 applicationContext.xml 文件中導入相應的命名空間。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:aop="http://www.springframework.org/schema/aop"
       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
                           http://www.springframework.org/schema/context
                           http://www.springframework.org/schema/context/spring-context.xsd">   
</beans>

②、註解配置 bean

xml配置：

<!--1、創建目標類 -->
<bean id="userService" class="com.ys.aop.UserServiceImpl"></bean>  
<!--2、創建切面類（通知）  -->
<bean id="myAspect" class="com.ys.aop.MyAspect"></bean>

註解配置：

目標類：　　

切面類：　　

③、配置掃描註解識別

這個我們在前面也講過，上面配置的註解，Spring 如何才能識別這些類上添加瞭註解呢？我們必須告訴他。

在applicationContext.xml 文件中添加如下配置：

<!-- 配置掃描註解類
        base-package:表示含有註解類的包名。
        如果掃描多個包，則下面的代碼書寫多行，改變 base-package 裡面的內容即可！
    -->
    <context:component-scan base-package="com.ys.aop"></context:component-scan>

④、註解配置 AOP

一、我們用xml配置過如下：　　

這是告訴 Spring 哪個是切面類。下面我們用註解配置

我們在切面類上添加 @Aspect 註解，如下：　　

 

二、如何讓 Spring 認識我們所配置的 AOP 註解？

光有前面的類註解掃描是不夠的，這裡我們要額外配置 AOP 註解識別。

我們在 applicationContext.xml 文件中增加如下配置：

<!--2、確定 aop 註解生效  -->
<aop:aspectj-autoproxy></aop:aspectj-autoproxy>

三、註解配置前置通知

我們先看 xml 配置前置通知如下：

<!-- 切入點表達式 -->
        <aop:pointcut expression="execution(* com.ys.aop.*.*(..))" id="myPointCut"/>
        <!-- 3.1 前置通知
                <aop:before method="" pointcut="" pointcut-ref=""/>
                    method : 通知，及方法名
                    pointcut :切入點表達式，此表達式隻能當前通知使用。
                    pointcut-ref ： 切入點引用，可以與其他通知共享切入點。
                通知方法格式：public void myBefore(JoinPoint joinPoint){
                    參數1：org.aspectj.lang.JoinPoint  用於描述連接點（目標方法），獲得目標方法名等
        -->
        <aop:before method="myBefore" pointcut-ref="myPointCut"/>

那麼註解的方式如下：　　

四、註解配置後置通知

xml 配置後置通知：

<!-- 3.2後置通知  ,目標方法後執行，獲得返回值
                <aop:after-returning method="" pointcut-ref="" returning=""/>
                    returning 通知方法第二個參數的名稱
                通知方法格式：public void myAfterReturning(JoinPoint joinPoint,Object ret){
                    參數1：連接點描述
                    參數2：類型Object，參數名 returning="ret" 配置的
        -->
        <aop:after-returning method="myAfterReturning" pointcut-ref="myPointCut" returning="ret" />

註意看，後置通知有個 returning="ret" 配置，這是用來獲得目標方法的返回值的。

註解配置如下：　　

五、測試

@Test
    public void testAopAnnotation(){
        ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext_Annotation.xml");
        UserService useService = (UserService) context.getBean("userService");
        useService.addUser();
        useService.deleteUser();
    }

六、控制臺打印結果　　

3、註解改進　　

我們可以看前置通知和後置通知的註解配置：　　

註意看紅色框住的部分，很顯然這裡是重復的，而且如果我們有多個通知方法，那就得在每個方法名都寫上該註解，而且如果包名夠復雜，也很容易寫錯。那麼怎麼辦呢？

解決辦法就是聲明公共切入點：

①、在 切面類 MyAspect.java 中新增一個切入點方法 myPointCut()，然後在這個方法上添加@Pointcut 註解

　　

②、那麼前置通知和後置通知，我們可以進行如下改寫配置：　　

4、總結

上面我們隻進行瞭前置通知和後置通知的講解，還有比如最終通知、環繞通知、拋出異常通知等，配置方式都差不多，這裡就不進行一一講解瞭。然後我們看一下這些通知的註解：

@Aspect 聲明切面，修飾切面類，從而獲得 通知。

通知

  • @Before 前置
  • @AfterReturning 後置
  • @Around 環繞
  • @AfterThrowing 拋出異常
  • @After 最終

切入點

  • @PointCut ，修飾方法 private void xxx(){} 之後通過“方法名”獲得切入點引用

本篇文章就到這裡瞭，希望能夠給你帶來幫助，也希望您能夠多多關註WalkonNet的更多內容!

推薦閱讀：