背景
在前段时间，我们部门升级了mybati-plus(以下简称mp)的版本，官方在新版的mp中去掉了性能监控的intercept，导致无法像以前一样进行打印完整的sql。mp官方说是可以使用p6spy解决，但是这个需要在项目中引入额外的jar包，开发随便引入额外的jar包可能会出现意想不到的问题（主要是咱也做不了主）。而mybatis原生的sql日志，在遇到问题想要获取到sql时非常麻烦，特别是参数较多的情况下。于是就在思考有没有一种技术既可以简单的获取我想要的sql语句呢。经过研究发现可以利用JavaAgent技术和javassist字节码插装技术，可以做到无侵入式的打印完整的sql。
技术简介
- JavaAgent
JavaAgent相当于一个插件，在JVM启动的时候可以添加 JavaAgent配置指定启动之前需要启动的agent jar包，例如 java –javaagent:myagent.jar –jar main.jar。
这样在程序启动的时候会去执行myagent.jar包中MANIFEST.MF文件指定的类中的premain方法。Javaagent可以分为两种，上面提到的是其中一种，在主程序之前运行的Agent，另一种则是在JDK1.6之后提供的主程序之后运行的Agent，MANIFEST.MF文件指定的类中的agentmain方法（前者是JDK1.5提供的）。
- Javassist
Javassist是可以动态编辑Java字节码的类库。例如，可以在java程序运行过程中用代码写一个新的类，并加载到jvm中使用；可以在类加载过程中对类进行修改（这里我们就是用到这个特性）
使用流程如下：
使用流程图
需求分析
想要获取完整额sql，可以从orm框架入手，但是orm本身就兼容很多数据库，复杂度会比较高，需要实现的细节也比较多，市面上能说出来的就有hibernate，mybatis，jdbctemplate（这个好像不算orm），spring data jpa（基于hibernate）等等。所以引出了一个问题，如果项目里面没用orm，纯粹用jdbc怎么办呢？
- 结论
直接上结论吧，直接从jdbc的驱动下手，经过漫长的研究分析调试代码，发现jdbc里面有三个方法，可以直接获取sql(java.sql.Statement这里直接忽略了)
java.sql.PreparedStatement#execute
java.sql.PreparedStatement#executeUpdate
java.sql.PreparedStatement#executeQuery
实现
想要实现这个功能还是需要每个jdbc驱动去逐个适配的，我这里只实现了postgreDB的，其他数据库可以去跟踪下源码，找到驱动中PreparedStatement的实现类，自己改下就可以了
这里代码量非常少，直接上代码
- pom文件
<?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>xyz.dava</groupId>
<artifactId>sql-agent</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>org.javassist</groupId>
<artifactId>javassist</artifactId>
<version>3.28.0-GA</version>
</dependency>
<!-- 偷个懒，sql美化，不是必须 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.2.8</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<configuration>
<descriptorRefs>
<descriptorRef>jar-with-dependencies</descriptorRef>
</descriptorRefs>
<archive>
<manifestEntries>
<Premain-Class>xyz.dava.agent.sql.Main</Premain-Class>
<Agent-Class>xyz.dava.agent.sql.Main</Agent-Class>
<Can-Redefine-Classes>true</Can-Redefine-Classes>
<Can-Retransform-Classes>true</Can-Retransform-Classes>
</manifestEntries>
</archive>
</configuration>
<executions>
<execution>
<goals>
<goal>attached</goal>
</goals>
<phase>package</phase>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
- 代码
package xyz.dava.agent.sql;
import com.alibaba.druid.sql.SQLUtils;
import javassist.ClassPool;
import javassist.CtClass;
import javassist.CtMethod;
import javassist.CtNewMethod;
import javassist.LoaderClassPath;
import java.lang.instrument.ClassFileTransformer;
import java.lang.instrument.IllegalClassFormatException;
import java.lang.instrument.Instrumentation;
import java.security.ProtectionDomain;
/**
* Main
*
* @author dava
* @date 2022/01/19 11:21
* @description
* @since 1.0.0
*/
public class Main {
private static ClassPool classPool;
public static void premain(String args, Instrumentation instrumentation) {
boolean isFormatSql = args.contains("isFormatSql=true");
instrumentation.addTransformer(new ClassFileTransformer() {
@Override
public byte[] transform(ClassLoader loader,
String className,
Class<?> classBeingRedefined,
ProtectionDomain protectionDomain,
byte[] classfileBuffer) throws IllegalClassFormatException {
if (!"org/postgresql/jdbc/PgPreparedStatement".equals(className)) {
return null;
}
try {
classPool = ClassPool.getDefault();
classPool.appendClassPath(new LoaderClassPath(loader));
CtClass ctClass = classPool.get("org.postgresql.jdbc.PgPreparedStatement");
ctClass.addMethod(getPrintSqlMethod(ctClass));
CtMethod m1 = ctClass.getDeclaredMethod("execute", new CtClass[]{});
m1.insertBefore("{davaPrintSql(preparedQuery.query.toString(preparedParameters)," + isFormatSql + ");}");
CtMethod m2 = ctClass.getDeclaredMethod("executeQuery", new CtClass[]{});
m2.insertBefore("{davaPrintSql(preparedQuery.query.toString(preparedParameters)," + isFormatSql + ");}");
CtMethod m3 = ctClass.getDeclaredMethod("executeUpdate", new CtClass[]{});
m3.insertBefore("{davaPrintSql(preparedQuery.query.toString(preparedParameters)," + isFormatSql + ");}");
return ctClass.toBytecode();
} catch (Exception e) {
e.printStackTrace();
}
return null;
}
});
}
public static void agentmain(String agentArgs, Instrumentation inst) {
System.out.println("agentmain");
}
public static CtMethod getPrintSqlMethod(CtClass cls) throws Exception {
CtMethod originMethod = classPool.getMethod("xyz.dava.agent.sql.Main", "dataPrintSql");
CtMethod method = CtNewMethod.copy(originMethod, cls, null);
method.setName("davaPrintSql");
return method;
}
public void dataPrintSql(String sql, boolean isFormatSql) {
SQLUtils.FormatOption option = new SQLUtils.FormatOption();
option.setPrettyFormat(isFormatSql);
System.err.println(SQLUtils.formatPGSql(sql, option));
}
}
使用
- 在启动的虚拟机参数中添加参数即可
-javaagent:D:\sql-agent-1.0-SNAPSHOT-jar-with-dependencies.jar=isFormatSql=false
