[Java] 从 class 文件看 cglib 对 InvocationHandler 的处理使用 cglib 时，有

背景

使用 cglib 时，会用到 $\text{net.sf.cglib.proxy.Callback}$ 的子接口 ⬇️

$\text{net.sf.cglib.proxy.MethodInterceptor}$
$\text{net.sf.cglib.proxy.NoOp}$
$\text{net.sf.cglib.proxy.LazyLoader}$
$\text{net.sf.cglib.proxy.Dispatcher}$
$\text{net.sf.cglib.proxy.InvocationHandler}$
$\text{net.sf.cglib.proxy.FixedValue}$

它们的简要类图如下 ⬇️

在使用 $\text{net.sf.cglib.proxy.InvocationHandler}$ 时，cglib 所生成的动态代理类是怎样的呢？让我们一起探索吧。

注意：本文所提到的 $\text{InvocationHandler}$ 都是 $\text{net.sf.cglib.proxy.InvocationHandler}$ （而非 JDK 中的 $\text{java.lang.reflect.InvocationHandler}$ ）

要点

代码

铺垫

假设有一个逻辑门的接口 ⬇️

public interface LogicGate {
    boolean calculate(boolean... input);
}

我们希望实现与门。一种可行的方法是使用 $\text{net.sf.cglib.proxy.InvocationHandler}$ 来实现与门的逻辑。

项目结构

我们在项目顶层执行 tree . 命令，会看到如下的结果 ⬇️

.
├── pom.xml
└── src
    ├── main
    │   └── java
    │       └── org
    │           └── example
    │               ├── GateFactory.java
    │               └── LogicGate.java
    └── test
        └── java
            └── org
                └── example
                    └── GateFactoryTest.java

10 directories, 4 files

`pom.xml`

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>cglib-study</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>21</maven.compiler.source>
        <maven.compiler.target>21</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13.2</version>
            <scope>test</scope>
        </dependency>
        <!-- Source: https://mvnrepository.com/artifact/cglib/cglib -->
        <dependency>
            <groupId>cglib</groupId>
            <artifactId>cglib</artifactId>
            <version>3.3.0</version>
            <scope>compile</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>3.5.5</version> <!-- Use a recent version -->
                <configuration>
                    <argLine>--add-opens=java.base/java.lang=ALL-UNNAMED</argLine>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

`LogicGate.java`

package org.example;

public interface LogicGate {
    boolean calculate(boolean... input);
}

`GateFactory.java`

package org.example;

import net.sf.cglib.core.DebuggingClassWriter;
import net.sf.cglib.proxy.Enhancer;
import net.sf.cglib.proxy.InvocationHandler;

import java.lang.reflect.Method;

public class GateFactory {

    static {
        // 将 cglib 生成的类保存到当前目录下
        System.setProperty(DebuggingClassWriter.DEBUG_LOCATION_PROPERTY, ".");
    }

    private static final InvocationHandler invocationHandler = new InvocationHandler() {
        private void validateLength(boolean[] input) {
            if (input.length == 0) {
                throw new IllegalArgumentException("And gate should have at least one input!");
            }
        }

        @Override
        public Object invoke(Object proxy, Method method, Object[] args) {
            boolean[] input = (boolean[]) args[0];
            validateLength(input);

            for (boolean item : input) {
                if (!item) {
                    return false;
                }
            }
            return true;
        }
    };

    public static LogicGate buildAndGate() {
        return (LogicGate) Enhancer.create(LogicGate.class, invocationHandler);
    }
}

`GateFactoryTest.java`

package org.example;

import net.sf.cglib.proxy.InvocationHandler;
import org.junit.Assert;
import org.junit.Test;

import java.lang.reflect.Field;

public class GateFactoryTest {

    private final LogicGate andGate = GateFactory.buildAndGate();

    @Test
    public void testBuildAndGate() {
        Assert.assertTrue(andGate.calculate(true, true));
        Assert.assertFalse(andGate.calculate(true, false));
        Assert.assertFalse(andGate.calculate(false, false));
        Assert.assertFalse(andGate.calculate(false, false));
    }

    @Test
    public void testInvocationHandler() throws ReflectiveOperationException {
        Field invocationHandlerField = GateFactory.class.getDeclaredField("invocationHandler");
        invocationHandlerField.setAccessible(true);
        InvocationHandler invocationHandler = (InvocationHandler) invocationHandlerField.get(null);

        Field cglibCallback0Field = andGate.getClass().getDeclaredField("CGLIB$CALLBACK_0");
        cglibCallback0Field.setAccessible(true);
        InvocationHandler cglibCallback0 = (InvocationHandler) cglibCallback0Field.get(andGate);

        Assert.assertSame(invocationHandler, cglibCallback0);
    }
}

LogicGate/GateFactory/GateFactoryTest 这三个类的类图如下 ⬇️

运行

在项目顶层执行如下命令，可以运行单元测试

mvn clean test

运行后，会看到项目顶层多了 net 和 org 这两个目录。执行 tree net org 命令后，会看到如下结果 ⬇️

net
└── sf
    └── cglib
        ├── core
        │   └── MethodWrapper$MethodWrapperKey$$KeyFactoryByCGLIB$$d45e49f7.class
        └── proxy
            └── Enhancer$EnhancerKey$$KeyFactoryByCGLIB$$7fb24d72.class
org
└── example
    └── LogicGate$$EnhancerByCGLIB$$580215af.class

7 directories, 3 files

LogicGate$$EnhancerByCGLIB$$580215af.class 看起来和 LogicGate 直接相关。我们在 Intellij IDEA (Community Edition) 可以看到前者反编译的结果（完整的结果比较长，这里就不展示了）。下方是 LogicGate$$EnhancerByCGLIB$$580215af 的类图

分析

我们来看看 LogicGate$$EnhancerByCGLIB$$580215af 中的 calculate(boolean... var1) 方法 ⬇️

public final boolean calculate(boolean... var1) {
    try {
        InvocationHandler var10000 = this.CGLIB$CALLBACK_0;
        if (var10000 == null) {
            CGLIB$BIND_CALLBACKS(this);
            var10000 = this.CGLIB$CALLBACK_0;
        }

        return (Boolean)var10000.invoke(this, CGLIB$calculate$4, new Object[]{var1});
    } catch (Error | RuntimeException var2) {
        throw var2;
    } catch (Throwable var3) {
        throw new UndeclaredThrowableException(var3);
    }
}

看起来主线逻辑是这样的 ⬇️

以下两者是否为同一个引用呢？

LogicGate$$EnhancerByCGLIB$$580215af 中的 CGLIB$CALLBACK_0 字段
GateFactory 中的 invocationHandler 字段

我用如下的单元测试（上文已提供完整代码）验证了一下 ⬇️ 两者确实为同一个引用