本文讲解的主要内容,按照概念的重要程度,排列如下:
AspectJ是一个代码生成工具(Code Generator)。
AspectJ语法就是用来定义代码生成规则的语法。您如果使用过Java Compiler Compiler (JavaCC),您会发现,两者的代码生成规则的理念惊人相似。
AspectJ有自己的语法编译工具,编译的结果是Java Class文件,运行的时候,classpath需要包含AspectJ的一个jar文件(Runtime lib)。
AspectJ和xDoclet的比较。AspectJ和EJB Descriptor的比较。
本文的原则是,只细讲其他资料没有讲到的东西,其他资料讲过的东西,不讲或略讲。以节省网络资源,更为了节省大家宝贵的时间。J
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
}
};
我们看到,这些与商业逻辑无关的重复代码遍布在整个程序中。实际的工程项目中涉及到的类和函数,远远不止两个。如何解决这种问题?
我们首先来看看OOP能否解决这个问题。
我们利用Design Pattern的Template Pattern,可以抽出一个框架,改变上面的例子的整个设计结构。
类和方法的定义如下:
Code 2.4 Base.java
abstract class Base{
public float importantMethod(AccountInfo account, float money){
// 验证account是否为合法用户
// Begin Transaction
float result = yourBusiness(account, money)
// End Transaction
return result;
}
protected abstract float yourBusiness(AccountInfo account, float money);
};
Code 2.5 BankDeposit.java
class BankDeposit extends Base{
protected float yourBusiness(AccountInfo account, float money){
// 增加account账户的钱数,返回账户里当前的钱数
}
};
Code 2.6 BankWithdraw.java
class BankWithdraw extends Base{
protected float yourBusiness(AccountInfo account, float money){
// 减少account账户的钱数,返回取出的钱数
}
};
这里我们用一种很勉强的方法实现了认证和事务代码的重用。而且,有心的读者可能会注意到,这种方法的前提是,强制所有的方法都遵守同样的signature。
如果有一个转账方法transfer(AccountInfo giver, AccountInfo receiver, float money),由于transfer方法的signature不同于yourBusiness的signature,这个方法无法使用上面的框架。
这个例子中提到的认证,事务等方面,就是AOP所关心的Aspect。
AOP就是为了解决这种问题而出现的。AOP的目的就是--Separation of Aspects (or Separation of Concerns).
下面的章节,解释EJB Descriptor,AspectJ,xDoclet等工具如何解决Separation of Aspects的问题。
3.EJB Descriptor
如果我们使用EJB实现上面的例子,Bank类可以作为一个Stateless Session Bean实现。
在Bank的代码中只用考虑商业逻辑,不用考虑认证和事务等方面。
认证和事务等方面在EJB Descriptor中定义,由EJB Container提供这些方面的实现。
我们来看一下,如何使用EJB Descriptor描述上面的例子。
EJB Descriptor包括一个ejb-jar.xml文件。ejb-jar.xml文件包含两大部分,enterprise-beans和assembly-descriptor部分。enterprise-beans部分包含EJB的定义--JNDI Name,EJB Home, Interface, Bean Class Path等;assembly-descriptor部分包括配置信息的定义--安全角色,事务控制等等。
下面给出上面例子对应的模拟EJB Descriptor。
<ejb-jar
<enterprise-beans
<session
<ejb-nameBank</ejb-name
…
<ejb-classexample.Bank</ejb-class
<session-typeStateless</session-type
<transaction-typeContainer</transaction-type
<security-role-ref
<role-namebank-account</role-name
</security-role-ref
</session
</enterprise-beans
<assembly-descriptor
<security-role
<role-namebank-account</role-name
</security-role
<method-permission
<role-nameemployee</role-name
<method
<ejb-nameBank</ejb-name
<method-namedeposit</method-name
</method
<method
<ejb-nameBank</ejb-name
<method-namewithdraw</method-name
</method
</method-permission
<container-transaction
<method
<ejb-nameBank</ejb-name
<method-namedeposit</method-name
</method
<method
<ejb-nameBank</ejb-name
<method-namewithdraw</method-name
</method
<trans-attributeRequired</trans-attribute
</container-transaction
</assembly-descriptor
</ejb-jar
本文后面会讲到如何用AspectJ实现上例中的Separation of Aspects。
读者可以比较一下AspectJ语法和EJB Descriptor定义之间的对应关系。
两者都提供了类名、方法名的匹配规则,能够把类的方法映射到认证,事务等Aspect(方面)。
4.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
O