Spring AOP：面向切面编程的最佳实践 ( 一 )

1.AOP思想

1.1.为什么需要面向切面编程

如果在一个类或者多个类的多个业务逻辑方法中, 在开始,结尾部分包含功能相同的代码称之为横切关注点也叫切面, 这种结构可能符合传统的面向对象编程（OOP）的封装特性, 但可能导致代码难以维护和扩展。

面向切面编程是一种编程范式。它允许程序员将横切关注点（cross-cutting concerns）从业务逻辑中分离出来, 单独在特殊的类中编写这些功能代码,而原来的业务逻辑中不再编写与之相关的代码, 但依然会对业务逻辑代码产生影响。

通常这些横切关注点是指那些跨越多个模块或组件的功能，比如日志记录、安全性检查、事务管理等。这样就降低了功能代码与业务逻辑代码的耦合度。

特别指出: AOP 的核心思想是通过预编译或运行时动态代理的方式，在不修改源代码的前提下，对程序动态统一添加额外功能的一种技术。 所以也可能将AOP技术理解为一种方法增加技术。

在 Spring 框架中，AOP 被广泛应用，主要通过 JDK 动态代理和 CGLIB 动态代理实现。Spring AOP 提供了强大的功能来增强 Bean 的行为，使得切面逻辑与核心业务逻辑分离，提升了代码的模块化和可维护性 。

1.2.AOP作用

面向切面编程（AOP是Aspect-Oriented Programming）

我们知道，面向对象的特点是继承、多态和封装。而封装就要求将功能分散到不同的对象中去，这在软件设计中往往称为职责分配。实际上也就是说，让不同的类设计不同的方法。这样代码就分散到一个个的类中去了。这样做的好处是降低了代码的复杂程度，使类可重用。

但是人们也发现，在分散代码的同时，也增加了代码的重复性。什么意思呢？比如说，我们在两个类中，可能都需要在每个方法中做日志。按面向对象的设计方法，我们就必须在两个类的方法中都加入日志的内容。也许他们是完全相同的，但就是因为面向对象的设计让类与类之间无法联系，而不能将这些重复的代码统一起来。

也许有人会说，那好办啊，我们可以将这段代码写在一个独立的类独立的方法里，然后再在这两个类中调用。但是，这样一来，这两个类跟我们上面提到的独立的类就有耦合了，它的改变会影响这两个类。那么，有没有什么办法，能让我们在需要的时候，随意地加入代码呢？这种在运行时，动态地将代码切入到类的指定方法、指定位置上的编程思想就是面向切面的编程。

一般而言，我们管切入到指定类指定方法的代码片段称为切面，而切入到哪些类、哪些方法则叫切入点。有了AOP，我们就可以把几个类共有的代码，抽取到一个切片中，等到需要时再切入对象中去，从而改变其原有的行为。

这样看来，AOP其实只是OOP的补充而已。OOP从横向上区分出一个个的类来，而AOP则从纵向上向对象中加入特定的代码。有了AOP，OOP变得立体了。如果加上时间维度，AOP使OOP由原来的二维变为三维了，由平面变成立体了。从技术上来说，AOP基本上是通过代理机制实现的。

AOP在编程历史上可以说是里程碑式的，对OOP编程是一种十分有益的补充。

2.动态代理与CGLIB代理

在 健身房 类中 多个 方法的开始,结束部分都包含 推荐老师 , 结束提示 等功能代码, 下面我们分别以不同方式实现业务代码与功能代码的分离。

2.0.准备代码

2.0.1.业务类

这是以 健身房类 为例, 包含 三个方法 分别有参, 有返回值的不同结构。

import java.util.Date;
// 健身房类
public class GymBase {

    // 业务 A : 举重训练
    public String  weightLifting() {
        System.out.println( "首先 : 我们为您推荐一位指导老师!" );
        System.out.println( "进行举重训练。" );
        System.out.println( "您在 " + new Date() + " 结束了" + "weightLifting" );
        return "感觉不断在进步!";
    }

    // 业务 B : 瑜伽课
    public void yogaClass(String type) {
        System.out.println( "首先 : 我们为您推荐一位指导老师!" );
        System.out.println( "参加 " + type + " [ 瑜伽课 ]。");
        System.out.println( "您在 " + new Date() + " 结束了" + "yogaClass" );
    }

    // 业务 C : 游泳训练
    public void swimming() {
        System.out.println( "首先 : 我们为您推荐一位指导老师!" );
        System.out.println( "在游泳池里游泳。");
        System.out.println( "您在 " + new Date() + " 结束了" + "swimming" );
    }
}

2.0.2.测试类

public class TestBase {

    public static void main(String[] args) {

        GymBase gymBase = new GymBase();

        gymBase.yogaClass("综合");
        System.out.println("-----");

        String feel = gymBase.weightLifting();
        System.out.println("您的评价是:" + feel );

        System.out.println("-----");
        gymBase.swimming();
    }
}

2.0.3.运行测试

首先 : 我们为您推荐一位指导老师!
参加 综合 [ 瑜伽课 ]。
您在 Fri Aug 02 21:01:32 CST 2024 结束了yogaClass
-----
首先 : 我们为您推荐一位指导老师!
进行举重训练。
您在 Fri Aug 02 21:01:32 CST 2024 结束了weightLifting
您的评价是:感觉不断在进步!
-----
首先 : 我们为您推荐一位指导老师!
在游泳池里游泳。
您在 Fri Aug 02 21:01:32 CST 2024 结束了swimming

2.1.JDK动态代理

Java提供了一个java.lang.reflect.Proxy类和java.lang.reflect.InvocationHandler接口来实现动态代理：

1. 定义接口：目标对象需要实现一个或多个接口。
2. 实现InvocationHandler：创建一个实现了InvocationHandler接口的类，并重写invoke方法，该方法会在代理对象的每个方法调用时执行。
3. 创建代理对象：使用Proxy.newProxyInstance方法创建代理对象，传入目标对象和InvocationHandler的实例。
4. 拦截方法调用：在invoke方法中，可以定义拦截逻辑，例如在目标方法执行前后添加日志或其他行为。

通过动态代理实现 AOP 是 Spring AOP 中常用的一种技术。动态代理允许你在运行时创建一个代理对象，这个代理对象可以拦截目标对象的方法调用，并在方法调用前后执行额外的操作。

2.1.1.调整代码增加接口

接口

public interface IGymProxy {

    // 业务 A : 举重训练
    String weightLifting();

    // 业务 B : 瑜伽课
    void yogaClass(String type);

    // 业务 C : 游泳训练
    void swimming();
}

业务实现类 , 每个方法只有核心业务代码

// 健身房类
public class GymProxyImpl implements IGymProxy {

    // 业务 A : 举重训练
    @Override
    public String  weightLifting() {
        System.out.println( "进行举重训练。" );
        return "感觉不断在进步!";
    }

    // 业务 B : 瑜伽课
    @Override
    public void yogaClass(String type) {
        System.out.println( "参加 " + type + " [ 瑜伽课 ]。");
    }

    // 业务 C : 游泳训练
    @Override
    public void swimming() {
        System.out.println( "在游泳池里游泳。");
    }
}

2.1.2.增加切面类

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.Date;

public class AspectProxy implements InvocationHandler {

    private Object target;

    public Object getTarget() {
        return target;
    }
    public void setTarget(Object target) {
        this.target = target;
    }
    
    //前置的方法
    // 功能 A : 推荐老师
    public void selectMaster(Object[] args) {
        String type = "";
        if (args != null && args.length > 0) {
            type = "根据您的要求: " + Arrays.toString( args );
        }
        System.out.println( "首先 : " + type + " 我们为您推荐一位指导老师!" );
    }

    //后置的方法
    //功能 B : 结束提示
    public void  overTip( Method method ){
        System.out.println( "您在 " + new Date() + " 结束了" + method.getName() );
    }

    @Override
    public Object invoke(Object proxy, Method method, Object[] args)throws Throwable {
        // 功能 A :推荐老师
        selectMaster(args);
        
        // 修改 传入的参数
        if (args != null && args.length > 0) {
            for (int i = 0; i < args.length; i++) {
                args[i] = " { " + args[i] + " } ";
            }
        }
        
        //执行方法
        Object obj=method.invoke(target,args);
        
        // 功能 B : 结束提示
        overTip(method);
        // 修改 返回值
        if (obj!=null) {
            obj = " { " + obj + " } ";
        }
        
        // 方法返回值
        return obj;
    }
}

私有成员变量 target 存储了要被代理的目标对象。通过Setter,Getter两个方法提供了对 target 变量的设置与访问。

重写了invoke方法, 这个方法是 InvocationHandler 接口的核心方法，它会在代理对象的方法被调用时触发。

在方法中 调用另外两个方法来增加功能 , 同时在方法内还 修改了 接收到的参数 及方法执行后的返回值。

2.1.3.测试类

import java.lang.reflect.Proxy;

public class TestProxy {

    public static void main(String[] args) {

        IGymProxy gym = new GymProxyImpl();
        AspectProxy aspectProxy = new AspectProxy();
        aspectProxy.setTarget(gym);

        IGymProxy gymProxy=(IGymProxy) Proxy.newProxyInstance(gym.getClass().getClassLoader(), gym.getClass().getInterfaces(), aspectProxy);

        gymProxy.yogaClass("综合");
        System.out.println("-----");

        String feel = gymProxy.weightLifting();
        System.out.println("您的评价是:" + feel );

        System.out.println("-----");
        gymProxy.swimming();
    }
}

使用 Proxy.newProxyInstance 方法创建代理对象。这个方法需要三个参数：

• ClassLoader：设置代码使用的类装载器,一般采用跟目标对象相同的类装载器

• Class<?>[] interfaces：目标对象实现的接口数组。

• InvocationHandler h：实现了 InvocationHandler 接口的对象，用于处理方法调用。

  ​ 当代理对象的方法被调用时, 会委派给该参数指定对象的invoke方法

2.1.4.运行测试

首先 : 根据您的要求: [综合] 我们为您推荐一位指导老师!
参加  { 综合 }  [ 瑜伽课 ]。
您在 Fri Aug 02 21:27:40 CST 2024 结束了yogaClass
-----
首先 :  我们为您推荐一位指导老师!
进行举重训练。
您在 Fri Aug 02 21:27:40 CST 2024 结束了weightLifting
您的评价是: { 感觉不断在进步! } 
-----
首先 :  我们为您推荐一位指导老师!
在游泳池里游泳。
您在 Fri Aug 02 21:27:40 CST 2024 结束了swimming

2.2.CGLIB代理

CGLIB（Code Generation Library）是一个强大的,高性能,高质量的Code生成类库。它可以在运行期扩展Java类与实现Java接口。

CGLIB包的底层是通过使用一个小而快的字节码处理框架ASM，来转换字节码并生成新的类。

CGLIB用于AOP，jdk中的proxy必须基于接口，CGLIB却没有这个限制。

1. 使用CGLIB库：CGLIB是一个强大的高性能代码生成库，它可以在运行时扩展Java类和实现接口。
2. 创建Enhancer对象：使用CGLIB的Enhancer类创建一个增强器对象。
3. 设置父类：通过setSuperclass方法设置需要被代理的目标类。
4. 生成代理对象：调用create方法生成代理对象。

2.2.0.导入依赖

        <dependency>
            <groupId>cglib</groupId>
            <artifactId>cglib</artifactId>
            <version>3.3.0</version>
        </dependency>

或者

<!-- https://mvnrepository.com/artifact/cglib/cglib-nodep -->
<dependency>
    <groupId>cglib</groupId>
    <artifactId>cglib-nodep</artifactId>
    <version>3.3.0</version>
</dependency>

cglib 和 cglib-nodep 是 CGLIB 库的不同版本或配置：

1. cglib:
   • 这是 CGLIB 的标准版本，它可能依赖于其他类库（如 ASM，这是一个字节码操作和分析框架），或者包含了一些额外的功能和组件。
   • 当你使用这个版本时，你需要确保你的项目中没有与其他依赖冲突的问题。
2. cglib-nodep:
   • “nodep”意味着“no dependencies”，即这个版本没有外部依赖。
   • cglib-nodep 版本包含了所有必要的代码，并且不需要其他类库就能工作。
   • 它是一个独立的版本，可以作为一个单独的 JAR 文件添加到项目中，而不用担心与其他已存在的类库冲突。
   • 这个版本通常用于那些希望避免不必要的依赖关系的项目。

2.2.1.重新修改业务类

// 健身房类
public class GymCglib {

    // 业务 A : 举重训练
    public String  weightLifting() {
        System.out.println( "进行举重训练。" );
        return "感觉不断在进步!";
    }

    // 业务 B : 瑜伽课
    public void yogaClass(String type) {
        System.out.println( "参加 " + type + " [ 瑜伽课 ]。");
    }

    // 业务 C : 游泳训练
    public void swimming() {
        System.out.println( "在游泳池里游泳。");
    }
}

2.2.2.增加切面类

package com.yuan.cglib;

import net.sf.cglib.proxy.Enhancer;
import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;

import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.Date;

public class AspectCglib implements MethodInterceptor{

    private Object targetObject;

    public Object createProxyIntance(Object targetObject)  {
        this.targetObject = targetObject;
        //该类用于生成代理对象
        Enhancer enhancer = new Enhancer();
        //设置被代理类字节码，CGLIB根据字节码生成被代理类的子类
        enhancer.setSuperclass(this.targetObject.getClass());
        //设置回调用对象为本身
        enhancer.setCallback(this);
        return enhancer.create();
    }

    //前置的方法
    // 功能 A : 推荐老师
    public void selectMaster(Object[] args) {
        String type = "";
        if (args != null && args.length > 0) {
            type = "根据您的要求: " + Arrays.toString( args );
        }
        System.out.println( "首先 : " + type + " 我们为您推荐一位指导老师!" );
    }

    //后置的方法
    //功能 B : 结束提示
    public void  overTip( Method method ){
        System.out.println( "您在 " + new Date() + " 结束了" + method.getName() );
    }

    public Object intercept(Object object, Method method, Object[] args,MethodProxy methodProxy) throws Throwable {

        // 功能 A :  推荐老师
        selectMaster(args);

        // 修改 传入的参数
        if (args != null && args.length > 0) {
            for (int i = 0; i < args.length; i++) {
                args[i] = " { " + args[i] + " } ";
            }
        }

        //执行方法
        Object obj=method.invoke(this.targetObject, args);

        // 功能 B : 结束提示
        overTip(method);

        // 修改 返回值
        if (obj!=null) {
            obj = " { " + obj + " } ";
        }
        
        // 方法返回值
        return obj;
    }
}

2.2.3.测试类

public class TestCglib {

    public static void main(String[] args)  {

        AspectCglib aspectCglib = new AspectCglib();

        GymCglib gymCglib = (GymCglib) aspectCglib.createProxyIntance(new GymCglib());

        gymCglib.yogaClass("综合");
        System.out.println("-----");

        String feel = gymCglib.weightLifting();
        System.out.println("您的评价是:" + feel );

        System.out.println("-----");
        gymCglib.swimming();

    }
}

​ 通过使用AspectCglib的代理创建功能，实例化一个GymCglib的代理对象，
​ 以便在不直接修改GymCglib类代码的情况下，增加额外的功能或行为，实现对GymCglib对象的方法调用的增强。

2.2.4.运行测试

首先 : 根据您的要求: [综合] 我们为您推荐一位指导老师!
参加  { 综合 }  [ 瑜伽课 ]。
您在 Fri Aug 02 21:33:44 CST 2024 结束了yogaClass
-----
首先 :  我们为您推荐一位指导老师!
进行举重训练。
您在 Fri Aug 02 21:33:44 CST 2024 结束了weightLifting
您的评价是: { 感觉不断在进步! } 
-----
首先 :  我们为您推荐一位指导老师!
在游泳池里游泳。
您在 Fri Aug 02 21:33:44 CST 2024 结束了swimming