Spring 面向切面AOP

一， 動態代理

1. 模式的引出

• 程式碼混亂：越來越多的非業務需求(日誌和驗證等)加入後, 原有的業務方法急劇膨脹. 每個方法在處理核心邏輯的同時還必須兼顧其他多個關注點.
• 程式碼分散: 以日誌需求為例, 只是為了滿足這個單一需求, 就不得不在多個模組（方法）裡多次重複相同的日誌程式碼. 如果日誌需求發生變化, 必須修改所有模組.

//介面
public interface ArithmeticCalculator {
	
	public int add(int i,int j);
	public int sub(int i,int j);
	public int mul(int i,int j);
	public int div(int i,int j);

}

public class ArithmeticCalculatorLoggingImpl implements ArithmeticCalculator {

	//新增日誌  重複的程式碼繁多 高耦合  不好
	public int add(int i, int j) {
		System.out.println("the method add begin with ["+i+","+j+"]");
		int result=i+j;
		System.out.println("the method add ends with"+result);
		return result;
	}

	public int sub(int i, int j) {
		System.out.println("the method sub begin with ["+i+","+j+"]");
		int result=i-j;
		System.out.println("the method sub ends with"+result);
		return result;
	}

	public int mul(int i, int j) {
		System.out.println("the method mul begin with ["+i+","+j+"]");
		int result=i*j;
		System.out.println("the method mul ends with"+result);
		return result;
	}

	public int div(int i, int j) {
		System.out.println("the method div begin with ["+i+","+j+"]");
		int result=i/j;
		System.out.println("the method div ends with"+result);
		return result;
	}

}

2.模式的原理

• 使用一個代理將物件包裝起來, 然後用該代理物件取代原始物件. 任何對原始物件的呼叫都要通過代理. 代理物件決定是否以及何時將方法呼叫轉到原始物件上.

• 程式碼如下

//測試類
ArithmeticCalculator arithmeticCalculator = new ArithmeticCalculatorImpl();
		
		arithmeticCalculator = 
				new ArithmeticCalcualtorLoggingProxy(arithmeticCalculator).getLoggingProxy();
		
		int result = arithmeticCalculator.add(11, 12);
		System.out.println("result:" + result);
		
		result = arithmeticCalculator.div(21, 3);
		System.out.println("result:" + result);

//動態代理類
public class ArithmeticCalcualtorLoggingProxy {
	//動態代理
	//要代理的物件
		private ArithmeticCalculator target;
		
		public ArithmeticCalcualtorLoggingProxy(ArithmeticCalculator target) {
		super();
		this.target = target;
	}

		//返回代理物件
		public ArithmeticCalculator getLoggingProxy(){
			ArithmeticCalculator proxy = null;
			
			ClassLoader loader = target.getClass().getClassLoader();
			Class [] interfaces = new Class[]{ArithmeticCalculator.class};
			InvocationHandler h = new InvocationHandler() {
				/**
				 * proxy: 代理物件。 一般不使用該物件
				 * method: 正在被呼叫的方法
				 * args: 呼叫方法傳入的引數
				 */
				public Object invoke(Object proxy, Method method, Object[] args)
						throws Throwable {

					String methodName = method.getName();
					//列印日誌
					System.out.println("[before] The method " + methodName + " begins with " + Arrays.asList(args));
					
					//呼叫目標方法
					Object result = null;
					
					try {
						//前置通知
						result = method.invoke(target, args);
						//返回通知, 可以訪問到方法的返回值
					} catch (NullPointerException e) {
						e.printStackTrace();
						//異常通知, 可以訪問到方法出現的異常
					}
					
					//後置通知. 因為方法可以能會出異常, 所以訪問不到方法的返回值
					
					//列印日誌
					System.out.println("[after] The method ends with " + result);
					
					return result;
				}
			};
			/**
			 * loader: 代理物件使用的類載入器。 
			 * interfaces: 指定代理物件的型別. 即代理代理物件中可以有哪些方法. 
			 * h: 當具體呼叫代理物件的方法時, 應該如何進行響應, 實際上就是呼叫 InvocationHandler 的 invoke 方法
			 */
			proxy = (ArithmeticCalculator) Proxy.newProxyInstance(loader, interfaces, h);
			
			return proxy;
		}

}

• 上述動態代理依然比較麻煩，若使用SpringAOP則更加方便。

二，面向切面AOP

1.AOP 的概念和細節

• 面向切面程式設計，是對傳統OOP物件導向程式設計的補充。主要程式設計物件是切面。

• AOP程式設計時，仍然需要定義公共功能。並且不必修改受影響的類。這樣依賴橫切關注點就被模組化到特殊的物件（切面）裡。

• 每個邏輯事物處於一個位置，程式碼不分散，便於維護和升級。業務模組更簡潔。只包含核心業務程式碼。

• 基礎語言

  • 切面（Aspect）:橫切關注點被模組化的特殊物件 。
  • 通知（Adive）：切面必須要完成的工作。
  • 目標（Target）:被通知的物件。
  • 代理（Proxy）:向目標物件應用 通知之後建立的物件。
  • 連線點（Joinpoint）:程式執行的某個特定的位置。
  • 切點（pointcut）:AOP通過切點定位到特定的連線點。類比：連線點相當於資料庫的記錄，切點相當於查詢條件。

• AspectJ:AOP框架。使用基於AspectJ註解或基於XML配置的Aop.

//applicationContext-aop.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:aop="http://www.springframework.org/schema/aop"
	xmlns:context="http://www.springframework.org/schema/context"
	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-4.0.xsd
		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd">

	<!-- 自動掃描的包 -->
	<context:component-scan base-package="com.xiaojian.spring.AOP"></context:component-scan>

	<!-- 使 AspectJ 的註解起作用 -->
	<aop:aspectj-autoproxy></aop:aspectj-autoproxy>

</beans>

• 註解宣告切面
  • AspectJ 支援 5 種型別的通知註解:
    @Before: 前置通知, 在方法執行之前執行
    @After: 後置通知, 在方法執行之後執行
    @AfterReturnning: 返回通知, 在方法返回結果之後執行
    @AfterThrowing: 異常通知, 在方法丟擲異常之後
    @Around: 環繞通知, 圍繞著方法執行

2. 切面的編寫過程（基於aspectJ註解）

1.前置通知與後置通知

package com.xiaojian.spring.AOP;

import java.util.Arrays;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component;

/**
 * AOP 面向切面程式設計
 * 1.加入jar包
 * 2.在spring的配置檔案中加入aop的名稱空間
 * 3.基於註解的方式來使用aop
 * 	3.1 在配置檔案中配置自動掃描的包
 * 	3.2 加入使AspjectJ註解起作用的配置
 * 
 * 4.編寫切面類：
 *	4.1 一個一般的Java類
 *	4.2 在其中新增要額外實現的類
 *
 * 5.配置切面
 * 	5.1 切面必須是IOC容器中的bean。新增註解@Component註解
 * 	5.2 宣告式一個切面：@Aspect
 * 	5.3 宣告通知，即新增額外的功能對應的方法
 * 		@before前置通知
 * 		@after 後置通知
 * @author lovexx
 *
 */
@Aspect
@Component
public class LoggingAspect {
	
	//引數的問題
	@Before("execution(public int com.xiaojian.spring.AOP.*.*(..))")
	public void beforeMethod(JoinPoint joinPoint){
		//通過連線點獲取方法的名稱和方法的引數
		 String methodName = joinPoint.getSignature().getName();
		Object[] args = joinPoint.getArgs();
		System.out.println("the method"+methodName+" begins with"+Arrays.asList(args));
	}
	
	@After("execution(public int com.xiaojian.spring.AOP.*.*(..))")
	public void afterMethod(JoinPoint joinPoint){
		String mathodName = joinPoint.getSignature().getName();
		
		System.out.println("the method"+mathodName+" ends ");
	}
	
}

• 測試類

package com.xiaojian.spring.AOP;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class Main {

	public static void main(String[] args) {
		
		ApplicationContext ctx = new ClassPathXmlApplicationContext("applicationContext-aop.xml");
		ArithmeticCalculator arithmeticCalculator=(ArithmeticCalculator)ctx.getBean("arithmeticCalculator");
		System.out.println(arithmeticCalculator.getClass().getName());
		
		int result = arithmeticCalculator.add(10, 2);
		System.out.println(result);		
	}
}

2. 返回通知，異常通知和環繞通知

• 返回通知 無論連線點是正常返回還是丟擲異常, 後置通知都會執行. 如果只想在連線點返回的時候記錄日誌, 應使用返回通知代替後置通知。並且有返回值。

/**
	 * 在方法正常執行結束之後執行的一段程式碼
	 * 返回通知可以訪問到該方法的返回值
	 */
	@AfterReturning(value="declareJointPointExpression()",returning="result")
	public void afterReturnning(JoinPoint joinPoint,Object result){
		String methodName = joinPoint.getSignature().getName();
		System.out.println("the method"+methodName+"ends with"+result);
	}

• 異常通知 只有連線點丟擲異常才會有異常通知

/**
	 * 異常通知
	 * 在目標方法出現異常時會執行的程式碼
	 * 可以訪問到異常物件，且可以指定在出現特定異常時再執行通知程式碼
	 */
	@AfterThrowing(value="declareJointPointExpression()",throwing="e")
	public void afterThrowing(JoinPoint joinPoint,Exception e){
		String methodName = joinPoint.getSignature().getName();
		System.out.println("the method"+methodName+" occurs exception:"+e);
	}

• 環繞通知
  • 環繞通知是所有通知型別中功能最為強大的, 能夠全面地控制連線點. 甚至可以控制是否執行連線點.
    對於環繞通知來說, 連線點的引數型別必須是 ProceedingJoinPoint . 它是 JoinPoint 的子介面, 允許控制何時執行, 是否執行連線點.
  • 在環繞通知中需要明確呼叫 ProceedingJoinPoint 的 proceed() 方法來執行被代理的方法. 如果忘記這樣做就會導致通知被執行了, 但目標方法沒有被執行.
  • 注意: 環繞通知的方法需要返回目標方法執行之後的結果, 即呼叫 joinPoint.proceed(); 的返回值, 否則會出現空指標異常

@Around("execution(public int com.xiaojian.spring.aop.ArithmeticCalculator.*(..))")
	public Object aroundMethod(ProceedingJoinPoint pjd){
		
		Object result = null;
		String methodName = pjd.getSignature().getName();
		
		try {
			//前置通知
			System.out.println("The method " + methodName + " begins with " + Arrays.asList(pjd.getArgs()));
			//執行目標方法
			result = pjd.proceed();
			//返回通知
			System.out.println("The method " + methodName + " ends with " + result);
		} catch (Throwable e) {
			//異常通知
			System.out.println("The method " + methodName + " occurs exception:" + e);
			throw new RuntimeException(e);
		}
		//後置通知
		System.out.println("The method " + methodName + " ends");
		
		return result;
	}

3. 引入通知(瞭解即可，無需程式碼說明)

3.指定切面的優先順序

• 在同一個連線點上應用不止一個切面時, 除非明確指定, 否則它們的優先順序是不確定的.
  切面的優先順序可以通過實現 Ordered 介面或利用 @Order 註解指定.
• 實現 Ordered 介面, getOrder() 方法的返回值越小, 優先順序越高.
• 若使用 @Order 註解, 序號出現在註解中

4. 重用切入點

• 在 AspectJ 切面中, 可以通過 @Pointcut 註解將一個切入點宣告成簡單的方法. 切入點的方法體通常是空的, 因為將切入點定義與應用程式邏輯混在一起是不合理的.
• 切入點方法的訪問控制符同時也控制著這個切入點的可見性.

/**
	 * 定義一個方法, 用於宣告切入點表示式. 一般地, 該方法中再不需要添入其他的程式碼. 
	 * 使用 @Pointcut 來宣告切入點表示式. 
	 * 後面的其他通知直接使用方法名來引用當前的切入點表示式. 
	 */
	@Pointcut("execution(public int com.xiaojian.spring.aop.*.*(..))")
	public void declareJointPointExpression(){}
	

5.基於XML的配置AOP

• 配置檔案

<?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: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-4.0.xsd">

	<!-- 配置 bean -->
	<bean id="arithmeticCalculator" 
		class="com.xiaojian.spring.aop.xml.ArithmeticCalculatorImpl"></bean>

	<!-- 配置切面的 bean. -->
	<bean id="loggingAspect"
		class="com.xiaojian.spring.aop.xml.LoggingAspect"></bean>

	
	<!-- 配置 AOP -->
	<aop:config>
		<!-- 配置切點表示式 -->
		<aop:pointcut expression="execution(* com.xiaojian.spring.aop.xml.ArithmeticCalculator.*(..))" 
			id="pointcut"/>
		<!-- 配置切面及通知 -->
		
		<aop:aspect ref="loggingAspect" >
			<aop:before method="beforeMethod" pointcut-ref="pointcut"/>
			<aop:after method="afterMethod" pointcut-ref="pointcut"/>
			<aop:after-returning method="afterReturning" pointcut-ref="pointcut" returning="result"/>
			<!--  
			<aop:around method="aroundMethod" pointcut-ref="pointcut"/>
			-->
		</aop:aspect>	
		
	</aop:config>

</beans>

• 介面類

package com.xiaojian.spring.aop.xml;

public interface ArithmeticCalculator {
	
	public int add(int i,int j);
	public int sub(int i,int j);
	public int mul(int i,int j);
	public int div(int i,int j);
}

• 介面的實現類

package com.xiaojian.spring.aop.xml;

public class ArithmeticCalculatorImpl implements ArithmeticCalculator {

	public int add(int i, int j) {
		int result = i+j;
		return result;
	}

	public int sub(int i, int j) {
		int result = i-j;
		return result;
	}

	public int mul(int i, int j) {
		int result = i*j;
		return result;
	}

	public int div(int i, int j) {
		int result = i/j;
		return result;
	}

}

• 測試類

package com.xiaojian.spring.aop.xml;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class Main {
	public static void main(String[] args) {
		
		ApplicationContext ctx = new ClassPathXmlApplicationContext("applicationContext-xml.xml");
		ArithmeticCalculator arithmeticCalculator = (ArithmeticCalculator) ctx.getBean("arithmeticCalculator");
		
		System.out.println(arithmeticCalculator.getClass().getName());
		
		int result = arithmeticCalculator.add(1, 2);
		System.out.println("result:" + result);
		
	}
}

• 切面類

package com.xiaojian.spring.aop.xml;

import java.util.Arrays;

import org.aspectj.lang.JoinPoint;

public class LoggingAspect {
	
	public void beforeMethod(JoinPoint joinPoint){
		//通過連線點獲取方法的名稱和方法的引數
		 String methodName = joinPoint.getSignature().getName();
		Object[] args = joinPoint.getArgs();
		System.out.println("the method"+methodName+" begins with"+Arrays.asList(args));
	}
	
	public void afterMethod(JoinPoint joinPoint){
		String mathodName = joinPoint.getSignature().getName();
		
		System.out.println("the method"+mathodName+" ends ");
	}
	
	public void afterReturnning(JoinPoint joinPoint,Object result){
		String methodName = joinPoint.getSignature().getName();
		System.out.println("the method"+methodName+"ends with"+result);
	}

}