一起學Spring之AOP_ZenDei技術網路在線

在軟體開發中，我們重點關註的是業務邏輯代碼，但在實際開發中，需要寫的代碼卻不僅僅是業務邏輯，還需要處理記錄日誌，異常處理，事務控制等一些與業務無關的事情。而且這些代碼也是服務端必須的，類似這樣的代碼分散在系統中的各個地方，如：幾乎所有的重要操作方法前面都會加上日誌記錄代碼，這樣的代碼寫起來繁瑣，又占... ...

概述

在軟體開發中，我們重點關註的是業務邏輯代碼，但在實際開發中，需要寫的代碼卻不僅僅是業務邏輯，還需要處理記錄日誌，異常處理，事務控制等一些與業務無關的事情。而且這些代碼也是服務端必須的，類似這樣的代碼分散在系統中的各個地方，如：幾乎所有的重要操作方法前面都會加上日誌記錄代碼，這樣的代碼寫起來繁瑣，又占用開發時間和精力，而且不容易維護。我們統一把這類代碼成為【切麵代碼】，如何讓我們從這些繁瑣的工作中抽身而退，更加專註於業務邏輯，這就需要用到Spring的AOP技術。

AOP原理：將複雜的需求分解成不同的方面，將散落在系統中的公共功能集中解決，如下圖所示：

通知(Advice)的分類

分類如下：

前置通知：在某個切入點之前執行的通知
後置通知：在某個切入點之後執行的通知
異常通知：在某個切入點出現異常時候的通知
環繞通知：包圍某個切入點的通知，功能最強大

準備工作

AOP需要的jar包

除Spring必備的五個jar包外，還需要以下三個來支撐AOP：

aopalliance-1.0.jar
aspectjweaver-1.5.3.jar
spring-aop-4.0.6.RELEASE.jar

定義一個介面和實現類

如下所示：

IStudentService介面代碼如下：

 1 package com.hex.second;
 2 
 3 /**
 4  * 學生服務介面
 5  * @author Administrator
 6  *
 7  */
 8 public interface IStudentService {
 9     
10     /**
11      * 新增學生
12      * @param student
13      */
14     void addStudent(Student student);
15     /**
16      * 刪除學生
17      * @param id
18      */
19     void deleteStudent(int id);
20     
21     /**
22      * 修改學生
23      * @param id
24      */
25     void updateStudent(int id);
26 }

View Code

StudentServiceImpl類代碼如下：

 1 package com.hex.second;
 2 
 3 /**
 4  * 學生服務事項類
 5  * @author Administrator
 6  *
 7  */
 8 public class StudentServiceImpl implements IStudentService {
 9 
10     /**
11      * 新增學生
12      */
13     public void addStudent(Student student) {
14         // TODO Auto-generated method stub
15         System.out.println("新增加學生。。。");
16     }
17     
18     /**
19      * 刪除學生
20      */
21     @Override
22     public void deleteStudent(int id) {
23         // TODO Auto-generated method stub
24         System.out.println("刪除學生。。。");
25     }
26 
27     /**
28      * 修改學生
29      */
30     public void updateStudent(int id) {
31         // TODO Auto-generated method stub
32         System.out.println("修改學生");
33         int i=1/0;
34     }
35 }

View Code

前置通知

1. 實現介面

前置通知類，需要實現【MethodBeforeAdvice】介面中的before方法，如下所示：

Method method 表示執行的目標方法

Object[] args 表示傳入的參數數組

Object target 表示目標對象，即切入點所示的對象

 1 package com.hex.second;
 2 
 3 import java.lang.reflect.Method;
 4 
 5 import org.springframework.aop.MethodBeforeAdvice;
 6 
 7 public class LogBefore implements MethodBeforeAdvice {
 8 
 9     /***
10      * 前置通知
11      * method:表示調用的方法，即切入點
12      * args:表示調用方法的參數
13      * target：表示方法所在的目標對象
14      */
15     @Override
16     public void before(Method method, Object[] args, Object target) throws Throwable {
17         // TODO Auto-generated method stub
18         System.out.println("前置通知。。。");
19         System.out.println("method="+method+",args數量="+args.length+",target="+target);
20     }
21 }

2. 配置applicationContext.xml文件

如果要支持AOP，需要引入命名空間，如下所示：

1 <?xml version="1.0" encoding="UTF-8"?>
2 <beans xmlns="http://www.springframework.org/schema/beans"
3 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4 xmlns:p="http://www.springframework.org/schema/p"
5 xmlns:aop="http://www.springframework.org/schema/aop"
6 xsi:schemaLocation="http://www.springframework.org/schema/beans
7  http://www.springframework.org/schema/beans/spring-beans.xsd
8  http://www.springframework.org/schema/aop
9  http://www.springframework.org/schema/aop/spring-aop.xsd">

3. 配置兩個類對應的bean

1 <!-- 服務類 -->
2 <bean id="studentService" class="com.hex.second.StudentServiceImpl"></bean>
3 <!-- 前置通知類 -->
4 <bean id="logBefore" class="com.hex.second.LogBefore"></bean>

4. 配置AOP

通過AOP配置，將通知類和業務邏輯類進行關聯，說明如下：

一個配置文件中，可以有多個<aop:config>配置，每一個aop:config中只能有一個aop:pointcut配置，如果有多個切入點需要配置expression，且切入點必須是全路徑配置。如下所示：

<!-- 將addStudent和通知進行關聯 -->
<aop:config>
     <!-- 每一個config只有一個poingcut，如果有多個，則需要配置多個config -->
     <!-- 配置切入點  id自定義，expression表示切入點的函數名-->
     <aop:pointcut expression="execution(public void com.hex.second.StudentServiceImpl.addStudent(com.hex.second.Student))" id="pc"/>
     <!-- 配置通知 -->
     <aop:advisor advice-ref="logBefore" pointcut-ref="pc"/>
</aop:config>

後置通知

1. 實現介面

需要實現【AfterReturningAdvice】介面【afterReturning】方法中的如下所示：

 1 package com.hex.second;
 2 
 3 import java.lang.reflect.Method;
 4 
 5 import org.springframework.aop.AfterReturningAdvice;
 6 
 7 /**
 8  * 通過實現介面將普通類變成後置通知
 9  * @author Administrator
10  *
11  */
12 public class LogAfter implements AfterReturningAdvice {
13 
14     /**
15      * 後置通知實現類
16      * returnValue：返回值
17      * method:表示調用的方法，即切入點
18      * args:表示調用方法的參數
19      * target：表示方法所在的目標對象
20      */
21     @Override
22     public void afterReturning(Object returnValue, Method method, Object[] args, Object target) throws Throwable {
23         // TODO Auto-generated method stub
24         System.out.println("後置通知。。。");
25         System.out.println("returnValue="+returnValue+",method="+method+",args數量="+args.length+",target="+target);
26     }
27 
28 }

2. 配置切入點和通知的Bean

1 <bean id="studentService" class="com.hex.second.StudentServiceImpl"></bean>
2 <bean id="logAfter" class="com.hex.second.LogAfter"></bean>

3. AOP配置

如果前置通知和後置通知為同一個切入點，則可以配置在一個aop:config節點中，如下所示：

多個切入點用or連接，多個通知就配置多個aop:advisor

 1 <!-- 將addStudent和通知進行關聯 -->
 2 <aop:config>
 3      <!-- 每一個config只有一個poingcut，如果有多個，則需要配置多個config -->
 4      <!-- 配置切入點  id自定義，expression表示切入點的函數名-->
 5      <aop:pointcut expression="execution(public void com.hex.second.StudentServiceImpl.deleteStudent(int)) or execution(public void com.hex.second.StudentServiceImpl.addStudent(com.hex.second.Student))" id="pc"/>
 6      <!-- 配置通知 -->
 7      <aop:advisor advice-ref="logBefore" pointcut-ref="pc"/>
 8          
 9      <aop:advisor advice-ref="logAfter" pointcut-ref="pc"/>
10 </aop:config>

異常通知

1. 實現介面

異常通知是有異常發生時，才會觸發的通知，需要實現【ThrowsAdvice】介面，且此介面沒有需要實現的方法，但同時給出了約定：

必須以固定格式實現方法：public void afterThrowing([Method, args, target], ThrowableSubclass);

 1 package com.hex.second;
 2 
 3 import java.lang.reflect.Method;
 4 
 5 import org.springframework.aop.ThrowsAdvice;
 6 
 7 /**
 8  * 異常通知
 9  * @author Administrator
10  *
11  */
12 public class LogException implements ThrowsAdvice {
13     
14     /**
15      * 異常通知執行
16      * @param method 切入點
17      * @param args 參數個數
18      * @param target 調用目標對象
19      * @param ex 異常
20      */
21     public void afterThrowing(Method method, Object[] args, Object target, Exception ex){
22         System.out.println("異常通知。。。");
23         System.out.println("method="+method+",args數量="+args.length+",target="+target+",ex="+ex);
24     }
25 }

2. 配置Bean類

1 <!-- 服務類 -->
2 <bean id="studentService" class="com.hex.second.StudentServiceImpl"></bean>
3 <bean id="logException" class="com.hex.second.LogException"></bean>

3. 配置AOP

如下所示：參數只需要寫參數類型即可，不需要寫參數名稱

1 <!-- 可以配置aop:config -->
2 <aop:config>
3         <aop:pointcut expression="execution(public void com.hex.second.StudentServiceImpl.updateStudent(int))" id="pc1"/>
4      <!-- 配置通知 -->
5      <aop:advisor advice-ref="logException" pointcut-ref="pc1"/>
6 </aop:config>

環繞通知

1. 實現介面

環繞通知，需要實現【MethodInterceptor】介面並實現【invoke】方法，其中obj = invocation.proceed();表示調用目標方法，如果不寫此句，則目標方法不會被調用。如下所示：

 1 package com.hex.second;
 2 
 3 import org.aopalliance.intercept.MethodInterceptor;
 4 import org.aopalliance.intercept.MethodInvocation;
 5 
 6 /**
 7  * 環繞通知
 8  * 環繞通知的本質上是一個攔截器
 9  * @author Administrator
10  *
11  */
12 public class LogAround implements MethodInterceptor {
13 
14     /**
15      * 
16      */
17     @Override
18     public Object invoke(MethodInvocation invocation) throws Throwable {
19         Object obj = null;
20         try {
21 
22             // 前置通知
23             System.out.println("環繞實現前置通知。。。");
24             System.out.println("環繞通知：target="+invocation.getThis()+",method="+invocation.getMethod().getName()+",args="+invocation.getArguments().length);
25             // 控制目標方法的執行 obj表示目標方法的返回值，表示執行addStudent(student)方法
26             //此方法控制目標方法的執行，如果不寫此方法，則目標方法不會執行，此方法前的是前置通知，此方法後的是後置通知
27             obj = invocation.proceed();
28             // 後置通知
29             System.out.println("環繞實現後置通知。。。");
30         } catch (Exception e) {
31             // 異常通知
32             System.out.println("環繞實現異常通知。。。");
33             throw e;
34         }
35         // TODO Auto-generated method stub
36         return obj;
37     }
38 
39 }

2. 配置Bean

1 <!-- 服務類 -->
2 <bean id="studentService" class="com.hex.second.StudentServiceImpl"></bean>
3 <bean id="logAround" class="com.hex.second.LogAround"</bean>

3. 配置AOP

所有配置切入點通知的方式都是一樣的。如下所示：

1 <aop:config>
2      <aop:pointcut expression="execution(public void com.hex.second.StudentServiceImpl.addStudent(com.hex.second.Student))" id="pc2"/>
3      <aop:advisor advice-ref="logAround" pointcut-ref="pc2"/>
4 </aop:config>

所有的調用方式是一致的，不需要調用通知類，系統會自動調用，如下所示：

 1 package com.hex.second;
 2 
 3 import org.springframework.context.ApplicationContext;
 4 import org.springframework.context.support.ClassPathXmlApplicationContext;
 5 
 6 public class TestMain {
 7 
 8     public static void main(String[] args) {
 9         // TODO Auto-generated method stub
10         //通過Spring進行註入，Spring上下文對象
11         ApplicationContext context=new ClassPathXmlApplicationContext("applicationContext.xml");
12         IStudentService studentService=(IStudentService)context.getBean("studentService");
13         Student student =new Student();
14         studentService.addStudent(student);
15         //studentService.deleteStudent(1);
16         //studentService.updateStudent(0);
17     }
18 
19 }

View Code

備註

合抱之木，生於毫末;九層之台，起於累土;千里之行，始於足下。