手写mybatis完整sql插件问题及实现思路
作者：whhwch1986
问题产生
我们在使用mybatis的过程中，如果开启了mysql的日志功能的话，会在控制台打印一些sql的信息，但是日志中的sql语句，是没有拼接参数的，也就是说，是不可以直接放到数据库中执行的。
some times，我们在调试问题的时候，会希望有一个直接可以运行的SQL语句，那将方便很多，特别是在sql语句绑定参数很多的时候。
现象描述
默认的mysql日志配置和打印情况如下：
<settings>
<setting name="logImpl" value="STDOUT_LOGGING"/>
</settings>
==> Preparing: select * from hwc_users a where a.name = ? and a.age = ? ==> Parameters: huwenchao(String), 35(Integer) <== Total: 0
解决思路
通过思考，我觉得可以通过mybatis的插件机制来解决这个问题。
首先，我们查看源码，发现mysql的PreparedStatement的toString方法中，直接通过asSql方法展示了完整的sql语句：
其次，mybatis中StatementHandler以及ParameterHandler接口中，都有相应的方法能够拦截到Statement：
具体实现
我们随机选择拦截ParameterHandler来进行完整sql语句的输出：
步骤一、编写拦截器类，并配置拦截的类和方法：
package com.huwc.interceptor;
import com.mysql.jdbc.JDBC42PreparedStatement;
import org.apache.ibatis.executor.parameter.ParameterHandler;
import org.apache.ibatis.logging.jdbc.PreparedStatementLogger;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.scripting.defaults.DefaultParameterHandler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Proxy;
import java.sql.PreparedStatement;
import java.util.Properties;
@Intercepts({
@Signature(type = ParameterHandler.class, method = "setParameters", args = {PreparedStatement.class})
}
)
public class MybatisLogInterceptor implements Interceptor {
@Override
public Object intercept(Invocation invocation) throws Throwable {
PreparedStatement statement = (PreparedStatement) invocation.getArgs()[0];
PreparedStatement statement1 = null ;
if(Proxy.isProxyClass(statement.getClass())){
InvocationHandler handler = Proxy.getInvocationHandler(statement);
if(handler.getClass().getName().endsWith(".PreparedStatementLogger")){
Field field = handler.getClass().getDeclaredField("statement");
field.setAccessible(true);
statement1 = (PreparedStatement) field.get(handler);
}
}
System.out.println("================================= execute sql ==============================");
System.out.println(statement1.toString());
System.out.println("================================= execute sql ==============================");
return invocation.proceed();
}
@Override
public Object plugin(Object target) {
return Plugin.wrap(target, this);
}
@Override
public void setProperties(Properties properties) {
}
}
步骤二、在mybatis配置文件中进行拦截器的注册：
<plugins>
<plugin interceptor="com.huwc.interceptor.MybatisLogInterceptor"></plugin>
</plugins>
步骤三、测试结果：
==> Preparing: select * from hwc_users a where a.name = ? and a.age = ?
================================= execute sql ==============================
com.mysql.jdbc.JDBC42PreparedStatement@53fb3dab: select * from hwc_users a where a.name = ** NOT SPECIFIED ** and a.age = ** NOT SPECIFIED **
================================= execute sql ==============================
==> Parameters: huwenchao(String), 35(Integer)
结果我们发现语句打印的有问题，绑定的参数没有打印出来。
仔细一看，发现我们拦截的就是ParameterHandler的绑定参数方法，且是在方法执行之前进行的打印，显然，参数还未绑定，所以我们调整一下拦截方法的执行过程：
重新执行，结果正常：
以上就是手写mybatis完整sql插件的详细内容，更多关于mybatis完整sql插件的资料请关注脚本之家其它相关文章！