mybatis 插件: 打印 sql 及其執(zhí)行時間實現(xiàn)方法
Plugins
摘一段來自MyBatis官方文檔的文字。
MyBatis允許你在某一點攔截已映射語句執(zhí)行的調(diào)用。默認情況下,MyBatis允許使用插件來攔截方法調(diào)用:
Executor(update、query、flushStatements、commint、rollback、getTransaction、close、isClosed)
ParameterHandler(getParameterObject、setParameters)
ResultSetHandler(handleResultSets、handleOutputParameters)
StatementHandler(prepare、parameterize、batch、update、query)
這些類中方法的詳情可以通過查看每個方法的簽名來發(fā)現(xiàn),而且它們的源代碼存在于MyBatis發(fā)行包中。你應(yīng)該理解你所覆蓋方法的行為,假設(shè)你所做的要比監(jiān)視調(diào)用要多。如果你嘗試修改或覆蓋一個給定的方法,你可能會打破MyBatis的核心。這是低層次的類和方法,要謹慎使用插件。
插件示例:打印每條SQL語句及其執(zhí)行時間
以下通過代碼來演示一下如何使用MyBatis的插件,要演示的場景是:打印每條真正執(zhí)行的SQL語句及其執(zhí)行的時間。這是一個非常有用的需求,MyBatis本身的日志可以記錄SQL,但是有以下幾個問題:
MyBatis日志打印出來的SQL日志,參數(shù)都被占位符”?”替換,無法知道真正執(zhí)行的SQL語句中的參數(shù)是什么
MyBatis日志打印出來的SQL日志,有大量的換行符,通常一句SQL語句要通過十幾行顯示,閱讀體驗非常差
無法記錄SQL執(zhí)行時間,有SQL執(zhí)行時間就可以精準(zhǔn)定位到執(zhí)行時間比較慢的SQL
寫MyBatis插件非常簡單,只需要實現(xiàn)Interceptor接口即可,我這里將我的Interceptor命名為SqlCostInterceptor:
/** * Sql執(zhí)行時間記錄攔截器 */ @Intercepts({@Signature(type = StatementHandler.class, method = "query", args = {Statement.class, ResultHandler.class}), @Signature(type = StatementHandler.class, method = "update", args = {Statement.class}), @Signature(type = StatementHandler.class, method = "batch", args = { Statement.class })}) public class SqlCostInterceptor implements Interceptor { @Override public Object intercept(Invocation invocation) throws Throwable { Object target = invocation.getTarget(); long startTime = System.currentTimeMillis(); StatementHandler statementHandler = (StatementHandler)target; try { return invocation.proceed(); } finally { long endTime = System.currentTimeMillis(); long sqlCost = endTime - startTime; BoundSql boundSql = statementHandler.getBoundSql(); String sql = boundSql.getSql(); Object parameterObject = boundSql.getParameterObject(); List<ParameterMapping> parameterMappingList = boundSql.getParameterMappings(); // 格式化Sql語句,去除換行符,替換參數(shù) sql = formatSql(sql, parameterObject, parameterMappingList); System.out.println("SQL:[" + sql + "]執(zhí)行耗時[" + sqlCost + "ms]"); } } @Override public Object plugin(Object target) { return Plugin.wrap(target, this); } @Override public void setProperties(Properties properties) { } @SuppressWarnings("unchecked") private String formatSql(String sql, Object parameterObject, List<ParameterMapping> parameterMappingList) { // 輸入sql字符串空判斷 if (sql == null || sql.length() == 0) { return ""; } // 美化sql sql = beautifySql(sql); // 不傳參數(shù)的場景,直接把Sql美化一下返回出去 if (parameterObject == null || parameterMappingList == null || parameterMappingList.size() == 0) { return sql; } // 定義一個沒有替換過占位符的sql,用于出異常時返回 String sqlWithoutReplacePlaceholder = sql; try { if (parameterMappingList != null) { Class<?> parameterObjectClass = parameterObject.getClass(); // 如果參數(shù)是StrictMap且Value類型為Collection,獲取key="list"的屬性,這里主要是為了處理<foreach>循環(huán)時傳入List這種參數(shù)的占位符替換 // 例如select * from xxx where id in <foreach collection="list">...</foreach> if (isStrictMap(parameterObjectClass)) { StrictMap<Collection<?>> strictMap = (StrictMap<Collection<?>>)parameterObject; if (isList(strictMap.get("list").getClass())) { sql = handleListParameter(sql, strictMap.get("list")); } } else if (isMap(parameterObjectClass)) { // 如果參數(shù)是Map則直接強轉(zhuǎn),通過map.get(key)方法獲取真正的屬性值 // 這里主要是為了處理<insert>、<delete>、<update>、<select>時傳入parameterType為map的場景 Map<?, ?> paramMap = (Map<?, ?>) parameterObject; sql = handleMapParameter(sql, paramMap, parameterMappingList); } else { // 通用場景,比如傳的是一個自定義的對象或者八種基本數(shù)據(jù)類型之一或者String sql = handleCommonParameter(sql, parameterMappingList, parameterObjectClass, parameterObject); } } } catch (Exception e) { // 占位符替換過程中出現(xiàn)異常,則返回沒有替換過占位符但是格式美化過的sql,這樣至少保證sql語句比BoundSql中的sql更好看 return sqlWithoutReplacePlaceholder; } return sql; } /** * 美化Sql */ private String beautifySql(String sql) { sql = sql.replace("\n", "").replace("\t", "").replace(" ", " ").replace("( ", "(").replace(" )", ")").replace(" ,", ","); return sql; } /** * 處理參數(shù)為List的場景 */ private String handleListParameter(String sql, Collection<?> col) { if (col != null && col.size() != 0) { for (Object obj : col) { String value = null; Class<?> objClass = obj.getClass(); // 只處理基本數(shù)據(jù)類型、基本數(shù)據(jù)類型的包裝類、String這三種 // 如果是復(fù)合類型也是可以的,不過復(fù)雜點且這種場景較少,寫代碼的時候要判斷一下要拿到的是復(fù)合類型中的哪個屬性 if (isPrimitiveOrPrimitiveWrapper(objClass)) { value = obj.toString(); } else if (objClass.isAssignableFrom(String.class)) { value = "\"" + obj.toString() + "\""; } sql = sql.replaceFirst("\\?", value); } } return sql; } /** * 處理參數(shù)為Map的場景 */ private String handleMapParameter(String sql, Map<?, ?> paramMap, List<ParameterMapping> parameterMappingList) { for (ParameterMapping parameterMapping : parameterMappingList) { Object propertyName = parameterMapping.getProperty(); Object propertyValue = paramMap.get(propertyName); if (propertyValue != null) { if (propertyValue.getClass().isAssignableFrom(String.class)) { propertyValue = "\"" + propertyValue + "\""; } sql = sql.replaceFirst("\\?", propertyValue.toString()); } } return sql; } /** * 處理通用的場景 */ private String handleCommonParameter(String sql, List<ParameterMapping> parameterMappingList, Class<?> parameterObjectClass, Object parameterObject) throws Exception { for (ParameterMapping parameterMapping : parameterMappingList) { String propertyValue = null; // 基本數(shù)據(jù)類型或者基本數(shù)據(jù)類型的包裝類,直接toString即可獲取其真正的參數(shù)值,其余直接取paramterMapping中的property屬性即可 if (isPrimitiveOrPrimitiveWrapper(parameterObjectClass)) { propertyValue = parameterObject.toString(); } else { String propertyName = parameterMapping.getProperty(); Field field = parameterObjectClass.getDeclaredField(propertyName); // 要獲取Field中的屬性值,這里必須將私有屬性的accessible設(shè)置為true field.setAccessible(true); propertyValue = String.valueOf(field.get(parameterObject)); if (parameterMapping.getJavaType().isAssignableFrom(String.class)) { propertyValue = "\"" + propertyValue + "\""; } } sql = sql.replaceFirst("\\?", propertyValue); } return sql; } /** * 是否基本數(shù)據(jù)類型或者基本數(shù)據(jù)類型的包裝類 */ private boolean isPrimitiveOrPrimitiveWrapper(Class<?> parameterObjectClass) { return parameterObjectClass.isPrimitive() || (parameterObjectClass.isAssignableFrom(Byte.class) || parameterObjectClass.isAssignableFrom(Short.class) || parameterObjectClass.isAssignableFrom(Integer.class) || parameterObjectClass.isAssignableFrom(Long.class) || parameterObjectClass.isAssignableFrom(Double.class) || parameterObjectClass.isAssignableFrom(Float.class) || parameterObjectClass.isAssignableFrom(Character.class) || parameterObjectClass.isAssignableFrom(Boolean.class)); } /** * 是否DefaultSqlSession的內(nèi)部類StrictMap */ private boolean isStrictMap(Class<?> parameterObjectClass) { return parameterObjectClass.isAssignableFrom(StrictMap.class); } /** * 是否List的實現(xiàn)類 */ private boolean isList(Class<?> clazz) { Class<?>[] interfaceClasses = clazz.getInterfaces(); for (Class<?> interfaceClass : interfaceClasses) { if (interfaceClass.isAssignableFrom(List.class)) { return true; } } return false; } /** * 是否Map的實現(xiàn)類 */ private boolean isMap(Class<?> parameterObjectClass) { Class<?>[] interfaceClasses = parameterObjectClass.getInterfaces(); for (Class<?> interfaceClass : interfaceClasses) { if (interfaceClass.isAssignableFrom(Map.class)) { return true; } } return false; } }
分析一下這段代碼(這個是改良過的版本,主要是增加了對select * from xxx where id in <foreach collection=”list”>…</foreach>這種寫法占位符替換為真正參數(shù)的支持)。
首先是注解@Intercepts與@Signature,這兩個注解是必須的,因為Plugin的wrap方法會取這兩個注解里面參數(shù)。@Intercepts中可以定義多個@Signature,一個@Signature表示符合如下條件的方法才會被攔截:
接口必須是type定義的類型
方法名必須和method一致
方法形參的Class類型必須和args定義Class類型順序一致
接著的一個問題是:有四個接口可以攔截,為什么使用StatementHandler去攔截?根據(jù)名字來看ParameterHandler和ResultSetHandler,前者處理參數(shù),后者處理結(jié)果是不可能使用的,剩下的就是Executor和StatementHandler了。攔截StatementHandler的原因是而不是用Executor的原因是:
Executor的update與query方法可能用到MyBatis的一二級緩存從而導(dǎo)致統(tǒng)計的并不是真正的SQL執(zhí)行時間
StatementHandler的update與query方法無論如何都會統(tǒng)計到PreparedStatement的execute方法執(zhí)行時間,盡管也有一定誤差(誤差主要來自會將處理結(jié)果的時間也算上),但是相差不大
接著講一下setProperties方法,可以將一些配置屬性配置在<plugin></plugin>的子標(biāo)簽<property />中,所有的配置屬性會在形參Properties中,setProperties方法可以拿到配置的屬性進行需要的處理。
接著講一下plugin方法,這里是為目標(biāo)接口生成代理,不需要也沒必要自己去寫生成代理的方法,MyBatis的Plugin類已經(jīng)為我們提供了wrap方法(當(dāng)然如果自己有自己的邏輯也可以在Plugin.wrap方法前后加入,但是最終一定要使用Plugin.wrap方法生成代理),看一下該方法的實現(xiàn):
public static Object wrap(Object target, Interceptor interceptor) { Map<Class<?>, Set<Method>> signatureMap = getSignatureMap(interceptor); Class<?> type = target.getClass(); Class<?>[] interfaces = getAllInterfaces(type, signatureMap); if (interfaces.length > 0) { return Proxy.newProxyInstance( type.getClassLoader(), interfaces, new Plugin(target, interceptor, signatureMap)); } return target; }
因為這里的target一定是一個接口,因此可以放心使用JDK本身提供的Proxy類,這里相當(dāng)于就是如果該接口滿足方法簽名那么就為之生成一個代理。
最后就是intercept方法了,這里就是攔截器的核心代碼了,方法的邏輯我就不解釋了,可以自己看一下,唯一要注意的一點就是無論如何最終一定要返回invocation.proceed(),保證攔截器的層層調(diào)用。
xml文件配置即效果演示
寫完了插件,只需要在config.xml文件中進行一次配置即可,非常簡單:
<plugins> <plugin interceptor="org.xrq.mybatis.plugin.SqlCostInterceptor" /> </plugins>
這里每個<plugin>子標(biāo)簽代表一個插件,interceptor表示攔截器的完整路徑,每個人的不同。
有了類和這段配置,就可以使用SqlCostInterceptor了,SqlCostInterceptor是通用的,但是每個人的CRUD是不同的,我打印一下我這里CRUD執(zhí)行的結(jié)果:
SQL:[insert into mail(id, create_time, modify_time, web_id, mail, use_for) values(null, now(), now(), "1", "123@sina.com", "個人使用");]執(zhí)行耗時[1ms] SQL:[insert into mail(id, create_time, modify_time, web_id, mail, use_for) values(null, now(), now(), "2", "123@qq.com", "企業(yè)使用");]執(zhí)行耗時[1ms] SQL:[insert into mail(id, create_time, modify_time, web_id, mail, use_for) values(null, now(), now(), "3", "123@sohu.com", "注冊賬號使用");]執(zhí)行耗時[0ms]
看到打印了完整的SQl語句以及SQL語句執(zhí)行時間。
不過要說明一點,這個插件只是一個簡單的Demo,我并沒有完整測試過,應(yīng)該是無法覆蓋所有場景的,所以如果想用這段代碼片段打印真正的SQL及其執(zhí)行時間的朋友,還需要在這個基礎(chǔ)上做修改,不過即使不改代碼,這個插件起到美化SQL的作用,去除一些換行符還是沒問題的。
至于MyBatis插件的實現(xiàn)原理,會在我【MyBatis源碼分析】系列文章中詳細解讀,文章地址為【MyBatis源碼分析】插件實現(xiàn)原理。
后記
MyBatis插件機制非常有用,用得好可以解決很多問題,不只是這里的打印SQL語句以及記錄SQL語句執(zhí)行時間,分頁、分表都可以通過插件來實現(xiàn)。用好插件的關(guān)鍵是我開頭就列舉的,這里再列一次:
Executor(update、query、flushStatements、commint、rollback、getTransaction、close、isClosed)
ParameterHandler(getParameterObject、setParameters)
ResultSetHandler(handleResultSets、handleOutputParameters)
StatementHandler(prepare、parameterize、batch、update、query)
只有理解這四個接口及相關(guān)方法是干什么的,才能寫出好的攔截器,開發(fā)出符合預(yù)期的功能。
以上這篇mybatis 插件: 打印 sql 及其執(zhí)行時間實現(xiàn)方法就是小編分享給大家的全部內(nèi)容了,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關(guān)文章
Java異常處理操作 Throwable、Exception、Error
這篇文章主要介紹了Java異常處理操作 Throwable、Exception、Error,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-06-06springboot啟動mongoDB報錯之禁用mongoDB自動配置問題
這篇文章主要介紹了springboot啟動mongoDB報錯之禁用mongoDB自動配置問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-05-05使用springboot不自動初始化數(shù)據(jù)庫連接池
這篇文章主要介紹了使用springboot不自動初始化數(shù)據(jù)庫連接池,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-09-09java出現(xiàn)no XXX in java.library.path的解決及eclipse配
這篇文章主要介紹了java出現(xiàn)no XXX in java.library.path的解決及eclipse配置方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2023-12-12java substring(a)與substring(a,b)的使用說明
這篇文章主要介紹了java substring(a)與substring(a,b)的使用說明,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-10-10Java使用Scanner類進行控制臺輸入實現(xiàn)方法
這篇文章主要介紹了Java使用Scanner類進行控制臺輸入實現(xiàn)方法,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-12-12