AspectJ快速入門

1. 序

Aspect Oriented Programming (AOP)是近來一個比較熱門的話題。 
AspectJ是AOP的Java語言的實現，獲得了Java程序員的廣泛關注。 
關於AspectJ和AOP的具體資料，請從下列鏈接中查找： 
http://www.eclipse.org/aspectj/ 
http://www.parc.com/research/csl/projects/aspectj/ 
http://aosd.net/

初次接觸AspectJ的讀者看到這些資料（或者語法手冊），會感到AspectJ有些神祕。
他們想知道，AspectJ是如何做到這些的？AspectJ是怎樣工作的？AspectJ需要特殊的運行環境嗎？ 
本文從講解AspectJ的設計思路、運行原理入手，回答上述問題。

本文講解的主要內容，按照概念的重要程度，排列如下：

AspectJ是一個代碼生成工具（Code Generator）。 
AspectJ語法就是用來定義代碼生成規則的語法。您如果使用過Java Compiler Compiler (JavaCC)，您會發現，兩者的代碼生成規則的理念驚人相似。 
AspectJ有自己的語法編譯工具，編譯的結果是Java Class文件，運行的時候，classpath需要包含AspectJ的一個jar文件（Runtime lib）。 
AspectJ和xDoclet的比較。AspectJ和EJB Descriptor的比較。

2．Aspect Oriented Programming (AOP)

本節簡單介紹AOP的概念，解釋我們爲什麼需要AOP。 
AOP是Object Oriented Programming（OOP）的補充。
OOP能夠很好地解決對象的數據和封裝的問題，卻不能很好的解決Aspect（"方面"）分離的問題。下面舉例具體說明。

比如，我們有一個Bank（銀行）類。Bank有兩個方法，deposit（存錢）和withdraw（取錢）。 
類和方法的定義如下(Code 2.1 Bank.java)：

class Bank
{
    public float deposit(AccountInfo account, float money)
    {
      // 增加account賬戶的錢數，返回賬戶裏當前的錢數
    }
    public float withdraw(AccountInfo account, float money)
    {
      // 減少account賬戶的錢數，返回取出的錢數
    }
};

這兩個方法涉及到用戶的賬戶資金等重要信息，必須要非常小心，所以編寫完上面的商業邏輯之後，項目負責人又提出了新的要求--給Bank類的每個重要方法加上安全認證特性。 
於是，我們不得不分別在上面的兩個方法中加入安全認證的代碼。

類和方法的定義如下(Code 2.2 Bank.java)：

class Bank
{
    public float deposit(AccountInfo account, float money)
    {
      // 驗證account是否爲合法用戶
      // 增加account賬戶的錢數，返回賬戶裏當前的錢數
    }
    public float withdraw(AccountInfo account, float money)
    {
      // 驗證account是否爲合法用戶
      // 減少account賬戶的錢數，返回取出的錢數
    }
};

這兩個方法都需要操作數據庫，爲了保持數據完整性，項目負責人又提出了新的要求--給Bank類的每個操作數據庫的方法加上事務控制。 
於是，我們不得不分別在上面的兩個方法中加入事務控制的代碼。

類和方法的定義如下(Code 2.3 Bank.java)：

class Bank
{
public float deposit(AccountInfo account, float money)
{
  // 驗證account是否爲合法用戶
  // Begin Transaction
  // 增加account賬戶的錢數，返回賬戶裏當前的錢數
  // End Transaction
}
public float withdraw(AccountInfo account, float money)
{
  // 驗證account是否爲合法用戶
  // Begin Transaction
  // 減少account賬戶的錢數，返回取出的錢數
  // End Transaction
}
};

我們看到，這些與商業邏輯無關的重複代碼遍佈在整個程序中。實際的工程項目中涉及到的類和函數，遠遠不止兩個。如何解決這種問題？ 
這個例子中提到的認證，事務等方面，就是AOP所關心的Aspect。 
AOP就是爲了解決這種問題而出現的。AOP的目的就是--Separation of Aspects (or Separation of Concerns). 
下面的章節，解釋AspectJ工具如何解決Separation of Aspects的問題。

3．AspectJ

這一節我們來看看AspectJ如何實現上例中的Separation of Aspects。 
使用AspectJ，我們不用對原有的代碼做任何修改，就可以爲代碼提供不同的Aspect（方面）--比如，認證，事務等。

我們只需要提供兩個不同的Aspect--認證Aspect和事務Aspect。
Code 4.1 AuthAspect.java

aspect AuthAspect
{
  pointcut bankMethods() : execution (* Bank.deposit(…)) || execution (* Bank. withdraw (…));
  Object around(): bankMethods()
  {
    // 驗證account是否爲合法用戶
    return proceed();
  }
};

Code 4.2 TransactionAspect.java

aspect TransactionAspect
{
  pointcut bankMethods() : execution(* Bank.deposit(…)) || execution (* Bank. withdraw (…));
  Object around(): bankMethods()
  {
    // Begin Transaction
    Object result = proceed();
    // End Transaction
    return result;
  }
};

如果您暫時不能理解這段代碼，沒有關係，後面會講到，這些aspect的定義，不過是定義了一些代碼生成規則。 
我們用AspectJ編譯器編譯Bank文件和含有aspect的這個文件，出來的結果就是帶有安全認證和事務處理的Bank類。編譯出來的這個Bank類調用了AspectJ Runtime Lib，所以，如果你要運行這個Bank類，你需要把AspectJ Runtime Lib設置在你的classpath裏面。

我們來看看，AspectJ編譯器爲我們做了什麼事情。

首先，AspectJ從文件列表裏取出所有的文件名，然後讀取這些文件，進行分析。 
AspectJ發現一些文件含有aspect的定義，在這個例子裏，就是AuthAspect和TransactionAspect的定義；這些aspect就是代碼生成規則。 
AspectJ根據這些aspect代碼生成規則，修改添加你的源代碼。在這個例子裏，就是修改添加Bank文件。 
AspectJ讀取AuthAspect的定義，發現了一個pointcut--bankMethods()；這個pointcut的定義是execution(* Bank.deposit(…)) || execution(* Bank. withdraw (…))，表示所有對Bank類的deposit和withdraw方法的執行點。 
AspectJ繼續讀取AuthAspect的定義，發現了一個around()，這在AspectJ中叫做Advice，我不明白爲什麼叫這個名字，不過沒關係，我們只要知道它是幹什麼的就行了。Advice允許你在某個類的方法的調用之前或調用之後，加入另外的代碼。Code 4.1所示代碼中的around()的" // 驗證account是否爲合法用戶"部分，就是要加入的代碼。這段代碼要加在哪裏呢？around()後面跟了一個pointcut--bankMethods()。根據這個pointcut，AspectJ會把這段代碼加入到Bank.deposit和Bank.withdraw兩個方法的執行之前。達到的效果就如同Code 2.2所示。 
AspectJ讀取TransactionAspect的定義，象第（4）步一樣，發現了發現了一個pointcut--bankMethods()。 
AspectJ繼續讀取AuthAspect的定義，發現了一個around()。這次AspectJ把"Begin Transaction"和"End Transaction"兩段代碼加在Bank.deposit和Bank. withdraw兩個方法的執行前後。達到的效果就如同Code 2.3所示。

如何驗證這一點？您可以到 http://www.eclipse.org/aspectj/下載安裝AspectJ，編譯裏面的Sample，把編譯結果反編譯一下，就可以看到AspetJ自動生成的代碼。 
我們看到，AspectJ是一種代碼自動生成工具。你編寫一段通用的代碼，比如認證方面的代碼，事務方面的代碼，然後根據AspectJ語法定義一套代碼生成規則（aspect定義），AspectJ就會幫助你自動把這段通用代碼分佈到對應的代碼裏面去，簡單快捷，算無遺策。 
無獨有偶，一個著名的編譯器生成工具--Java Compiler Compiler (JavaCC)，也採用了非常相似的代碼生成機制。JavaCC允許你在語法定義規則文件中，加入你自己的Java代碼，用來處理讀入的各種語法元素。 
AspectJ令你的代碼更精簡，結構更良好。AspectJ的好處，我就不多說了，網上很多精彩的文章探討AspectJ的各種用途。

 

4．總結

開源項目的出現，打破了軟件技術領域的衆多壁壘，推動軟件技術進程的日新月異。 
同時，一些新名詞，新概念也層出不窮，令人眼花繚亂，無所適從。其實，很多東西都是換湯不換藥，我們理解應用這些新技術的時候，要抓住本質，要破除迷信，破除任何人爲的神祕感。

互聯網時代的權威，不是說出來的，而是做出來的。

另外，圍繞着一些有前途的新技術，總會出現大量的"快速入門手冊"，有些簡直就是對該技術幫助文檔的翻譯，而且，有難度的地方沒有翻譯出來，大家都明白的地方翻譯得非常詳盡，詳盡到了沒有必要的地步。這種因爲市場需求而產生的應景時文，大量地出現在技術文章領域。