聊一聊Spring AOP

   前兩天，在給新入職的同事作技術介紹時，講到spring的AOP。使我又一次認識到，對於AOP，特別是spring AOP的理解，雖然你們都能說上來幾句，可是許多人認識並不太全面，甚至能夠說是隻知其一;不知其二----即便是對於那些已經有過幾年開發經驗的工程師也是如此。因此，回來以後，我乾脆對這塊東西作了個膚淺的小結，以便再有相似任務時，直接拿來給你們借鑑。

AOP(Aspect-Oriented Programming)實際上是OOP(Object-Oriented Programing)思想的補充和完善。咱們知道，OOP引進"抽象"、"封裝"、"繼承"、"多態"等概念,對萬事萬物進行抽象和封裝，來創建一種對象的層次結構，它強調了一種完整事物的自上而下的關係。可是具體細粒度到每一個事物內部的狀況，OOP就顯得無能爲力了。好比日誌功能。日誌代碼每每水平地散佈在全部對象層次當中，卻與它所散佈到的對象的核心功能毫無關係。對於其餘不少相似功能，如事務管理、權限控制等也是如此。這致使了大量代碼的重複，而不利於各個模塊的重用。
   而AOP技術則偏偏相反，它利用一種稱爲"橫切"的技術，可以剖解開封裝的對象內部，並將那些影響了多個類而且與具體業務無關的公共行爲 封裝成一個獨立的模塊（稱爲切面）。更重要的是，它又能以巧奪天功的妙手將這些剖開的切面復原，不留痕跡的融入核心業務邏輯中。這樣，對於往後橫切功能的編輯和重用都可以帶來極大的方便。
AOP技術的具體實現，無非也就是經過動態代理技術或者是在程序編譯期間進行靜態的"織入"方式。下面是這方面技術的幾個基本術語：
一、join point（鏈接點）：是程序執行中的一個精確執行點，例如類中的一個方法。它是一個抽象的概念，在實現AOP時，並不須要去定義一個join point。
二、point cut（切入點）：本質上是一個捕獲鏈接點的結構。在AOP中，能夠定義一個point cut，來捕獲相關方法的調用。
三、advice（通知）：是point cut的執行代碼，是執行「方面」的具體邏輯。
四、aspect（方面）：point cut和advice結合起來就是aspect，它相似於OOP中定義的一個類，但它表明的更可能是對象間橫向的關係。
五、introduce（引入）：爲對象引入附加的方法或屬性，從而達到修改對象結構的目的。有的AOP工具又將其稱爲mixin。

全部AOP技術基本上都是基於以上這些概念實現的。

  太抽象了，仍是趕快上例子吧。下面，我寫了一個用spring AOP實現的記錄方法調用的日誌功能的應用實例：目的是記錄 系統登陸功能 的執行狀況，技術框架簡單採用Spring+Struts。

1.登陸頁面：

<form action="login.do" method="post">
username:<input type="text" name="username" /><br>
password:<input type="password" name="password"><br>
<input type="submit" value="login">
</form>

2.表單類：

/**
*
* <p>[描述信息：登錄表單類]</p>
*
* @author bruce.yang
* @version 1.0 Created on 2013-8-13 下午2:04:09
*/
public class LoginActionForm extends ActionForm {
private String username;
private String password;
//setter,getter方法
}

3.Action類：

/**
*
* <p>[描述信息：登錄Action]</p>
*
* @author bruce.yang
* @version 1.0 Created on 2013-8-13 下午2:04:38
*/
public class LoginAction extends Action {
private ILoginService loginService;
@Override
public ActionForward execute(ActionMapping mapping, ActionForm form,
HttpServletRequest request, HttpServletResponse response)
throws Exception {
LoginActionForm laf = (LoginActionForm) form;
String username = laf.getUsername();
String password = laf.getPassword();
boolean ret = loginService.login(username, password);
if (ret) {
return mapping.findForward("success");
}
return mapping.findForward("fail");
}
//loginService的setter,getter方法
}

4.service層接口：

public interface ILoginService {
public boolean login(String userName, String password);
}
public interface ILogService {
public void log();
public void logArg(JoinPoint point);
public void logArgAndReturn(JoinPoint point, Object returnObj);
}

5.service層實現類：

/**
*
* <p>[描述信息：登陸Service類]</p>
*
* @author bruce.yang
* @version 1.0 Created on 2013-8-13 下午1:45:32
*/
public class LoginServiceImpl implements ILoginService {
/**
*
* <p>功能實現描述:登陸處理邏輯(這裏是假實現)</p>
*
* @see com.bruceyang.login.service.ILoginService#login(java.lang.String, java.lang.String)
* @author: bruce.yang
* @date: Created on 2013-8-13 下午1:45:32
*/
public boolean login(String userName, String password) {
StringBuffer sb=new StringBuffer();
sb.append("Target:").append("login:").append(userName).append(",").append(password);
System.out.println(sb.toString());
return true;
}
}

/**
*
* <p>[描述信息：操做日誌記錄Service]</p>
*
* @author bruce.yang
* @version 1.0 Created on 2013-8-13 下午1:45:32
*/
public class LogServiceImpl implements ILogService {
/**
*
* <p>功能實現描述:最簡單的狀況</p>
*
* @see com.bruceyang.login.service.ILogService#log()
* @author: bruce.yang
* @date: Created on 2013-8-13 下午1:46:17
*/
public void log() {
System.out.println(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date())+" *******Log*********");
}
/**
*
* <p>功能實現描述:有參無返回值的方法</p>
*
* @see com.bruceyang.login.service.ILogService#logArg(org.aspectj.lang.JoinPoint)
* @author: bruce.yang
* @date: Created on 2013-8-13 下午1:43:43
*/
public void logArg(JoinPoint point) {
StringBuffer sb=new StringBuffer();
//獲取鏈接點所在的目標對象
Object obj=point.getTarget();
//獲取鏈接點的方法簽名對象
String method=point.getSignature().getName();
//獲取鏈接點方法運行時的入參列表
Object[] args = point.getArgs();
sb.append(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date())).append(" ");
sb.append(obj.toString().substring(0,obj.toString().indexOf('@')));
sb.append(".").append(method).append(" ");
sb.append("Args:[");
if (args != null) {
for(int i=0;i<args.length;i++){
Object o=args[i];
sb.append(o);
if(i<args.length-1){
sb.append(",");
}
}
}
sb.append("]");
System.out.println(sb.toString());
}
/**
*
* <p>功能實現描述:有參並有返回值的方法</p>
*
* @see com.bruceyang.login.service.ILogService#logArgAndReturn(org.aspectj.lang.JoinPoint, java.lang.Object)
* @author: bruce.yang
* @date: Created on 2013-8-13 下午1:43:17
*/
public void logArgAndReturn(JoinPoint point, Object returnObj) {
StringBuffer sb=new StringBuffer();
//獲取鏈接點所在的目標對象
Object obj=point.getTarget();
//獲取鏈接點的方法簽名對象
String method=point.getSignature().getName();
//獲取鏈接點方法運行時的入參列表
Object[] args = point.getArgs();
sb.append(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date())).append(" ");
sb.append(obj.toString().substring(0,obj.toString().indexOf('@')));
sb.append(".").append(method).append(" ");
sb.append("Args:[");
if (args != null) {
for(int i=0;i<args.length;i++){
Object o=args[i];
sb.append(o);
if(i<args.length-1){
sb.append(",");
}
}
}
sb.append("]").append(" ");
sb.append("Ret:[").append(returnObj).append("]");
System.out.println(sb.toString());
}
}

6.web.xml：

<!-- spring config -->
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:config/spring/app*.xml</param-value>
</context-param>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<!-- struts config -->
<servlet>
<servlet-name>action</servlet-name>
<servlet-class>org.apache.struts.action.ActionServlet</servlet-class>
<init-param>
<param-name>config</param-name>
<param-value>/config/struts/struts-config.xml</param-value>
</init-param>
<init-param>
<param-name>debug</param-name>
<param-value>2</param-value>
</init-param>
<init-param>
<param-name>detail</param-name>
<param-value>2</param-value>
</init-param>
<load-on-startup>2</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>action</servlet-name>
<url-pattern>*.do</url-pattern>
</servlet-mapping>

7.spring配置信息：

  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"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop-2.0.xsd
http://www.springframework.org/schema/tx
http://www.springframework.org/schema/tx/spring-tx-2.0.xsd"
xmlns:aop="http://www.springframework.org/schema/aop" xmlns:tx="http://www.springframework.org/schema/tx">
<bean id="logService" class="com.bruceyang.login.service.impl.LogServiceImpl"></bean>
<bean id="loginService" class="com.bruceyang.login.service.impl.LoginServiceImpl"></bean>
<aop:config>
<!-- 切入點 -->
<aop:pointcut
expression="execution(* com.bruceyang.login.service.impl.Login*.*(..))"
id="myPointcut" />
<!-- 切面： 將哪一個對象中的哪一個方法，織入到哪一個切入點 -->
<aop:aspect id="dd" ref="logService">
<!-- 前置通知
<aop:before method="log" pointcut-ref="myPointcut" />
<aop:after method="logArg" pointcut-ref="myPointcut"/>
<aop:after-returning method="logArgAndReturn" returning="returnObj" pointcut-ref="myPointcut"/>
-->
<aop:before method="log" pointcut-ref="myPointcut" />
<aop:after method="logArg" pointcut-ref="myPointcut"/>
<aop:after-returning method="logArgAndReturn" returning="returnObj" pointcut-ref="myPointcut"/>
</aop:aspect>
</aop:config>
</beans>

7.Struts配置信息：

  struts-config.xml：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE struts-config PUBLIC
"-//Apache Software Foundation//DTD Struts Configuration 1.2//EN"
"http://jakarta.apache.org/struts/dtds/struts-config_1_2.dtd">
<struts-config>
<form-beans>
<form-bean name="loginActionForm" type="com.bruceyang.login.web.form.LoginActionForm"/>
</form-beans>
<action-mappings>
<action path="/tologin"
forward="/login.jsp"
/>
<action
path="/login"
type="org.springframework.web.struts.DelegatingActionProxy"
name="loginActionForm"
scope="request"
input="/login.jsp">
<forward name="success" path="/success.jsp"/>
<forward name="fail" path="/login.jsp"/>
</action>
</action-mappings>
<plug-in
className="org.springframework.web.struts.ContextLoaderPlugIn">
<set-property property="contextConfigLocation"
value="/WEB-INF/classes/config/struts/action-servlet.xml" />
</plug-in>
</struts-config>

action-servlet.xml：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd">
<beans>
<import resource="login-action.xml" />
</beans>

login-action.xml：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd">
<beans>
<bean name="/login"
class="com.bruceyang.login.web.action.LoginAction">
<property name="loginService" ref="loginService" />
</bean>
</beans>

附：1.目錄結構

       2.運行結果

  其實，spring爲咱們提供的事務管理等功能也是基於這個邏輯來實現的。而且咱們還能夠用這種方式實現更加複雜多樣的AOP編程。以達到把全部所謂的橫切關注點分離出來，一勞永逸的加以實現，之後集中精力解決核心關注點的實現。