Java高级之基于Java Attach与Byte-Buddy实现SQL语句增强
目录
一 Agent 模块
1 HookAgent.java
2 FormatAdvice.java
3 配置文件
二 Attacher 模块
1 AttachMain.java
三 测试模块
1 DruidTest.java
四 验证步骤
五 原理解析
笔者目标写一款数据分析中间件，用来增强当前主流开源项目，前几天写了一票用Byte-Buddy对外部类库进行增强的方案，但此方案需要在启动java进程时指定javaagent参数，虽然方案更可靠，但依然觉得对源系统有侵入性。本文针对上一篇文章基础上实现的完全无侵入增强技术方案。
在 Java 应用开发过程中，我们常常需要对第三方库或框架的行为进行增强或定制，以满足特定的业务需求。然而，由于对源代码不可控或不希望对其进行永久修改，如何在运行时对已有类的方法进行非侵入式动态增强就成为一个重要课题。
本文将详细介绍如何结合 Java Attach 机制与 Byte Buddy 库，在不修改原始字节码文件（非持久化修改）的前提下，对 com.alibaba.druid.sql.SQLUtils.format 方法进行增强，自动为所有符合条件的 SQL 语句追加 LIMIT 限制。整个示例包括三个模块：
-
agent：字节码增强代理，实现增强逻辑。
-
attacher：Attach 工具，通过 Attach API 将代理动态注入到目标 JVM。
-
testapp：测试应用，演示增强前后输出对比。
-
项目结构
父工程采用 Maven 聚合项目（packaging 为
pom），包含三个子模块： -
-
agent：构建可重定义/重转字节码的 shaded agent jar。
-
attacher：封装 AttachMain 主程序，用于将 agent 注入到运行中的 JVM。
-
testapp：依赖 Druid，演示 SQL 格式化前后对比。
-
-
父工程 POM
父工程 POM 定义了聚合构建与模块列表：
<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>code-gen</artifactId><version>1.0-SNAPSHOT</version><modules><module>agent</module><module>attacher</module><module>testapp</module></modules><packaging>pom</packaging> <name>code-gen</name><url>http://maven.apache.org</url> <properties><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding></properties> </project>
此 POM 仅用于聚合，明确了三个模块的相对路径与构建顺序。
一 Agent 模块
Agent 模块主要依赖 Byte Buddy，并通过 Maven Shade Plugin 打包为一个支持重定义和重转换的 agent jar。核心配置如下：
<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"><parent><artifactId>code-gen</artifactId><groupId>org.example</groupId><version>1.0-SNAPSHOT</version></parent><modelVersion>4.0.0</modelVersion> <artifactId>agent</artifactId><packaging>jar</packaging> <name>agent</name><url>http://maven.apache.org</url> <properties><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding></properties> <dependencies><!-- Byte Buddy 核心库 --><dependency><groupId>net.bytebuddy</groupId><artifactId>byte-buddy</artifactId><version>1.14.12</version></dependency> <!-- 字节码增强支持 --><dependency><groupId>net.bytebuddy</groupId><artifactId>byte-buddy-agent</artifactId><version>1.14.12</version></dependency> <!-- ASM 字节码操作 --><dependency><groupId>org.ow2.asm</groupId><artifactId>asm</artifactId><version>9.6</version></dependency> </dependencies> <build><finalName>agent-shaded</finalName><plugins><!-- 构建 shaded agent jar --><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><version>3.5.0</version><executions><execution><phase>package</phase><goals><goal>shade</goal></goals></execution></executions><configuration><createDependencyReducedPom>false</createDependencyReducedPom><transformers><transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"><mainClass>agent.HookAgent</mainClass><manifestEntries><Agent-Class>agent.HookAgent</Agent-Class><Can-Redefine-Classes>true</Can-Redefine-Classes><Can-Retransform-Classes>true</Can-Retransform-Classes></manifestEntries></transformer></transformers></configuration></plugin> <!-- 编译插件 --><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-compiler-plugin</artifactId><version>3.10.1</version><configuration><source>8</source><target>8</target></configuration></plugin></plugins></build> </project>
1 HookAgent.java
代理入口实现了 agentmain 方法，用于 Attach 注入后的逻辑：
package agent;
import net.bytebuddy.agent.builder.AgentBuilder;
import net.bytebuddy.asm.Advice;
import net.bytebuddy.matcher.ElementMatchers;
import java.lang.instrument.Instrumentation;
public class HookAgent {public static void agentmain(String args, Instrumentation inst) {try{System.out.println("[Agent] Enhancing SQLUtils.format...");new AgentBuilder.Default().with(AgentBuilder.RedefinitionStrategy.RETRANSFORMATION).type(ElementMatchers.named("com.alibaba.druid.sql.SQLUtils")).transform((builder, td, cl, module, pd) -> builder.method(ElementMatchers.named("format").and(ElementMatchers.takesArguments(2)).and(ElementMatchers.takesArgument(0, String.class))).intercept(Advice.to(FormatAdvice.class))).installOn(inst);}catch (Throwable t){System.err.println("Agent init failed: ");t.printStackTrace();}}
}
该逻辑通过 Byte Buddy 定位到 SQLUtils.format(String, DbType) 方法，并将其拦截，委托给 FormatAdvice。
2 FormatAdvice.java
增强逻辑的具体实现：
package agent;
import net.bytebuddy.asm.Advice;
public class FormatAdvice {
@Advice.OnMethodEnterpublic static void onEnter(@Advice.Argument(value = 0, readOnly = false) String sql) {if (sql == null || sql.toLowerCase().contains("limit")) return;
sql = sql.trim();if (sql.endsWith(";")) {sql = sql.substring(0, sql.length() - 1);}sql += " LIMIT 100";}
}
在方法执行入口，将不含 limit 的 SQL 自动追加 LIMIT 100。
3 配置文件
resources/META-INF/MANIFEST.MF
Manifest-Version: 1.0 Agent-Class: agent.HookAgent Can-Redefine-Classes: true Can-Retransform-Classes: true
二 Attacher 模块
Attacher 模块依赖 JDK 自带的 tools.jar，封装 Attach API 调用：
<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"><parent><artifactId>code-gen</artifactId><groupId>org.example</groupId><version>1.0-SNAPSHOT</version></parent><modelVersion>4.0.0</modelVersion> <artifactId>attacher</artifactId><packaging>jar</packaging> <name>attacher</name><url>http://maven.apache.org</url> <properties><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding></properties> <dependencies><dependency><groupId>com.sun</groupId><artifactId>tools</artifactId><version>1.8.0</version><scope>system</scope><!-- 替换成自己的 --><systemPath>/Library/Java/JavaVirtualMachines/jdk1.8.0_333.jdk/Contents/Home/lib/tools.jar</systemPath></dependency></dependencies> <build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><version>3.5.0</version><executions><execution><phase>package</phase><goals><goal>shade</goal></goals><configuration><transformers><transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"><mainClass>attacher.AttachMain</mainClass></transformer></transformers></configuration></execution></executions></plugin><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-compiler-plugin</artifactId><configuration><source>8</source><target>8</target></configuration></plugin></plugins></build> </project>
1 AttachMain.java
package attacher;
import com.sun.tools.attach.VirtualMachine;
public class AttachMain {public static void main(String[] args) throws Exception {if (args.length != 2) {System.out.println("Usage: java AttachMain <agent-path> <PID>");return;}VirtualMachine vm = VirtualMachine.attach(args[1]);vm.loadAgent(args[0]);vm.detach();}
}
通过传入 agent JAR 路径与目标 JVM PID，即可在运行时注入 HookAgent。无需重启服务。
三 测试模块
依赖 Druid，用于演示增强前后 SQL 格式化输出：
<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"><parent><artifactId>code-gen</artifactId><groupId>org.example</groupId><version>1.0-SNAPSHOT</version></parent><modelVersion>4.0.0</modelVersion> <artifactId>testapp</artifactId><packaging>jar</packaging> <name>testapp</name><url>http://maven.apache.org</url> <properties><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding></properties> <dependencies><dependency><groupId>com.alibaba</groupId><artifactId>druid</artifactId><version>1.2.18</version></dependency></dependencies> <build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><version>3.5.0</version><executions><execution><phase>package</phase><goals><goal>shade</goal></goals><configuration><transformers><transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"><mainClass>app.DruidTest</mainClass></transformer></transformers></configuration></execution></executions></plugin></plugins></build> </project>
1 DruidTest.java
package app;
import com.alibaba.druid.DbType;
import com.alibaba.druid.sql.SQLUtils;
/** 测试步骤* 1 启动服务: java -cp testapp-1.0-SNAPSHOT.jar app.DruidTest* 2 查看服务PID: jps => 16498 DruidTest* 3 注入增强: java --add-modules jdk.attach -cp attacher-1.0-SNAPSHOT.jar attacher.AttachMain agent/target/agent-shaded.jar xxx* 执行结果：* Before agent:* SELECT id* FROM ods__order* [Agent] Enhancing SQLUtils.format...* After agent:* [Agent] Modified SQL: SELECT id FROM ods__order LIMIT 100* SELECT id* FROM ods__order* LIMIT 100*/
public class DruidTest {public static void main(String[] args) throws Exception {String sql = "SELECT id FROM ods__order";System.out.println("Before agent:");System.out.println(SQLUtils.format(sql, DbType.mysql));
Thread.sleep(60000); // 等待 Attach 注入
System.out.println("After agent:");System.out.println(SQLUtils.format(sql, DbType.mysql));}
}
程序启动后，先打印原始格式化结果，然后等待 60 秒，期间可通过 Attacher 工具注入 agent，最后再次打印格式化结果，以验证增强效果。
四 验证步骤
-
构建各模块
mvn clean package
-
启动测试应用
java -cp testapp-1.0-SNAPSHOT.jar app.DruidTest
-
查询应用 PID
jps # 例如输出: 16498 DruidTest
-
注入增强 Agent
java -cp attacher-1.0-SNAPSHOT.jar attacher.AttachMain agent/target/agent-shaded.jar 16498
-
观察输出
-
Before agent:
SELECT id FROM ods__order
-
注入日志:
[Agent] Enhancing SQLUtils.format...
-
After agent:
SELECT id FROM ods__order LIMIT 100
-
五 原理解析
-
Java Attach 机制：
-
Attach API 是 JDK 提供的工具，可动态向运行中的 JVM 进程注入 agent，而无需重启。
-
通过
VirtualMachine.attach(pid)方法连接目标 JVM，再调用loadAgent(path)注入 agent jar。
-
-
Byte Buddy：
-
高级字节码操作库，提供易用的 DSL 定义增强规则。
-
支持重定义（redefinition）和重转换（retransformation）两种策略。本文使用重转换，使已有类能够在运行时更新方法实现。
-
-
Advice 机制：
-
Byte Buddy 的 Advice 注解可在方法入口或退出时插入自定义逻辑，类似 AOP 切面。
-
通过
@Advice.OnMethodEnter标注的方法可修改参数或执行前置逻辑。
-
本文示例展示了如何结合 Java Attach 与 Byte Buddy，在运行时对第三方库（Druid）的 SQLUtils.format 方法进行无感知增强，无需修改原始代码，且对生产环境影响极小。此思路同样适用于其他需要动态增强的场景，如监控、埋点、執行权限控制等。希望本文能帮助读者快速上手该技术并在项目中灵活应用。