本文將為您詳細(xì)介紹mybatis完整sql插件,將具體講解mybatis完整sql插件的相關(guān)問題并針對(duì)提出的問題,提供一個(gè)完整清晰的解決思路。
問題產(chǎn)生
我們在使用mybatis的過程中,如果開啟了mysql的日志功能的話,會(huì)在控制臺(tái)打印一些sql的信息,但是日志中的sql語句,是沒有拼接參數(shù)的,也就是說,是不可以直接放到數(shù)據(jù)庫中執(zhí)行的。
some times,我們在調(diào)試問題的時(shí)候,會(huì)希望有一個(gè)直接可以運(yùn)行的SQL語句,那將方便很多,特別是在sql語句綁定參數(shù)很多的時(shí)候。
現(xiàn)象描述
默認(rèn)的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的插件機(jī)制來解決這個(gè)問題。
首先,我們查看源碼,發(fā)現(xiàn)mysql的PreparedStatement的toString方法中,直接通過asSql方法展示了完整的sql語句:
其次,mybatis中StatementHandler以及ParameterHandler接口中,都有相應(yīng)的方法能夠攔截到Statement:
具體實(shí)現(xiàn)
我們隨機(jī)選擇攔截ParameterHandler來進(jìn)行完整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配置文件中進(jìn)行攔截器的注冊:
<plugins> <plugin interceptor="com.huwc.interceptor.MybatisLogInterceptor"></plugin> </plugins>
步驟三、測試結(jié)果:
==> 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)
結(jié)果我們發(fā)現(xiàn)語句打印的有問題,綁定的參數(shù)沒有打印出來。
仔細(xì)一看,發(fā)現(xiàn)我們攔截的就是ParameterHandler的綁定參數(shù)方法,且是在方法執(zhí)行之前進(jìn)行的打印,顯然,參數(shù)還未綁定,所以我們調(diào)整一下攔截方法的執(zhí)行過程:
重新執(zhí)行,結(jié)果正常:
通過本文的學(xué)習(xí),對(duì)于mybatis完整sql插件相關(guān)問題和該問題的解決思路有了一個(gè)大概了解,想要了解更多有關(guān)于mybatis完整sql插件的資料請(qǐng)關(guān)注W3Cschool其它相關(guān)文章!