手寫mybatis完整sql插件問題及實現思路

我們在使用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插件的資料請關注好吧啦網其它相關文章！