Spring中的AOP詳解

本文摘自pandonix的博客。

此前對於AOP的使用僅限於聲明式事務，除此之外在實際開發中也沒有遇到過與之相關的問題。最近項目中遇到了以下幾點需求,采用AOP來解決。一方麵是為了以更加靈活的方式來解決問題，另一方麵是借此機會深入學習Spring AOP相關的內容。本文是權當本人的自己AOP學習筆記，以下需求不用AOP肯定也能解決，至於是否牽強附會，仁者見仁智者見智。

麵對需求：

①對部分函數的調用進行日誌記錄，用於觀察特定問題在運行過程中的函數調用情況。
②監控部分重要函數，若拋出指定的異常，需要以短信或郵件方式通知相關人員。
③監控部分重要函數的執行時間。

不采用AOP解決過程中的問題：

①需要打印日誌的函數分散在各個包中，隻能找到所有的函數體，手動添加日誌。然而這些日誌都是臨時的，待問題解決之後應該需要清除打印日誌的代碼，隻能再次手動清除。

②類似1的情況，需要捕獲異常的地方太多，如果手動添加時想到很可能明天又要手動清除。該需求相對比較固定，屬於長期監控的範疇，並不需求臨時添加後再清除。然而，客戶某天要求，把其中20%的異常改為短信提醒，剩下的80%改用郵件提醒。兩天後，客戶抱怨短信太多，全部改成郵件提醒。

③該需求通常用於監控某些函數的執行時間，用以判斷係統執行慢的瓶頸所在。瓶頸被解決之後，煩惱同情況1。

下麵我們采用AOP來解決：

切麵類TestAspect

package com.spring.aop;

public class TestAspect {

    public void doAfter(JoinPoint jp) {
        System.out.println("log Ending method: "
                + jp.getTarget().getClass().getName() + "."
                + jp.getSignature().getName());
    }

    public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
        long time = System.currentTimeMillis();
        Object retVal = pjp.proceed();
        time = System.currentTimeMillis() - time;
        System.out.println("process time: " + time + " ms");
        return retVal;
    }

    public void doBefore(JoinPoint jp) {
        System.out.println("log Begining method: "
                + jp.getTarget().getClass().getName() + "."
                + jp.getSignature().getName());
    }

    public void doThrowing(JoinPoint jp, Throwable ex) {
        System.out.println("method " + jp.getTarget().getClass().getName()
                + "." + jp.getSignature().getName() + " throw exception");
        System.out.println(ex.getMessage());
    }

    private void sendEx(String ex) {
        //TODO 發送短信或郵件提醒
    }
}

接口A

package com.spring.service;

public interface AService {

public void fooA(String _msg);

public void barA();
}

接口A的實現類

package com.spring.service;

public class AServiceImpl implements AService {

    public void barA() {
        System.out.println("AServiceImpl.barA()");
    }

    public void fooA(String _msg) {
        System.out.println("AServiceImpl.fooA(msg:"+_msg+")");
    }
}

Service類B

package com.spring.service;

public class BServiceImpl {

    public void barB(String _msg, int _type) {
        System.out.println("BServiceImpl.barB(msg:"+_msg+" type:"+_type+")");
        if(_type == 1)
            throw new IllegalArgumentException("測試異常");
    }

    public void fooB() {
        System.out.println("BServiceImpl.fooB()");
    }

}

ApplicationContext.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="https://www.springframework.org/schema/beans"
    xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
    xmlns:aop="https://www.springframework.org/schema/aop"
    xsi:schemaLocation="
            https://www.springframework.org/schema/beans
            https://www.springframework.org/schema/beans/spring-beans-2.0.xsd
            https://www.springframework.org/schema/aop
            https://www.springframework.org/schema/aop/spring-aop-2.5.xsd"
    default-autowire="autodetect">

   <aop:config>
        <aop:aspect ref="aspectBean">
            
            <aop:pointcut
                expression="execution(* com.spring.service.*.*(..))" />
            <aop:before pointcut-ref="businessService" method="doBefore"/>
            <aop:after pointcut-ref="businessService" method="doAfter"/>
            <aop:around pointcut-ref="businessService" method="doAround"/>
            <aop:after-throwing pointcut-ref="businessService" method="doThrowing" throwing="ex"/>
        </aop:aspect>
    </aop:config>

    <bean />
    <bean ></bean>
    <bean ></bean>

</beans>

測試類AOPTest

public class AOPTest extends AbstractDependencyInjectionSpringContextTests {

private AService aService;

private BServiceImpl bService;

protected String[] getConfigLocations() {
  String[] configs = new String[] { "/applicationContext.xml"};
  return configs;
}

/**
* 測試正常調用
*/
public void testCall()
{
  System.out.println("SpringTest JUnit test");
  aService.fooA("JUnit test fooA");
  aService.barA();
  bService.fooB();
  bService.barB("JUnit test barB",0);
}

/**
* 測試After-Throwing
*/
public void testThrow()
{
  try {
   bService.barB("JUnit call barB",1);
  }
  catch (IllegalArgumentException e) {

  }
}

public void setAService(AService service) {
  aService = service;
}

public void setBService(BServiceImpl service) {
  bService = service;
}
}

運行結果如下：

log Begining method: com.spring.service.AServiceImpl.fooA
AServiceImpl.fooA(msg:JUnit test fooA)
log Ending method: com.spring.service.AServiceImpl.fooA
process time: 0 ms
log Begining method: com.spring.service.AServiceImpl.barA
AServiceImpl.barA()
log Ending method: com.spring.service.AServiceImpl.barA
process time: 0 ms
log Begining method: com.spring.service.BServiceImpl.fooB
BServiceImpl.fooB()
log Ending method: com.spring.service.BServiceImpl.fooB
process time: 0 ms
log Begining method: com.spring.service.BServiceImpl.barB
BServiceImpl.barB(msg:JUnit test barB type:0)
log Ending method: com.spring.service.BServiceImpl.barB
process time: 0 ms

log Begining method: com.spring.service.BServiceImpl.barB
BServiceImpl.barB(msg:JUnit call barB type:1)
log Ending method: com.spring.service.BServiceImpl.barB
method com.spring.service.BServiceImpl.barB throw exception
測試異常

《Spring參考手冊》中定義了以下幾個AOP的重要概念，結合以上代碼分析如下：

切麵Aspect：官方的抽象定義為“一個關注點的模塊化，這個關注點可能會橫切多個對象”。例如AServiceImpl.barA()的調用就是切麵TestAspect所關注的行為之一。切麵在ApplicationContext中<aop:aspect>來配置。

連接點Joinpoint：程序執行過程中的某一行為，例如AServiceImpl.barA()的調用或者BServiceImpl.barB(String _msg, int _type)拋出異常等行為。

通知Advice：切麵對於某個連接點所產生的動作，例如，TestAspect中對com.spring.service包下所有類的方法進行日誌記錄的動作就是一個Advice。其中，一個“切麵”可以包含多個Advice，例如TestAspect。

切入點Pointcut：匹配連接點的斷言，在AOP中通知和一個切入點表達式關聯。例如TestAspect中的所有通知所關注的連接點，都由切入點表達式execution(* com.spring.service.*.*(..))來決定。

目標對象Target Object：被一個或者多個切麵所通知的對象。例如，AServcieImpl和BServiceImpl，當然在實際運行時，Spring AOP采用代理實現，實際AOP操作的是TargetObject的代理對象。

AOP代理AOP Proxy在Spring AOP中有兩種代理方式，JDK動態代理和CGLIB代理。默認情況下TargetObject實現了接口時，則采用JDK動態代理例如AServiceImpl。反之采用CGLIB代理，例如BServiceImpl。強製使用CGLIB代理需要將<aop:config>的proxy-target-class 屬性設為true。

通知(Advice)類型

前置通知(Before advice)：在某連接點JoinPoint之前執行的通知，但這個通知不能阻止連接點前的執行。ApplicationContext中在<aop:aspect>裏麵使用<aop:before>元素進行聲明。例如，TestAspect中的doBefore方法。

後置通知(After advice)：當某連接點退出的時候執行的通知(不論是正常返回還是異常退出)。ApplicationContext中在<aop:aspect>裏麵使用<aop:after>元素進行聲明。例如TestAspect中的doAfter方法，所以AOPTest中調用BServiceImpl.barB拋出異常時，doAfter方法仍然執行。

返回後通知(After return advice)：在某連接點正常完成後執行的通知，不包括拋出異常的情況。ApplicationContext中在<aop:aspect>裏麵使用<after-returning>元素進行聲明。

環繞通知(Around advice)：包圍一個連接點的通知，類似Web中Servlet規範中的Filter的doFilter方法。可以在方法的調用前後完成自定義的行為，也可以選擇不執行。ApplicationContext中在<aop:aspect>裏麵使用<aop:around>元素進行聲明。例如TestAspect中的doAround方法。

拋出異常後通知(After throwing advice)：在方法拋出異常退出時執行的通知。ApplicationContext中在<aop:aspect>裏麵使用<aop:after-throwing>元素進行聲明。例如TestAspect中的doThrowing方法。

切入點表達式

通常情況下，表達式中使用execution就可以滿足大部分的要求。表達式格式如下：

execution(modifiers-pattern? ret-type-pattern declaring-type-pattern? name-pattern(param-pattern) throws-pattern?)

modifiers-pattern：方法的操作權限

ret-type-pattern：返回值

declaring-type-pattern：方法所在的包

name-pattern：方法名

parm-pattern：參數名

throws-pattern：異常

其中，除ret-type-pattern和name-pattern之外，其他都是可選的。上例中，execution(* com.spring.service.*.*(..))表示com.spring.service包下，返回值為任意類型；方法名任意；參數不作限製的所有方法。

通知參數

可以通過args來綁定參數，這樣就可以在通知(Advice)中訪問具體參數了。例如<aop:aspect>配置如下

<aop:config>
    <aop:aspect ref="aspectBean">
<aop:pointcut
     expression="execution(* com.spring.service.*.*(String,..)) and args(msg,..)" />
     <aop:after pointcut-ref="businessService" method="doAfter"/>
    </aop:aspect>
</aop:config>

TestAspect的doAfter方法中就可以訪問msg參數，但這樣以來AService中的barA()和BServiceImpl中的barB()就不再是連接點，因為execution(* com.spring.service.*.*(String,..))隻配置第一個參數為String類型的方法。其中，doAfter方法定義如下：

public void doAfter(JoinPoint jp,String msg)

訪問當前的連接點

任何通知(Advice)方法可以將第一個參數定義為org.aspectj.lang.JoinPoint類型。JoinPoint接口提供了一係列有用的方法，比如getArgs() 返回方法參數,getThis()返回代理對象,getTarget()返回目標,getSignature()返回正在被通知的方法相關信息和toString()打印出正在被通知的方法的有用信息。

原帖地址：https://pandonix.iteye.com/blog/336873

最後更新：2017-04-02 16:47:44

Spring中的AOP詳解

上一篇： Java正則表達式（二）、常用正則工具類

下一篇： Java 筆記06

相關內容

熱門內容

最新內容