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 限制。整个示例包括三个模块:

  1. agent:字节码增强代理,实现增强逻辑。

  2. attacher:Attach 工具,通过 Attach API 将代理动态注入到目标 JVM。

  3. 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,最后再次打印格式化结果,以验证增强效果。


四 验证步骤

  1. 构建各模块

    mvn clean package
  2. 启动测试应用

    java -cp testapp-1.0-SNAPSHOT.jar app.DruidTest
  3. 查询应用 PID

    jps
    # 例如输出: 16498 DruidTest
  4. 注入增强 Agent

    java -cp attacher-1.0-SNAPSHOT.jar attacher.AttachMain agent/target/agent-shaded.jar 16498
  5. 观察输出

    • Before agent:

      SELECT id
      FROM ods__order
    • 注入日志:

      [Agent] Enhancing SQLUtils.format...
    • After agent:

      SELECT id
      FROM ods__order
      LIMIT 100

五 原理解析

  1. Java Attach 机制

    • Attach API 是 JDK 提供的工具,可动态向运行中的 JVM 进程注入 agent,而无需重启。

    • 通过 VirtualMachine.attach(pid) 方法连接目标 JVM,再调用 loadAgent(path) 注入 agent jar。

  2. Byte Buddy

    • 高级字节码操作库,提供易用的 DSL 定义增强规则。

    • 支持重定义(redefinition)和重转换(retransformation)两种策略。本文使用重转换,使已有类能够在运行时更新方法实现。

  3. Advice 机制

    • Byte Buddy 的 Advice 注解可在方法入口或退出时插入自定义逻辑,类似 AOP 切面。

    • 通过 @Advice.OnMethodEnter 标注的方法可修改参数或执行前置逻辑。

本文示例展示了如何结合 Java Attach 与 Byte Buddy,在运行时对第三方库(Druid)的 SQLUtils.format 方法进行无感知增强,无需修改原始代码,且对生产环境影响极小。此思路同样适用于其他需要动态增强的场景,如监控、埋点、執行权限控制等。希望本文能帮助读者快速上手该技术并在项目中灵活应用。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如若转载,请注明出处:http://www.pswp.cn/news/916279.shtml
繁体地址,请注明出处:http://hk.pswp.cn/news/916279.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

2025第五届生物发酵营养源高峰论坛

一、会议时间会议时间:2025年8月8日二、会议地点上海新国际博览中心–W4馆现场2号会议室三、组织单位主办单位:中国生物发酵产业协会承办单位:浙江工业大学乐斯福集团Procelys 乐斯福发酵营养元参会福利&#xff0c;助力高效交流为提升参会体验&#xff0c;组委会特别推出多项福…

Kubernetes 配置管理

这里写目录标题什么是 ConfigMap创建 ConfigMap基于目录创建 ConfigMap创建 conf 目录&#xff0c;里面放置两个文件基于目录下的所有文件创建 ConfigMap查看当前创建的 ConfigMap基于文件创建 ConfigMap创建测试文件 game-cfg基于单个文件创建 ConfigMap查看当前创建的 Config…

ESP32+MicroPython:用Python玩转物联网开发

什么是ESP32&#xff1f; ESP32作为当下最热门的物联网开发板&#xff0c;常被比作"嵌入式世界的瑞士军刀"。但很多初学者会混淆芯片、模组和开发板的概念&#xff0c;其实它们的关系很简单&#xff1a; 芯片(Soc)&#xff1a;核心处理器&#xff0c;如ESP32-D0WD模…

opencv学习(图像金字塔)

1.什么是图像金字塔图像金字塔是一种多尺度图像表示方法&#xff0c;通过对原始图像进行下采样&#xff08;缩小&#xff09;和上采样&#xff08;放大&#xff09;&#xff0c;生成一系列不同分辨率的图像集合&#xff0c;形似 “金字塔”&#xff08;底部是高分辨率原始图像&…

从 C# 到 Python:项目实战第五天的飞跃

在前面三天的学习中&#xff0c;我们已经掌握了 Python 的基础语法、数据结构以及一些核心库的使用。今天&#xff0c;我们将通过三个实战项目&#xff0c;深入对比 C# 和 Python 在命令行工具开发、Web 应用开发以及数据处理方面的差异&#xff0c;感受 Python 在实际项目中的…

rabbitmq 03

一、mq的作用和使用场景 MQ的基本作用 MQ&#xff08;Message Queue&#xff0c;消息队列&#xff09;是一种应用程序对应用程序的通信方法&#xff0c;主要作用包括&#xff1a; 异步处理&#xff1a;解耦生产者和消费者&#xff0c;允许生产者发送消息后立即返回&#xff0…

Ubuntu 24.04 显示中文+使用中文键盘

ubuntu 24.04 中文显示中文键盘Ubuntu中文输入重启iBus服务Ubuntu中文输入 安装的Ubuntu24.04&#xff0c;一般默认是英文的&#xff0c;要使用中文的话&#xff0c;可以通过命令行设置&#xff0c;也可以使用‘设置’&#xff0c;在图形化界面中操作。 下面是在‘设置’的图形…

Docker实战:Tomcat容器从部署到自定义网页的完整操作

Docker实战&#xff1a;Tomcat容器从部署到自定义网页的完整操作 继Nginx容器部署后&#xff0c;我们再来实操Tomcat容器的使用——从拉取镜像、启动容器&#xff0c;到端口映射、网页挂载&#xff0c;全程通过实际命令演示&#xff0c;带你掌握Tomcat在Docker中的核心用法。 一…

使用cherry studio离线搭建私人知识库流程记录

本篇文章记录近期尝试在个人笔记本上、全离线状态下搭建知识库的流程。用到的工具包括&#xff1a;Cherry Studio、ollama。主要过程是&#xff1a;首先下载ollama用于管理大模型&#xff1b;然后&#xff0c;从魔塔社区下载需要的deepseek、千问大模型和bge-m3嵌入模型&#x…

【工具类】Linux 环境利用 uv 安装多版本 python

文章目录前置工作环境说明如果kali无法访问网络pypi 换源安装 uvuv 写入环境变量临时写入永久写入无法打开 github 解决方案&#xff08;注意此方法可能也会失效&#xff09;安装多版本 python查看已安装的pythonuv python install到 uv 的 github 主页&#xff0c;找安装文件下…

求职招聘小程序源码招聘小程序开发定制

身份&#xff1a;求职者、企业求职者&#xff1a;完善简历&#xff0c;简历投递企业&#xff1a;企业入驻&#xff0c;查看简历企业会员&#xff1a;半年 、年度 权益&#xff1a;每日发布条数、刷新条数&#xff0c;简历下载数量聊天&#xff1a;求职者可以和企业聊天招聘会…

Git 使用全指南:从配置到免密登录

Git 使用全指南&#xff1a;从配置到免密登录一、Git 基础配置二、Git 代码提交流程2.1 克隆远程仓库2.2 创建并切换分支2.3 暂存文件2.4 提交到本地仓库2.5 拉取远程最新代码2.6 推送本地分支到远程三、VSCode 服务器免密登录配置3.1 生成 Windows SSH 密钥3.2 复制公钥到服务…

组合期权:领式策略

文章目录0.简介1.多头领式策略&#xff08;Long Collar&#xff09;​1.1 策略构成1.2 适用场景​1.3 损益分析1.4 案例示范2.空头领式策略&#xff08;Short Collar&#xff09;​2.1 策略构成2.2 适用场景2.3 损益分析2.4 案例示范参考文献0.简介 领式策略&#xff08;Colla…

ECSPI控制器

目录 SPI协议简介 极性与相位 SPI框图 单字节收发 发送数据流程 接收数据流程 ECSPI控制器 关键特性 时钟源 主机模式 等待状态 片选控制 单突发传输 多突发传输 相位控制 ECSPI Memory Map ECSPI寄存器 ECSPIx_RXDATA ECSPIx_TXDATA ​编辑 ECSPIx_CONREG …

HTTP 与 SpringBoot 参数提交与接收协议方式

HTTP 协议支持多种参数提交方式&#xff0c;主要取决于请求方法(Method)和内容类型(Content-Type)。以下是主要的参数提交协议&#xff1a;1. URL 查询参数 (Query Parameters)请求方法: GET (也可用于其他方法)格式: ?key1value1&key2value2示例: GET /users?id123&…

Lua(数组)

Lua 数组基础概念Lua 中的数组实际上是用整数索引的 table&#xff0c;是一种特殊形式的表。数组索引通常从 1 开始&#xff08;Lua 惯例&#xff09;&#xff0c;但也可以从其他值开始。创建数组通过表构造器初始化数组&#xff1a;-- 索引从 1 开始的数组 local arr {10, …

【Docker项目实战】在Docker环境下部署go-file文件分享工具

【Docker项目实战】在Docker环境下部署go-file文件分享工具一、go-file介绍1.1 go-file简介1.2 go-file特点1.3 go-file使用场景二、本地环境介绍2.1 本地环境规划2.2 本次实践介绍三、本地环境检查3.1 检查Docker服务状态3.2 检查Docker版本3.3 检查docker compose 版本四、下…

C++基础学习——文件操作详解

一、文件流类概述 C 标准库提供了三个主要的文件流类&#xff1a; ifstream (输入文件流)&#xff1a;用于从文件读取数据ofstream (输出文件流)&#xff1a;用于向文件写入数据fstream (文件流)&#xff1a;既可读又可写 这些类都继承自 iostream 类&#xff0c;因此可以使用 …

Android补全计划 DrawerLayout使用

DrawerLayout其实用了很久了&#xff0c;甚至封装了一些代码方便不同项目使用&#xff0c;但重构代码的时候突然意识到这块内容很不成体系&#xff0c;因此又参考了些文档&#xff0c;组建了自己的一个文档。 toolbardrawerlayout能写的效果很多&#xff0c;在此我也只是截取了…

人工智能之数学基础:概率论之韦恩图的应用

韦恩图的应用由于事件的计算有时候太过于抽象了&#xff0c;此时我们可以使用韦恩图的方式来进行验证&#xff0c;我们下面来举一个例子&#xff0c;A∪B&#xff09;-CA∪(B-C)是否成立&#xff1f;我们可以通过韦恩图来完成这个任务&#xff1a;我们通过这种方式来一点一点的…