Spring AOP 实现原理与 CGLIB 应用

￡神魔★判官ぃ 2022-05-22 11:22 202阅读 0赞

AOP（Aspect Orient Programming），作为面向对象编程的一种补充，广泛应用于处理一些具有横切性质的系统级服务，如事务管理、安全检查、缓存、对象池管理等。AOP 实现的关键就在于 AOP 框架自动创建的 AOP 代理，AOP 代理则可分为静态代理和动态代理两大类，其中静态代理是指使用 AOP 框架提供的命令进行编译，从而在编译阶段就可生成 AOP 代理类，因此也称为编译时增强；而动态代理则在运行时借助于 JDK 动态代理、CGLIB 等在内存中“临时”生成 AOP 动态代理类，因此也被称为运行时增强。

## AOP 的存在价值 ##

在传统 OOP 编程里以对象为核心，整个软件系统由系列相互依赖的对象所组成，而这些对象将被抽象成一个一个的类，并允许使用类继承来管理类与类之间一般到特殊的关系。随着软件规模的增大，应用的逐渐升级，慢慢出现了一些 OOP 很难解决的问题。

我们可以通过分析、抽象出一系列具有一定属性与行为的对象，并通过这些对象之间的协作来形成一个完整的软件功能。由于对象可以继承，因此我们可以把具有相同功能或相同特性的属性抽象到一个层次分明的类结构体系中。随着软件规范的不断扩大，专业化分工越来越系列，以及 OOP 应用实践的不断增多，随之也暴露出了一些 OOP 无法很好解决的问题。

现在假设系统中有 3 段完全相似的代码，这些代码通常会采用“复制”、“粘贴”方式来完成，通过这种“复制”、“粘贴”方式开发出来的软件如图 1 所示。

图 1.多个地方包含相同代码的软件

![图 1 多个地方包含相同代码的软件][1]

看到如图 1 所示的示意图，可能有的读者已经发现了这种做法的不足之处：如果有一天，图 1 中的深色代码段需要修改，那是不是要打开 3 个地方的代码进行修改？如果不是 3 个地方包含这段代码，而是 100 个地方，甚至是 1000 个地方包含这段代码段，那会是什么后果？

为了解决这个问题，我们通常会采用将如图 1 所示的深色代码部分定义成一个方法，然后在 3 个代码段中分别调用该方法即可。在这种方式下，软件系统的结构如图 2 所示。

图 2 通过方法调用实现系统功能

![图 2 通过方法调用实现系统功能][2]

对于如图 2 所示的软件系统，如果需要修改深色部分的代码，只要修改一个地方即可，不管整个系统中有多少地方调用了该方法，程序无须修改这些地方，只需修改被调用的方法即可——通过这种方式，大大降低了软件后期维护的复杂度。

对于如图 2 所示的方法 1、方法 2、方法 3 依然需要显式调用深色方法，这样做能够解决大部分应用场景。但对于一些更特殊的情况：应用需要方法 1、方法 2、方法 3 彻底与深色方法分离——方法 1、方法 2、方法 3 无须直接调用深色方法，那如何解决？

因为软件系统需求变更是很频繁的事情，系统前期设计方法 1、方法 2、方法 3 时只实现了核心业务功能，过了一段时间，我们需要为方法 1、方法 2、方法 3 都增加事务控制；又过了一段时间，客户提出方法 1、方法 2、方法 3 需要进行用户合法性验证，只有合法的用户才能执行这些方法；又过了一段时间，客户又提出方法 1、方法 2、方法 3 应该增加日志记录；又过了一段时间，客户又提出……面对这样的情况，我们怎么办？通常有两种做法：

*  根据需求说明书，直接拒绝客户要求。
 *  拥抱需求，满足客户的需求。

第一种做法显然不好，客户是上帝，我们应该尽量满足客户的需求。通常会采用第二种做法，那如何解决呢？是不是每次先定义一个新方法，然后修改方法 1、方法 2、方法 3，增加调用新方法？这样做的工作量也不小啊！我们希望有一种特殊的方法：我们只要定义该方法，无须在方法 1、方法 2、方法 3 中显式调用它，系统会“自动”执行该特殊方法。

上面想法听起来很神奇，甚至有一些不切实际，但其实是完全可以实现的，实现这个需求的技术就是 AOP。AOP 专门用于处理系统中分布于各个模块（不同方法）中的交叉关注点的问题，在 Java EE 应用中，常常通过 AOP 来处理一些具有横切性质的系统级服务，如事务管理、安全检查、缓存、对象池管理等，AOP 已经成为一种非常常用的解决方案。

## 使用 AspectJ 的编译时增强进行 AOP ##

AspectJ 是一个基于 Java 语言的 AOP 框架，提供了强大的 AOP 功能，其他很多 AOP 框架都借鉴或采纳其中的一些思想。

AspectJ 是 Java 语言的一个 AOP 实现，其主要包括两个部分：第一个部分定义了如何表达、定义 AOP 编程中的语法规范，通过这套语言规范，我们可以方便地用 AOP 来解决 Java 语言中存在的交叉关注点问题；另一个部分是工具部分，包括编译器、调试工具等。

AspectJ 是最早、功能比较强大的 AOP 实现之一，对整套 AOP 机制都有较好的实现，很多其他语言的 AOP 实现，也借鉴或采纳了 AspectJ 中很多设计。在 Java 领域，AspectJ 中的很多语法结构基本上已成为 AOP 领域的标准。

下载、安装 AspectJ 比较简单，读者登录 AspectJ 官网（http://www.eclipse.org/aspectj），即可下载到一个可执行的 JAR 包，使用 java -jar aspectj-1.x.x.jar 命令、多次单击“Next”按钮即可成功安装 AspectJ。

成功安装了 AspectJ 之后，将会在 E:\\Java\\AOP\\aspectj1.6 路径下（AspectJ 的安装路径）看到如下文件结构：

*  bin：该路径下存放了 aj、aj5、ajc、ajdoc、ajbrowser 等命令，其中 ajc 命令最常用，它的作用类似于 javac，用于对普通 Java 类进行编译时增强。
 *  docs：该路径下存放了 AspectJ 的使用说明、参考手册、API 文档等文档。
 *  lib：该路径下的 4 个 JAR 文件是 AspectJ 的核心类库。
 *  相关授权文件。

一些文档、AspectJ 入门书籍，一谈到使用 AspectJ，就认为必须使用 Eclipse 工具，似乎离开了该工具就无法使用 AspectJ 了。

虽然 AspectJ 是 Eclipse 基金组织的开源项目，而且提供了 Eclipse 的 AJDT 插件（AspectJ Development Tools）来开发 AspectJ 应用，但 AspectJ 绝对无须依赖于 Eclipse 工具。

实际上，AspectJ 的用法非常简单，就像我们使用 JDK 编译、运行 Java 程序一样。下面通过一个简单的程序来示范 AspectJ 的用法，并分析 AspectJ 如何在编译时进行增强。

首先编写一个简单的 Java 类，这个 Java 类用于模拟一个业务组件。

清单 1.Hello.java

上面 Hello 类模拟了一个业务逻辑组件，编译、运行该 Java 程序，这个结果是没有任何悬念的，程序将在控制台打印“Hello AspectJ”字符串。

假设现在客户需要在执行 sayHello() 方法之前启动事务，当该方法执行结束时关闭事务，在传统编程模式下，我们必须手动修改 sayHello() 方法——如果改为使用 AspectJ，则可以无须修改上面的 sayHello() 方法。

下面我们定义一个特殊的 Java 类。

清单 2.TxAspect.java

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 3 4 5 </td> 
 <td style="vertical-align:baseline;"> <code>public aspect TxAspect </code> <code>{ </code> <code>// 指定执行 Hello.sayHello() 方法时执行下面代码块</code> <code>void around():call(void Hello.sayHello()){System.out.println("开始事务 ...");proceed();System.out.println("事务结束 ...");}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

可能读者已经发现了，上面类文件中不是使用 class、interface、enum 在定义 Java 类，而是使用了 aspect ——难道 Java 语言又新增了关键字？没有！上面的 TxAspect 根本不是一个 Java 类，所以 aspect 也不是 Java 支持的关键字，它只是 AspectJ 才能识别的关键字。

上面粗体字代码也不是方法，它只是指定当程序执行 Hello 对象的 sayHello() 方法时，系统将改为执行粗体字代码的花括号代码块，其中 proceed() 代表回调原来的 sayHello() 方法。

正如前面提到的，Java 无法识别 TxAspect.java 文件的内容，所以我们要使用 ajc.exe 命令来编译上面的 Java 程序。为了能在命令行使用 ajc.exe 命令，需要把 AspectJ 安装目录下的 bin 路径（比如 E:\\Java\\AOP\\aspectj1.6\\bin 目录）添加到系统的 PATH 环境变量中。接下来执行如下命令进行编译：

ajc -d . Hello.java TxAspect.java

我们可以把 ajc.exe 理解成 javac.exe 命令，都用于编译 Java 程序，区别是 ajc.exe 命令可识别 AspectJ 的语法；从这个意义上看，我们可以将 ajc.exe 当成一个增强版的 javac.exe 命令。

运行该 Hello 类依然无须任何改变，因为 Hello 类位于 lee 包下。程序使用如下命令运行 Hello 类：

java lee.Hello

运行该程序，将看到一个令人惊喜的结果：

开始事务 ...

Hello AspectJ!

事务结束 ...

从上面运行结果来看，我们完全可以不对 Hello.java 类进行任何修改，同时又可以满足客户的需求：上面程序只是在控制台打印“开始事务 ...”、“结束事务 ...”来模拟了事务操作，实际上我们可用实际的事务操作代码来代替这两行简单的语句，这就可以满足客户需求了。

如果客户再次提出新需求，需要在 sayHello() 方法后增加记录日志的功能，那也很简单，我们再定义一个 LogAspect，程序如下：

清单 3.LogAspect.java

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 3 4 5 6 7 8 9 10 11 12 </td> 
 <td style="vertical-align:baseline;"> <code>public aspect LogAspect </code> <code>{ </code> <code>// 定义一个 PointCut，其名为 logPointcut </code> <code>// 该 PointCut 对应于指定 Hello 对象的 sayHello 方法</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>pointcut logPointcut() </code> <code>:execution(void Hello.sayHello()); </code> <code>// 在 logPointcut 之后执行下面代码块</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>after():logPointcut() </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>{ </code> <code>System.out.println("记录日志 ..."); </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>} </code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

上面程序的粗体字代码定义了一个 Pointcut：logPointcut - 等同于执行 Hello 对象的 sayHello() 方法，并指定在 logPointcut 之后执行简单的代码块，也就是说，在 sayHello() 方法之后执行指定代码块。使用如下命令来编译上面的 Java 程序：

ajc -d . \*.java

再次运行 Hello 类，将看到如下运行结果：

开始事务 ...

Hello AspectJ!

记录日志 ...

事务结束 ...

从上面运行结果来看，通过使用 AspectJ 提供的 AOP 支持，我们可以为 sayHello() 方法不断增加新功能。

为什么在对 Hello 类没有任何修改的前提下，而 Hello 类能不断地、动态增加新功能呢？这看上去并不符合 Java 基本语法规则啊。实际上我们可以使用 Java 的反编译工具来反编译前面程序生成的 Hello.class 文件，发现 Hello.class 文件的代码如下：

清单 4.Hello.class

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 </td> 
 <td style="vertical-align:baseline;"> <code>package lee; </code> &nbsp; <code>import java.io.PrintStream; </code> <code>import org.aspectj.runtime.internal.AroundClosure; </code> &nbsp; <code>public class Hello </code> <code>{ </code> <code>&nbsp;</code><code>public void sayHello() </code> <code>&nbsp;</code><code>{ </code> <code>&nbsp;&nbsp;&nbsp;</code><code>try </code> <code>&nbsp;&nbsp;&nbsp;</code><code>{ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println("Hello AspectJ!"); } catch (Throwable localThrowable) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>LogAspect.aspectOf().ajc$after$lee_LogAspect$1$9fd5dd97(); throw localThrowable; } </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>LogAspect.aspectOf().ajc$after$lee_LogAspect$1$9fd5dd97(); </code> <code>&nbsp;</code><code>} </code> &nbsp; <code>&nbsp;</code><code>... </code> &nbsp; <code>&nbsp;</code><code>private static final void sayHello_aroundBody1$advice(Hello target, </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>TxAspect ajc$aspectInstance, AroundClosure ajc$aroundClosure) </code> <code>&nbsp;</code><code>{ </code> <code>&nbsp;&nbsp;&nbsp;</code><code>System.out.println("开始事务 ..."); </code> <code>&nbsp;&nbsp;&nbsp;</code><code>AroundClosure localAroundClosure = ajc$aroundClosure; sayHello_aroundBody0(target); </code> <code>&nbsp;&nbsp;&nbsp;</code><code>System.out.println("事务结束 ..."); </code> <code>&nbsp;</code><code>} </code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

不难发现这个 Hello.class 文件不是由原来的 Hello.java 文件编译得到的，该 Hello.class 里新增了很多内容——这表明 AspectJ 在编译时“自动”编译得到了一个新类，这个新类增强了原有的 Hello.java 类的功能，因此 AspectJ 通常被称为编译时增强的 AOP 框架。

提示：与 AspectJ 相对的还有另外一种 AOP 框架，它们不需要在编译时对目标类进行增强，而是运行时生成目标类的代理类，该代理类要么与目标类实现相同的接口，要么是目标类的子类——总之，代理类的实例可作为目标类的实例来使用。一般来说，编译时增强的 AOP 框架在性能上更有优势——因为运行时动态增强的 AOP 框架需要每次运行时都进行动态增强。

实际上，AspectJ 允许同时为多个方法添加新功能，只要我们定义 Pointcut 时指定匹配更多的方法即可。如下片段：

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 </td> 
 <td style="vertical-align:baseline;"> <code>pointcut xxxPointcut() </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>:execution(void H*.say*());</code> </td> 
 </tr> 
 </tbody> 
</table>

上面程序中的 xxxPointcut 将可以匹配所有以 H 开头的类中、所有以 say 开头的方法，但该方法返回的必须是 void；如果不想匹配任意的返回值类型，则可将代码改为如下形式：

pointcut xxxPointcut()

:execution(\* H\*.say\*());

关于如何定义 AspectJ 中的 Aspect、Pointcut 等，读者可以参考 AspectJ 安装路径下的 doc 目录里的 quick5.pdf 文件。

## 使用 Spring AOP ##

与 AspectJ 相同的是，Spring AOP 同样需要对目标类进行增强，也就是生成新的 AOP 代理类；与 AspectJ 不同的是，Spring AOP 无需使用任何特殊命令对 Java 源代码进行编译，它采用运行时动态地、在内存中临时生成“代理类”的方式来生成 AOP 代理。

Spring 允许使用 AspectJ Annotation 用于定义方面（Aspect）、切入点（Pointcut）和增强处理（Advice），Spring 框架则可识别并根据这些 Annotation 来生成 AOP 代理。Spring 只是使用了和 AspectJ 5 一样的注解，但并没有使用 AspectJ 的编译器或者织入器（Weaver），底层依然使用的是 Spring AOP，依然是在运行时动态生成 AOP 代理，并不依赖于 AspectJ 的编译器或者织入器。

简单地说，Spring 依然采用运行时生成动态代理的方式来增强目标对象，所以它不需要增加额外的编译，也不需要 AspectJ 的织入器支持；而 AspectJ 在采用编译时增强，所以 AspectJ 需要使用自己的编译器来编译 Java 文件，还需要织入器。

为了启用 Spring 对 @AspectJ 方面配置的支持，并保证 Spring 容器中的目标 Bean 被一个或多个方面自动增强，必须在 Spring 配置文件中配置如下片段：

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 3 4 5 6 7 8 9 10 11 </td> 
 <td style="vertical-align:baseline;"> <code>&lt;?</code><code>xml</code> <code>version</code><code>=</code><code>"1.0"</code> <code>encoding</code><code>=</code><code>"GBK"</code><code>?&gt; </code> <code>&lt;</code><code>beans</code> <code>xmlns</code><code>=</code><code>"http://www.springframework.org/schema/beans"</code> <code>xmlns:xsi</code><code>=</code><code>"http://www.w3.org/2001/XMLSchema-instance"</code> <code>xmlns:aop</code><code>=</code><code>"http://www.springframework.org/schema/aop"</code> <code>xsi:schemaLocation="http://www.springframework.org/schema/beans </code> <code>http://www.springframework.org/schema/beans/spring-beans-3.0.xsd </code> <code>http://www.springframework.org/schema/aop </code> <code>http://www.springframework.org/schema/aop/spring-aop-3.0.xsd"&gt; </code> <code>&lt;!-- 启动 @AspectJ 支持 --&gt;</code> <code>&lt;</code><code>aop:aspectj-autoproxy</code><code>/&gt; </code> <code>&lt;/</code><code>beans</code><code>&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

当然，如果我们希望完全启动 Spring 的“零配置”功能，则还需要启用 Spring 的“零配置”支持，让 Spring 自动搜索指定路径下 Bean 类。

所谓自动增强，指的是 Spring 会判断一个或多个方面是否需要对指定 Bean 进行增强，并据此自动生成相应的代理，从而使得增强处理在合适的时候被调用。

如果不打算使用 Spring 的 XML Schema 配置方式，则应该在 Spring 配置文件中增加如下片段来启用 @AspectJ 支持。

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 3 </td> 
 <td style="vertical-align:baseline;"> <code>&lt;!-- 启动 @AspectJ 支持 --&gt;</code> <code>&lt;</code><code>bean</code> <code>class="org.springframework.aop.aspectj.annotation. </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>AnnotationAwareAspectJAutoProxyCreator"/&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

上面配置文件中的 AnnotationAwareAspectJAutoProxyCreator 是一个 Bean 后处理器（BeanPostProcessor），该 Bean 后处理器将会为容器中 Bean 生成 AOP 代理，

当启动了 @AspectJ 支持后，只要我们在 Spring 容器中配置一个带 @Aspect 注释的 Bean，Spring 将会自动识别该 Bean，并将该 Bean 作为方面 Bean 处理。

在 Spring 容器中配置方面 Bean（即带 @Aspect 注释的 Bean），与配置普通 Bean 没有任何区别，一样使用 <bean.../> 元素进行配置，一样支持使用依赖注入来配置属性值；如果我们启动了 Spring 的“零配置”特性，一样可以让 Spring 自动搜索，并装载指定路径下的方面 Bean。

使用 @Aspect 标注一个 Java 类，该 Java 类将会作为方面 Bean，如下面代码片段所示：

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 3 4 5 6 7 </td> 
 <td style="vertical-align:baseline;"> <code>// 使用 @Aspect 定义一个方面类</code> <code>@Aspect </code> <code>public class LogAspect </code> <code>{ </code> <code>// 定义该类的其他内容</code> <code>... </code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

方面类（用 @Aspect 修饰的类）和其他类一样可以有方法、属性定义，还可能包括切入点、增强处理定义。

当我们使用 @Aspect 来修饰一个 Java 类之后，Spring 将不会把该 Bean 当成组件 Bean 处理，因此负责自动增强的后处理 Bean 将会略过该 Bean，不会对该 Bean 进行任何增强处理。

开发时无须担心使用 @Aspect 定义的方面类被增强处理，当 Spring 容器检测到某个 Bean 类使用了 @Aspect 标注之后，Spring 容器不会对该 Bean 类进行增强。

下面将会考虑采用 Spring AOP 来改写前面介绍的例子：

下面例子使用一个简单的 Chinese 类来模拟业务逻辑组件：

清单 5.Chinese.java

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 </td> 
 <td style="vertical-align:baseline;"> <code>@Component </code> <code>public class Chinese </code> <code>{ </code> <code>// 实现 Person 接口的 sayHello() 方法</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public String sayHello(String name) </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>{ </code> <code>&nbsp;&nbsp;&nbsp;</code><code>System.out.println("-- 正在执行 sayHello 方法 --"); </code> <code>// 返回简单的字符串</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return name + " Hello , Spring AOP"; </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>} </code> <code>// 定义一个 eat() 方法</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public void eat(String food) </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>{ </code> <code>&nbsp;&nbsp;&nbsp;</code><code>System.out.println("我正在吃 :"+ food); </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>} </code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

提供了上面 Chinese 类之后，接下来假设同样需要为上面 Chinese 类的每个方法增加事务控制、日志记录，此时可以考虑使用 Around、AfterReturning 两种增强处理。

先看 AfterReturning 增强处理代码。

清单 6.AfterReturningAdviceTest.java

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 </td> 
 <td style="vertical-align:baseline;"> <code>// 定义一个方面</code> <code>@Aspect </code> <code>public class AfterReturningAdviceTest </code> <code>{ </code> <code>// 匹配 org.crazyit.app.service.impl 包下所有类的、</code> <code>// 所有方法的执行作为切入点</code> <code>@AfterReturning(returning="rvt",</code> <code>pointcut="execution(* org.crazyit.app.service.impl.*.*(..))")</code> <code>public void log(Object rvt) </code> <code>{ </code> <code>System.out.println("获取目标方法返回值 :" + rvt); </code> <code>System.out.println("模拟记录日志功能 ..."); </code> <code>} </code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

上面 Aspect 类使用了 @Aspect 修饰，这样 Spring 会将它当成一个方面 Bean 进行处理。其中程序中粗体字代码指定将会在调用 org.crazyit.app.service.impl 包下的所有类的所有方法之后织入 log(Object rvt) 方法。

再看 Around 增强处理代码：

清单 7.AfterReturningAdviceTest.java

与前面的 AfterReturning 增强处理类似的，此处同样使用了 @Aspect 来修饰前面 Bean，其中粗体字代码指定在调用 org.crazyit.app.service.impl 包下的所有类的所有方法的“前后（Around）” 织入 processTx(ProceedingJoinPoint jp) 方法

需要指出的是，虽然此处只介绍了 Spring AOP 的 AfterReturning、Around 两种增强处理，但实际上 Spring 还支持 Before、After、AfterThrowing 等增强处理，关于 Spring AOP 编程更多、更细致的编程细节，可以参考《轻量级 Java EE 企业应用实战》一书。

本示例采用了 Spring 的零配置来开启 Spring AOP，因此上面 Chinese 类使用了 @Component 修饰，而方面 Bean 则使用了 @Aspect 修饰，方面 Bean 中的 Advice 则分别使用了 @AfterReturning、@Around 修饰。接下来只要为 Spring 提供如下配置文件即可：

清单 8.bean.xml

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 </td> 
 <td style="vertical-align:baseline;"> <code>&lt;?</code><code>xml</code> <code>version</code><code>=</code><code>"1.0"</code> <code>encoding</code><code>=</code><code>"GBK"</code><code>?&gt; </code> <code>&lt;</code><code>beans</code> <code>xmlns</code><code>=</code><code>"http://www.springframework.org/schema/beans"</code> <code>xmlns:xsi</code><code>=</code><code>"http://www.w3.org/2001/XMLSchema-instance"</code> <code>xmlns:context</code><code>=</code><code>"http://www.springframework.org/schema/context"</code> <code>xmlns:aop</code><code>=</code><code>"http://www.springframework.org/schema/aop"</code> <code>xsi:schemaLocation="http://www.springframework.org/schema/beans </code> <code>http://www.springframework.org/schema/beans/spring-beans-3.0.xsd </code> <code>http://www.springframework.org/schema/context </code> <code>http://www.springframework.org/schema/context/spring-context-3.0.xsd </code> <code>http://www.springframework.org/schema/aop </code> <code>http://www.springframework.org/schema/aop/spring-aop-3.0.xsd"&gt; </code> <code>&lt;!-- 指定自动搜索 Bean 组件、自动搜索方面类 --&gt;</code> <code>&lt;</code><code>context:component-scan</code> <code>base-package="org.crazyit.app.service </code> <code>,org.crazyit.app.advice"&gt; </code> <code>&lt;</code><code>context:include-filter</code> <code>type</code><code>=</code><code>"annotation"</code> <code>expression</code><code>=</code><code>"org.aspectj.lang.annotation.Aspect"</code><code>/&gt; </code> <code>&lt;/</code><code>context:component-scan</code><code>&gt; </code> <code>&lt;!-- 启动 @AspectJ 支持 --&gt;</code> <code>&lt;</code><code>aop:aspectj-autoproxy</code><code>/&gt; </code> <code>&lt;/</code><code>beans</code><code>&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

接下来按传统方式来获取 Spring 容器中 chinese Bean、并调用该 Bean 的两个方法，程序代码如下：

清单 9.BeanTest.java

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 3 4 5 6 7 8 9 10 11 12 </td> 
 <td style="vertical-align:baseline;"> <code>public class BeanTest </code> <code>{ </code> <code>public static void main(String[] args) </code> <code>{ </code> <code>// 创建 Spring 容器</code> <code>ApplicationContext ctx = new </code> <code>ClassPathXmlApplicationContext("bean.xml"); </code> <code>Chinese p = ctx.getBean("chinese" ,Chinese.class); </code> <code>System.out.println(p.sayHello("张三")); </code> <code>p.eat("西瓜"); </code> <code>} </code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

从上面开发过程可以看出，对于 Spring AOP 而言，开发者提供的业务组件、方面 Bean 并没有任何特别的地方。只是方面 Bean 需要使用 @Aspect 修饰即可。程序不需要使用特别的编译器、织入器进行处理。

运行上面程序，将可以看到如下执行结果：

执行目标方法之前，模拟开始事务 ...

\-- 正在执行 sayHello 方法 --

执行目标方法之后，模拟结束事务 ...

获取目标方法返回值 : 被改变的参数 Hello , Spring AOP 新增的内容

模拟记录日志功能 ...

被改变的参数 Hello , Spring AOP 新增的内容

执行目标方法之前，模拟开始事务 ...

我正在吃 : 被改变的参数

执行目标方法之后，模拟结束事务 ...

获取目标方法返回值 :null 新增的内容

模拟记录日志功能 ...

虽然程序是在调用 Chinese 对象的 sayHello、eat 两个方法，但从上面运行结果不难看出：实际执行的绝对不是 Chinese 对象的方法，而是 AOP 代理的方法。也就是说，Spring AOP 同样为 Chinese 类生成了 AOP 代理类。这一点可通过在程序中增加如下代码看出：

System.out.println(p.getClass());

上面代码可以输出 p 变量所引用对象的实现类，再次执行程序将可以看到上面代码产生 class org.crazyit.app.service.impl.Chinese$$EnhancerByCGLIB$$290441d2 的输出，这才是 p 变量所引用的对象的实现类，这个类也就是 Spring AOP 动态生成的 AOP 代理类。从 AOP 代理类的类名可以看出，AOP 代理类是由 CGLIB 来生成的。

如果将上面程序程序稍作修改：只要让上面业务逻辑类 Chinese 类实现一个任意接口——这种做法更符合 Spring 所倡导的“面向接口编程”的原则。假设程序为 Chinese 类提供如下 Person 接口，并让 Chinese 类实现该接口：

清单 10.Person.java

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 3 4 5 </td> 
 <td style="vertical-align:baseline;"> <code>public interface Person </code> <code>{ </code> <code>String sayHello(String name); </code> <code>void eat(String food); </code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

接下来让 BeanTest 类面向 Person 接口、而不是 Chinese 类编程。即将 BeanTest 类改为如下形式：

清单 11.BeanTest.java

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 3 4 5 6 7 8 9 10 11 12 13 </td> 
 <td style="vertical-align:baseline;"> <code>public class BeanTest </code> <code>{ </code> <code>public static void main(String[] args) </code> <code>{ </code> <code>// 创建 Spring 容器</code> <code>ApplicationContext ctx = new </code> <code>ClassPathXmlApplicationContext("bean.xml"); </code> <code>Person p = ctx.getBean("chinese" ,Person.class);</code> <code>System.out.println(p.sayHello("张三")); </code> <code>p.eat("西瓜"); </code> <code>System.out.println(p.getClass()); </code> <code>} </code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

原来的程序是将面向 Chinese 类编程，现在将该程序改为面向 Person 接口编程，再次运行该程序，程序运行结果没有发生改变。只是 System.out.println(p.getClass()); 将会输出 class $Proxy7，这说明此时的 AOP 代理并不是由 CGLIB 生成的，而是由 JDK 动态代理生成的。

Spring AOP 框架对 AOP 代理类的处理原则是：如果目标对象的实现类实现了接口，Spring AOP 将会采用 JDK 动态代理来生成 AOP 代理类；如果目标对象的实现类没有实现接口，Spring AOP 将会采用 CGLIB 来生成 AOP 代理类——不过这个选择过程对开发者完全透明、开发者也无需关心。

Spring AOP 会动态选择使用 JDK 动态代理、CGLIB 来生成 AOP 代理，如果目标类实现了接口，Spring AOP 则无需 CGLIB 的支持，直接使用 JDK 提供的 Proxy 和 InvocationHandler 来生成 AOP 代理即可。关于如何 Proxy 和 InvocationHandler 来生成动态代理不在本文介绍范围之内，如果读者对 Proxy 和 InvocationHandler 的用法感兴趣则可自行参考 Java API 文档或《疯狂 Java 讲义》。

## Spring AOP 原理剖析 ##

通过前面介绍可以知道：AOP 代理其实是由 AOP 框架动态生成的一个对象，该对象可作为目标对象使用。AOP 代理包含了目标对象的全部方法，但 AOP 代理中的方法与目标对象的方法存在差异：AOP 方法在特定切入点添加了增强处理，并回调了目标对象的方法。

AOP 代理所包含的方法与目标对象的方法示意图如图 3 所示。

图 3.AOP 代理的方法与目标对象的方法

![图 3.AOP 代理的方法与目标对象的方法][3.AOP]

Spring 的 AOP 代理由 Spring 的 IoC 容器负责生成、管理，其依赖关系也由 IoC 容器负责管理。因此，AOP 代理可以直接使用容器中的其他 Bean 实例作为目标，这种关系可由 IoC 容器的依赖注入提供。

纵观 AOP 编程，其中需要程序员参与的只有 3 个部分：

*  定义普通业务组件。
 *  定义切入点，一个切入点可能横切多个业务组件。
 *  定义增强处理，增强处理就是在 AOP 框架为普通业务组件织入的处理动作。

上面 3 个部分的第一个部分是最平常不过的事情，无须额外说明。那么进行 AOP 编程的关键就是定义切入点和定义增强处理。一旦定义了合适的切入点和增强处理，AOP 框架将会自动生成 AOP 代理，而 AOP 代理的方法大致有如下公式：

代理对象的方法 = 增强处理 + 被代理对象的方法

在上面这个业务定义中，不难发现 Spring AOP 的实现原理其实很简单：AOP 框架负责动态地生成 AOP 代理类，这个代理类的方法则由 Advice 和回调目标对象的方法所组成。

对于前面提到的图 2 所示的软件调用结构：当方法 1、方法 2、方法 3 ……都需要去调用某个具有“横切”性质的方法时，传统的做法是程序员去手动修改方法 1、方法 2、方法 3 ……、通过代码来调用这个具有“横切”性质的方法，但这种做法的可扩展性不好，因为每次都要改代码。

于是 AOP 框架出现了，AOP 框架则可以“动态的”生成一个新的代理类，而这个代理类所包含的方法 1、方法 2、方法 3 ……也增加了调用这个具有“横切”性质的方法——但这种调用由 AOP 框架自动生成的代理类来负责，因此具有了极好的扩展性。程序员无需手动修改方法 1、方法 2、方法 3 的代码，程序员只要定义切入点即可—— AOP 框架所生成的 AOP 代理类中包含了新的方法 1、访法 2、方法 3，而 AOP 框架会根据切入点来决定是否要在方法 1、方法 2、方法 3 中回调具有“横切”性质的方法。

简而言之：AOP 原理的奥妙就在于动态地生成了代理类，这个代理类实现了图 2 的调用——这种调用无需程序员修改代码。接下来介绍的 CGLIB 就是一个代理生成库，下面介绍如何使用 CGLIB 来生成代理类。

## 使用 CGLIB 生成代理类 ##

CGLIB（Code Generation Library），简单来说，就是一个代码生成类库。它可以在运行时候动态是生成某个类的子类。

此处使用前面定义的 Chinese 类，现在改为直接使用 CGLIB 来生成代理，这个代理类同样可以实现 Spring AOP 代理所达到的效果。

下面先为 CGLIB 提供一个拦截器实现类：

清单 12.AroundAdvice.java

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 3 4 5 6 7 8 9 10 11 12 13 </td> 
 <td style="vertical-align:baseline;"> <code>public class AroundAdvice implements MethodInterceptor </code> <code>{ </code> <code>public Object intercept(Object target, Method method </code> <code>, Object[] args, MethodProxy proxy) </code> <code>throws java.lang.Throwable </code> <code>{ </code> <code>System.out.println("执行目标方法之前，模拟开始事务 ..."); </code> <code>// 执行目标方法，并保存目标方法执行后的返回值</code> <code>Object rvt = proxy.invokeSuper(target, new String[]{"被改变的参数"}); </code> <code>System.out.println("执行目标方法之后，模拟结束事务 ..."); </code> <code>return rvt + " 新增的内容"; </code> <code>} </code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

上面这个 AroundAdvice.java 的作用就像前面介绍的 Around Advice，它可以在调用目标方法之前、调用目标方法之后织入增强处理。

接下来程序提供一个 ChineseProxyFactory 类，这个 ChineseProxyFactory 类会通过 CGLIB 来为 Chinese 生成代理类：

清单 13.ChineseProxyFactory.java

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 3 4 5 6 7 8 9 10 11 12 13 </td> 
 <td style="vertical-align:baseline;"> <code>public class ChineseProxyFactory </code> <code>{ </code> <code>public static Chinese getAuthInstance() </code> <code>{ </code> <code>Enhancer en = new Enhancer(); </code> <code>// 设置要代理的目标类</code> <code>en.setSuperclass(Chinese.class);</code> <code>// 设置要代理的拦截器</code> <code>en.setCallback(new AroundAdvice());</code> <code>// 生成代理类的实例 </code> <code>return (Chinese)en.create();</code> <code>} </code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

上面粗体字代码就是使用 CGLIB 的 Enhancer 生成代理对象的关键代码，此时的 Enhancer 将以 Chinese 类作为目标类，以 AroundAdvice 对象作为“Advice”，程序将会生成一个 Chinese 的子类，这个子类就是 CGLIB 生成代理类，它可作为 Chinese 对象使用，但它增强了 Chinese 类的方法。

测试 Chinese 代理类的主程序如下：

清单 14.Main.java

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 3 4 5 6 7 8 9 10 </td> 
 <td style="vertical-align:baseline;"> <code>public class Main </code> <code>{ </code> <code>public static void main(String[] args) </code> <code>{ </code> <code>Chinese chin = ChineseProxyFactory.getAuthInstance(); </code> <code>System.out.println(chin.sayHello("孙悟空")); </code> <code>chin.eat("西瓜"); </code> <code>System.out.println(chin.getClass()); </code> <code>} </code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

运行上面主程序，看到如下输出结果：

执行目标方法之前，模拟开始事务 ...

\-- 正在执行 sayHello 方法 --

执行目标方法之后，模拟结束事务 ...

被改变的参数 Hello , CGLIB 新增的内容

执行目标方法之前，模拟开始事务 ...

我正在吃 : 被改变的参数

执行目标方法之后，模拟结束事务 ...

class lee.Chinese$$EnhancerByCGLIB$$4bd097d9

从上面输出结果来看，CGLIB 生成的代理完全可以作为 Chinese 对象来使用，而且 CGLIB 代理对象的 sayHello()、eat() 两个方法已经增加了事务控制（只是模拟），这个 CGLIB 代理其实就是 Spring AOP 所生成的 AOP 代理。

通过程序最后的输出，不难发现这个代理对象的实现类是 lee.Chinese$$EnhancerByCGLIB$$4bd097d9，这就是 CGLIB 所生成的代理类，这个代理类的格式与前面 Spring AOP 所生成的代理类的格式完全相同。

这就是 Spring AOP 的根本所在：Spring AOP 就是通过 CGLIB 来动态地生成代理对象，这个代理对象就是所谓的 AOP 代理，而 AOP 代理的方法则通过在目标对象的切入点动态地织入增强处理，从而完成了对目标方法的增强。

## 小结 ##

AOP 广泛应用于处理一些具有横切性质的系统级服务，AOP 的出现是对 OOP 的良好补充，它使得开发者能用更优雅的方式处理具有横切性质的服务。不管是那种 Spring实现，不论是 AspectJ、还是 Spring AOP，它们都需要动态地生成一个 AOP 代理类，区别只是生成 AOP 代理类的时机不同：AspectJ 采用编译时生成 AOP 代理类，因此具有更好的性能，但需要使用特定的编译器进行处理；而 Spring AOP 则采用运行时生成 AOP 代理类，因此无需使用特定编译器进行处理。由于 Spring AOP 需要在每次运行时生成 AOP 代理，因此性能略差一些。

转自[https://www.ibm.com/developerworks/cn/java/j-lo-springaopcglib/index.html][https_www.ibm.com_developerworks_cn_java_j-lo-springaopcglib_index.html]

[1]: /images/20220522/619c414bc63649b0ba422527cf6c0e10.png
[2]: /images/20220522/9fa2787785e04f489725a4e167207e1f.png
[3.AOP]: /images/20220522/22426845d91941e0938c564640cf77fc.png
[https_www.ibm.com_developerworks_cn_java_j-lo-springaopcglib_index.html]: https://www.ibm.com/developerworks/cn/java/j-lo-springaopcglib/index.html