作者:Bill Burke;
yahveyeye原文地址:
http://www.onjava.com/pub/a/onjava/2004/08/25/aoa.html中文地址:
http://www.matrix.org.cn/resource/article/44/44052_Annotation+Aop.html關(guān)鍵詞： Annotation Aop
Annotation是J2SE5.0的一項新功能，它允許您附加元數據到Java構建中。同時(shí)，面向方面編程（AOP）是一個(gè)相當新的技術(shù)，它可以使您封裝某些行為，這些行為是在使用面向對象（OO）技術(shù)時(shí)會(huì )更為混亂，困難甚至是不可能完成。這兩項技術(shù)結合起來(lái)給框架開(kāi)發(fā)者開(kāi)發(fā)的APIs更好的表達方式。本文深入結合這些技術(shù)，使用Jboss AOP框架，以不同的代碼范例向您展示如何結合兩者來(lái)實(shí)際地擴展Java 語(yǔ)言。
相關(guān)文章：Java Annotation入門(mén)：
http://www.matrix.org.cn/resource/article/44/44048_Java+Annotation.htmlAnnotation概述首先讓我們給出這兩項技術(shù)的一個(gè)概述。Annotation是JDK5.0的新功能，它在JSR-175規范中有詳細定義。它們允許您以安全的方法定義元數據并應用到類(lèi)，方法，構造程序，字段或參數中。對于你們中熟悉XDoclet的人來(lái)說(shuō)，Annotation將非常直觀(guān)，您可以用來(lái)聲明標簽以產(chǎn)生代碼。兩者的主要不同是Annotation是Java語(yǔ)言的一部分而XDoclet標簽可能會(huì )打錯并且難以創(chuàng )建。我喜歡用例子來(lái)說(shuō)明，所以讓我們展示一個(gè)簡(jiǎn)單的例子。
要定義一個(gè)Annotation，您所要做的就是聲明一個(gè)特殊類(lèi)型的Java接口。
清單1：Orange.java
package org.jboss.collors;
public @interface Orange{}
定義了這個(gè)接口，您就可以用來(lái)提供更多的描述給您的Java元素。
清單2：Foo.java
package org.jboss.examples;
public class Foo
{
@Orange void someMethod();
@Orange private int someField;
}
那么我們可以用Annotation來(lái)干什么呢？一些人想用Annotation來(lái)產(chǎn)生代碼并替代XDoclet，其他人，象J2EE和EJB3.0專(zhuān)家組，將它視為部署描述符的替代。本文談?wù)撛贏(yíng)OP中如何使用Annotation
AOP概述有許多的文章和書(shū)籍解釋AOP到底是什么，例如Graham O‘Regan的ONJava文章“Introduction to Aspect-Oriented Programming."我將在本文給出一個(gè)快速的概覽，但我鼓勵您在線(xiàn)做更多的研究。
假設您要添加代碼到一個(gè)應用程序去測試調用一個(gè)特定的java方法所需的總的時(shí)間。該代碼可能看起來(lái)如下：
清單3：public class BankAccount
{
public void withdraw(double amount)
{
long startTime = System.currentTimeMillis();
try
{
// Actual method body...
}
finally
{
long endTime = System.currentTimeMillis() - startTime;
System.out.println("withdraw took: " + endTime);
}
}
}
雖然這些代碼能夠正常工作，但這個(gè)方法有一些問(wèn)題：
1.它難以打開(kāi)和關(guān)閉測試，您必須在try/finally塊中對每個(gè)方法或購置函數手工增加代碼以進(jìn)行基準測試。
2。這一輪廓代碼并不真正屬于貫穿整個(gè)應用的代碼。它使得您的代碼臃腫并難以理解，因為您必須將計時(shí)放在try/finally塊中。
3、如果您想擴展它的功能以包含一個(gè)方法或是失敗計數，或甚至是注冊這些統計數據到一個(gè)更為復雜的報告機制中，您必須修改大量不同文件（又一次）。
Metrics類(lèi)提供了一個(gè)什么是橫切（cross-cutting）關(guān)系的完美，簡(jiǎn)潔的小例子。Jboss AOP以一種含蓄的方式提供了一個(gè)簡(jiǎn)單的方法來(lái)封裝和應用這樣的關(guān)系，這樣某些象度量操作代碼不會(huì )弄亂您的編碼。讓我們稍為深入到Jboss AOP一些來(lái)看看如何實(shí)現。
為了使用Jboss AOP封裝度量功能，您首先需要定義一個(gè)方面來(lái)指出該度量行為。
清單4：public class Metrics
{
public Object profile(MethodInvocation invocation) throws Throwable
{
long startTime = System.currentTimeMillis();
try
{
return invocation.invokeNext();
}
finally
{
long endTime = System.currentTimeMillis() - startTime;
java.lang.reflect.Method m = invocation.getMethod();
System.out.println("method " + m.toString() +
" time: " + endTime + "ms");
} }
}
一個(gè)方面只是一個(gè)具有定義了您想要附加到您的對象模型的行為的普通Java類(lèi)。這些方法的簽名必須返回一個(gè)java.lang.Object并且必須具有一個(gè)（并且只有一個(gè)）Jboss AOP 調用對象參數，它被用來(lái)封裝方法，構造函數或字段調用。方法名可以是任何你想要的并且當您綁定該方面到您的代碼片斷時(shí)被引用。
下面要做的事情就是實(shí)際應用方面到您想要它勾勒一個(gè)方法的執行的某個(gè)程序點(diǎn)。大多數AOP框架提供了一個(gè)指向表達式語(yǔ)言，在此處您可以定義您想要某個(gè)方面行為被附加到的位置。下面是在Jboss AOP中的做法。
清單5：jboss-aop.xml
<aop>
<aspect class="Metrics"/>
<bind pointcut="execution(public void BankAccount->withdraw(double amount))">
<advice name="profile" aspect="Metrics"/>
</bind>
</aop>
采用在Metrics.java中對方面的定義和jboss-aop.xml中的指向定義，該度量代碼現在以含蓄而又透明地應用到BankAccount.withdraw（）方法中并能在勾勒代碼不再需要時(shí)輕易地移除。
對于Jboss AOP更多的信息，請查詢(xún)分發(fā)包中的指南。其中具有大約20個(gè)例子來(lái)帶領(lǐng)您漫游如何使用Jboss AOP框架。
噓！現在我們已經(jīng)進(jìn)行了一個(gè)概覽，讓我們深入到本文的中心內容。我將再次給您提供一些例子，因為這是我所知道的講授一個(gè)新的概念的最好的方法。
正如我前面說(shuō)的，Annotation加上AOP幾乎是給予您擴展Java語(yǔ)言的能力。Annotation提供了聲明新的，可兼容的，類(lèi)型安全的語(yǔ)法機制。AOP提供了封裝和應用新的行為到一個(gè)語(yǔ)法表達式的機制。
方法Annotation和AOP讓我們看看如何使用方法Annotation和AOP。使用Annotation和AOP并應用到一個(gè)方法類(lèi)似于使用Java的synchronized關(guān)鍵字。當您設定一個(gè)方法為synchronized，您在告訴JVM：您想該方法在被調用時(shí)以一種特殊的方式進(jìn)行。Annotation允許您定義一個(gè)新的關(guān)鍵字來(lái)觸發(fā)您自己的特殊的定制行為。AOP給予您封裝這一行為的能力并將其“編織”進(jìn)該方法的執行中。再次的，這一概念的最佳描述是通過(guò)一個(gè)例子。
讓我們假設我們想要添加新的語(yǔ)法，使用該語(yǔ)法使得我們可以在方法被標簽為@Oneway時(shí)，在后臺以另一個(gè)線(xiàn)程調用這個(gè)void方法?？梢韵筮@樣使用新的語(yǔ)法：
清單6：Import org.jboss.aspects.Oneway；
public class Foo
{
@Oneway public static void someMethord（）{…}
public static void main(String[] args){
somMethod();//executes in
backgroud
}
}
當someMethod（）在main中被調用，它將異步運行，這樣main中的代碼可以并行執行其他任務(wù)。
要實(shí)現這一功能，首先要在一個(gè)Annotation中為我們的@Oneway標簽定義新的Java語(yǔ)法.
清單7：Oneway.java
package org.jboss.aspects;
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
@Target({ElementType.METHOD})
public @interface Oneway {}
夠簡(jiǎn)單的。@Target標簽允許您縮小Annotation可以應用的地方。在本例中，我們的@OnewayAnnotation只能應用到一個(gè)方法。記住，這些都是J2SE5.0百分之百可用的純Java。
下面要做的事是定義一個(gè)封裝我們的@Oneway行為的方面類(lèi)。
清單8：OnewayAspect.java
package org.jboss.aspects;
public OnewayAspect
{
private static class Task implements Runnable
{
private MethodInvocation invocation;
public Task(MethodInvocation invocation)
{
this.invocation = invocation;
}
public void run()
{
try { invocation.invokeNext(); }
catch (Throwable ignore) { }
}
}
public Object oneway(MethodInvocation invocation) throws Throwable
{
MethodInvocation copy = invocation.copy();
Thread t = new Thread(new Task(copy));
t.setDaemon(false);
t.start();
return null;
}
}
這個(gè)方面夠簡(jiǎn)單。oneway（）方法拷貝invocation，創(chuàng )建一個(gè)線(xiàn)程，在后臺啟動(dòng)整個(gè)調用并返回。我們可以想象一個(gè)更為復雜的例子：使用J2SE 5.0 java.util.concurrent包中的某些新的Executors，但這些代碼很有希望闡明了如何基于這個(gè)例子構建更為復雜的實(shí)現。
最后必須要做的事情是指定當@OnewayAnnotation在一個(gè)方法中聲明時(shí)觸發(fā)OnewayAspect應用的指向表達式。
清單9：jboss-aop.xml
<aop>
<aspect class="org.jboss.aspects.OnewayAspect"/>
<bind pointcut="execution(void *->@org.jboss.Oneway(..))">
<advice name="oneway"
aspect="org.jboss.aspects.OnewayAspect"/>
</bind>
</aop>
該指向表達式規定任何具有@Oneway標簽的void方法都應該有OnewayAspect.oneway()方法在它本身執行前被執行。隨著(zhù)Annotation，方面和現在定義的指向表達式，@Oneway語(yǔ)法現在可以用于您的應用程序中。一個(gè)簡(jiǎn)單，清晰，易于實(shí)現的方法來(lái)擴展Java 語(yǔ)言！
字段Annotation和AOP讓我們看看如何使用字段Annotation和AOP。使用Annotation和AOP，您可以改變一個(gè)對象的字段或是作為一個(gè)類(lèi)的靜態(tài)成員的實(shí)際存儲方式。在這個(gè)例子里我們要完成的是當您將一個(gè)字段（靜態(tài)或是成員）標記上@ThreadBased,盡管是將它存儲在java.lang.ThreadLocal，但它的值依然正常。當然，您可以直接使用ThreadLocal變量，但問(wèn)題是ThreadLocal并非一個(gè)類(lèi)型并且您必須使用“麻煩的”（好，它們并沒(méi)有那么羅嗦）get（）和set（）方法。那么我們現在做的就是創(chuàng )建一個(gè)ThreadLocal類(lèi)型的字段。我們主要的將創(chuàng )建一個(gè)稱(chēng)為@Thradbased變量的新的Java字段類(lèi)型。
象這樣使用新的類(lèi)型：
清單10：import org.jboss.aspects.Threadbased;
public class Foo
{
@Threadbased private int counter;
}
為了實(shí)現這個(gè)功能，我們必須先定義Annotation
清單11：Threadbased.java
package org.jboss.aspects;
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
@Target({ElementType.FIELD})
public @interface Threadbased {}
夠簡(jiǎn)單。@Target標簽允許您縮小Annotation可以應用的地方。在本例中，我們的@ThreadbasedAnnotation只能應用到字段。
下面的事情是定義封裝我們的ThreadLocal行為的方面。
清單12：ThreadbasedAspect.java
package org.jboss.aspects;
import org.jboss.aop.joinpoint.*;
import java.lang.reflect.Field;
public class ThreadbasedAspect
{
private ThreadLocal threadbased = new ThreadLocal();
public Object access(FieldReadInvocation invocation)
throws Throwable
{
// just in case we have a primitive,
// we can‘t return null
if (threadbased.get() == null)
return invocation.invokeNext();
return threadbased.get();
}
public Object access(FieldWriteInvocation invocation)
throws Throwable
{
threadbased.set(invocation.getValue());
return null;
}
}
ThreadbasedAspect 封裝到一個(gè)Java字段的訪(fǎng)問(wèn)。它里面具有一個(gè)專(zhuān)門(mén)的ThreadLocal變量跟蹤thradlocal變?yōu)橐粋€(gè)特殊的字段。它還有一個(gè)單獨的access（）方法，該方法根據一個(gè)字段的get或set方法是否被調用決定它是否被調用。這些方法委托給ThreadLocal來(lái)獲得字段的當前值。
最后，我們必須定義一個(gè)指向表達式，當@ThreadbasedAnnotation在某個(gè)字段被指定時(shí)觸發(fā)ThreadbasedAspect的應用。
清單13：jboss-aop.xml
<aop>
<aspect class="org.jboss.aspects.ThreadbasedAspect" scope="PER_JOINPOINT"/>
<bind pointcut="field(* *->@org.jboss.aspects.Threadbased)">
<advice name="access"
aspect="org.jboss.aspects.ThreadbasedAspect"/>
</bind>
</aop>
只有當我們具有多個(gè)@Threadbased變量定義在同一個(gè)類(lèi)時(shí)，我們需要為每個(gè)靜態(tài)字段分配一個(gè)ThreadbasedAspect實(shí)例。對于成員變量，我們需要為每個(gè)字段，每個(gè)對象實(shí)例分配一個(gè)ThreadbasedAspect實(shí)例。為了促進(jìn)這一行為，方面定義通過(guò)設定實(shí)例為PER_JOINPOINT限制方面類(lèi)的實(shí)例何時(shí)和何地被分配出去的范圍。如果我們不做限制，Jboss
AOP會(huì )只分配一個(gè)ThreadbasedAspect實(shí)例并且不同的字段會(huì )共享相同的ThreadLocal接口——這不是我們所希望的。
好就這樣。一個(gè)清晰容易的擴展Java來(lái)指定一個(gè)新的特殊類(lèi)型的方法。注意：該特殊的方法來(lái)自Jboss AOP束。
依賴(lài)注入字段Annotation和AOP可以使用的一個(gè)有趣的地方是依賴(lài)注入。依賴(lài)注入是關(guān)于對象聲明它們需要什么信息，配置或服務(wù)引用以及運行時(shí)自動(dòng)注入這些依賴(lài)而不是用代碼明確地在一個(gè)注冊中心查找。在J2EE領(lǐng)域，獲得javax.transaction.TransactionManager服務(wù)的訪(fǎng)問(wèn)并未標準化并且實(shí)際上不同的廠(chǎng)商有不同的實(shí)現。許多框架開(kāi)發(fā)者需要使用TransactionManager來(lái)實(shí)現定制事務(wù)服務(wù)。使用字段AnnotationAOP提供依賴(lài)注入并抽取出一個(gè)需要TransactionManager的組件如何引用它的細節是一個(gè)了不起的方法。讓我們定義一個(gè)方面，它將注入一個(gè)TransactionManager引用到一個(gè)字段值中。
首先，我們再次定義我們的Annotation。
清單14：Inject.java
package org.jboss.aspects;
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
@Target({ElementType.FIELD})
public @interface Inject {}
下面我們將定義方面類(lèi)，它封裝了TransactionManager的解析。該方面是特定于JBoss應用服務(wù)器，但您可以定義為每個(gè)廠(chǎng)商定義不同的實(shí)現。
清單15：InjectTMAspect.java
package org.jboss.aspects;
import org.jboss.aop.joinpoint.*;
import java.lang.reflect.Field;
import javax.transaction.TransactionManager;
import org.jboss.tm.TxManager;
public InjectTMAspect
{
private TransactionManager tm = TxManager.getInstance();
public Object access(FieldReadInvocation invocation)
throws Throwable {
return tm;
}
public Object access(FieldWriteInvocation invocation)
throws Throwable {
throw new RuntimeException(
"Setting an @Injected variable is illegal");
}
}
最后，我們必須定義XML綁定來(lái)觸發(fā)當@Inject標簽應用到一個(gè)字段時(shí)InjectTMAspect的應用。指向表達式基本上說(shuō)明了對任意一個(gè)標記為@Inject的TransactionManager字段應用InjectTMAspect。
清單16：<aop>
<aspect class="org.jboss.aspects.InjectTMAspect"/>
<bind pointcut="field(javax.transaction.TransactionManager *->@org.jboss.aspects.Inject)">
<advice name="access"
aspect="org.jboss.aspects.InjectTMAspect"/>
</bind>
</aop>
現在A(yíng)nnotation、方面類(lèi)和XML綁定已經(jīng)定義，我們可以在我們的代碼中使用了。
清單17：import javax.transaction.TransactionManager;
import org.jboss.aspects.Inject;
public class MyTransactionalCache
{
@Inject private TransactionManager tm;
...
}
更多預打包例子Jboss AOP不僅僅是關(guān)于A(yíng)OP框架。它還有一個(gè)豐富的方面庫，您可以直接在您的應用中使用。在這個(gè)庫中是一個(gè)比我們現在在本文展示的例子更為復雜的Annotation方面集。這些方面包括異步調用，事務(wù)劃分，事務(wù)鎖定和基于角色的安全。讓我們簡(jiǎn)要地瀏覽一下以提供給您一個(gè)更好的關(guān)于A(yíng)nnotation和AOP共同工作的考慮。
異步方面Jboss AOP異步方面允許您定義任何方法為異步的，這樣它可以在后臺被執行。這對于我們的@Oneway例子來(lái)說(shuō)有些困難，因為它使用Oswego并行包中的執行器工具，并為那些具有一個(gè)返回類(lèi)型的方法提供了一個(gè)方法來(lái)異步地接收回響應。要使用這個(gè)方面，您只需標記一個(gè)方法為@Asybchronous.
清單18：public Foo {
@Asynchronous public int someMethod(int someArg) {...}
}@Asynchronous標簽的應用做了一些事情。與在本文中的@Oneway例子一樣，它應用一個(gè)在后臺運行該方法的方面。而且，采用@Asynchronous標簽，您并不僅限于void方法并可于實(shí)際上返回一個(gè)值的方法進(jìn)行交互。當@Asynchronous標簽被應用，它強制Foo類(lèi)實(shí)現AsynchronousFacade接口。在A(yíng)OP領(lǐng)域，這稱(chēng)為接口引入（interface introduction）。AsynchronousFacade接口允許您預測一個(gè)響應或以超時(shí)限定等待一個(gè)響應。最好用一個(gè)例子來(lái)解釋。
清單19：Foo foo = new Foo();
someMethod(555); // executes in background
AsynchronousFacade facade = (AsynchronousFacade)foo;
AsynchronousResponse response = facde.waitForResponse();
System.out.println(response.getReturnValue());
您可以啟動(dòng)多個(gè)不同對象的多個(gè)不同方法的多個(gè)調用，并異步積累它們的響應。
事務(wù)鎖定有時(shí)在J2EE事務(wù)期間而不是一個(gè)方法執行，構造函數調用或同步塊執行期間同步一個(gè)對象或類(lèi)會(huì )很有用。對這類(lèi)事務(wù)同步或鎖定，Jboss AOP發(fā)明了@TxSynchronized關(guān)鍵字。您可以使用@TxSynchronized在任意成員或靜態(tài)方法已經(jīng)構造函數上。
清單20：import org.jboss.aspects.txlock.TxSynchronized;
public FooBar
{
@TxSynchronized public FooBar() {}
@TxSynchronized static void staticMethod() {}
@TxSynchronized public memberMethod() {}
}
如果一個(gè)被標記為@TxSynchronized的構造函數或靜態(tài)方法被調用，類(lèi)的鎖監視器會(huì )在事務(wù)執行期間被保持著(zhù)。如果一個(gè)標記為@TxSynchronized的成員方法被調用，該對象實(shí)例的鎖監視器將被保持直到目前的事務(wù)提交或回退?？刂圃撔袨榈姆矫嬉矊⒆鏊梨i檢測并在發(fā)生死鎖時(shí)拋出RuntimeException。
J2EE 散餐(原文法文：a la carte)之：事務(wù)劃分EJB3.0已經(jīng)定義了一些Annotation進(jìn)行事務(wù)劃分。Jboss AOP在此基礎上構建。這樣您可以通過(guò)指定Annotation應用事務(wù)劃分到任意方法（靜態(tài)或成員）以及任何Java類(lèi)構造函數。
清單21：import org.jboss.aspects.tx.*;
public class Foo
{
@Tx(TxType.REQUIRED) public Foo {}
@Tx(TxType.REQUIRESNEW) public static createFoo() {
return new Foo();
}
}
J2EE 散餐之：基于角色的安全EJB 3.0也定義了一些Annotation實(shí)現基于角色的安全。Jbos AOP是基于此構建的，所以您可以應用基于角色的安全到任何的字段或方法（靜態(tài)或成員）已經(jīng)構造函數。
清單22：import org.jboss.aspects.security.*;
@SecurityDomain("LDAP Repository")
public class Foo
{
@Permissions({"admin"}) public Foo() {}
@Permissions({"developer"}) public static int status;
@Permissions({"anybody"}) public static void doSomething() {...}
}
EJB演變隨著(zhù)AOP與EJB規范一起漸漸成熟，我真正希望發(fā)生的是EJB規范定義的Annotation將能在任何上下文作為新的Java語(yǔ)言的形容詞被使用，而不是讓它們有限的使用在會(huì )話(huà)bean中。想象一下，一個(gè)真正的無(wú)狀態(tài)bean僅僅成為一個(gè)明文Java類(lèi)的一個(gè)靜態(tài)方法集。
清單23：public MySessionBean
{
@Tx(TxType.REQUIRED) public static doSomething() {...}
}
無(wú)論如何，這些關(guān)于A(yíng)OP和EJB的討論很可能就是為了EJB4.0。
結論并非是限制J2SE5.0Annotation用于代碼生成，Annotation和AOP可以被結合起來(lái)提供新的能力給框架開(kāi)發(fā)者。這一結合允許開(kāi)發(fā)者定義新的具有行為附加到其上的Java語(yǔ)法?；旧?，以安全的方式擴展Java語(yǔ)言的能力已盡在掌握。
資源 ·Matrix-Java開(kāi)發(fā)者社區:
http://www.matrix.org.cn·onjava.com:
onjava.com關(guān)于作者Bill Burke ：JBoss 首席架構師.
