├── src └── main │ ├── resources │ ├── image │ │ └── mybatis-log.png │ └── META-INF │ │ └── spring.factories │ └── java │ └── com │ └── mybatis │ └── spring │ └── boot │ └── autoconfigure │ ├── MybatisSqlPrintAutoConfiguration.java │ └── MybatisSqlCompletePrintInterceptor.java ├── .gitignore ├── README.md ├── mvnw.cmd ├── pom.xml └── mvnw /src/main/resources/image/mybatis-log.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/WangJi92/mybatis-sql-log/HEAD/src/main/resources/image/mybatis-log.png -------------------------------------------------------------------------------- /src/main/resources/META-INF/spring.factories: -------------------------------------------------------------------------------- 1 | org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.mybatis.spring.boot.autoconfigure.MybatisSqlPrintAutoConfiguration -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | HELP.md 2 | target/ 3 | !.mvn/wrapper/maven-wrapper.jar 4 | !**/src/main/** 5 | !**/src/test/** 6 | 7 | ### STS ### 8 | .apt_generated 9 | .classpath 10 | .factorypath 11 | .project 12 | .settings 13 | .springBeans 14 | .sts4-cache 15 | 16 | ### IntelliJ IDEA ### 17 | .idea 18 | *.iws 19 | *.iml 20 | *.ipr 21 | 22 | ### NetBeans ### 23 | /nbproject/private/ 24 | /nbbuild/ 25 | /dist/ 26 | /nbdist/ 27 | /.nb-gradle/ 28 | build/ 29 | 30 | ### VS Code ### 31 | .vscode/ 32 | -------------------------------------------------------------------------------- /src/main/java/com/mybatis/spring/boot/autoconfigure/MybatisSqlPrintAutoConfiguration.java: -------------------------------------------------------------------------------- 1 | package com.mybatis.spring.boot.autoconfigure; 2 | 3 | import com.github.pagehelper.autoconfigure.PageHelperAutoConfiguration; 4 | import org.apache.ibatis.session.SqlSessionFactory; 5 | import org.springframework.beans.factory.annotation.Autowired; 6 | import org.springframework.boot.autoconfigure.AutoConfigureAfter; 7 | import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; 8 | import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression; 9 | import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingClass; 10 | import org.springframework.context.annotation.Configuration; 11 | 12 | import javax.annotation.PostConstruct; 13 | import java.util.List; 14 | 15 | 16 | @Configuration 17 | @ConditionalOnClass(name = "org.apache.ibatis.session.SqlSessionFactory") 18 | @ConditionalOnExpression("${mybatis.print:true}") 19 | public class MybatisSqlPrintAutoConfiguration { 20 | 21 | @Autowired 22 | private List sqlSessionFactoryList; 23 | 24 | /** 25 | * 兼容一下 PageHelper，让拦截器在最后一个处理 {@literal https://github.com/pagehelper/pagehelper-spring-boot} 26 | * 或者通过原生的进行处理 27 | */ 28 | @Configuration 29 | @ConditionalOnMissingClass({"com.github.pagehelper.autoconfigure.PageHelperAutoConfiguration"}) 30 | public class SupportPageHelper { 31 | 32 | @PostConstruct 33 | public void addPrintInterceptor() { 34 | for (SqlSessionFactory sqlSessionFactory : sqlSessionFactoryList) { 35 | org.apache.ibatis.session.Configuration configuration = sqlSessionFactory.getConfiguration(); 36 | MybatisSqlCompletePrintInterceptor printInterceptor = new MybatisSqlCompletePrintInterceptor(configuration); 37 | sqlSessionFactory.getConfiguration().addInterceptor(printInterceptor); 38 | } 39 | } 40 | } 41 | 42 | /** 43 | * sql 打印需要在拦截器最后一个才能统计 {@literal https://github.com/pagehelper/pagehelper-spring-boot} 44 | */ 45 | @Configuration 46 | @ConditionalOnClass({PageHelperAutoConfiguration.class}) 47 | @AutoConfigureAfter(PageHelperAutoConfiguration.class) 48 | public class AutoConfigPrintInterceptor { 49 | 50 | @PostConstruct 51 | public void addPrintInterceptor() { 52 | for (SqlSessionFactory sqlSessionFactory : sqlSessionFactoryList) { 53 | org.apache.ibatis.session.Configuration configuration = sqlSessionFactory.getConfiguration(); 54 | MybatisSqlCompletePrintInterceptor printInterceptor = new MybatisSqlCompletePrintInterceptor(configuration); 55 | sqlSessionFactory.getConfiguration().addInterceptor(printInterceptor); 56 | } 57 | } 58 | } 59 | 60 | 61 | } 62 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # mybatis-sql-log 2 | 3 | ## 支持spring boot spring pageHelp,将完整日志打印出来 4 | 5 | > mybatis-sql-log 主要是为了打印mybatis 完整的sql语句，通过mybaits 提供的插件的方式进行拦截， 6 | > 获取内部执行的sql，并将完整的sql语句打印出来。 7 | 8 | spring boot 其实可以的打印log日志出来的只要将当前的包日志打印为debug也是可以，只是参数不够完整，直接复制查询sql 不太友好。 9 | eg: logging.level.com.boot.mybatis.mybatisdemo=debug 10 | 11 | 12 | ## 1、使用 13 | [mybaits sql log Demo 工程](https://github.com/WangJi92/mybatis-log-demo/blob/master/README.md) 14 | 15 | 插件可以在maven 仓库中搜索 mybatis-sql-log 16 | [阿里云搜索](https://maven.aliyun.com/mvn/search) 17 | ```xml 18 | 19 | com.github.WangJi92 20 | mybatis-sql-log 21 | 1.0.6 22 | 23 | ``` 24 | 25 | 实现原理主要类：com.mybatis.spring.boot.autoconfigure.MybatisSqlCompletePrintInterceptor 26 | ```xml 27 | 28 | org.mybatis.spring.boot 29 | mybatis-spring-boot-starter 30 | 2.1.0 31 | 32 | 33 | com.github.WangJi92 34 | mybatis-sql-log 35 | 1.0.6 36 | 37 | ``` 38 | mybats.print=true 使用spring boot 工程集成 39 | 40 | org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration 内部自动集成了插件 41 | ```xml 42 | mybatis.print=true 43 | server.port = 7012 44 | #数据库连接 45 | spring.datasource.url = jdbc:mysql://127.0.0.1:3306/test 46 | spring.datasource.username = root 47 | spring.datasource.password = mysql-root 48 | spring.datasource.driver-class-name= com.mysql.jdbc.Driver 49 | spring.datasource.hikari.connection-test-query = SELECT 1 50 | ``` 51 | 效果，可以打印完整的SQL信息 【Mybatis Print SQL】【 select name, age, type from user WHERE ( name = '汪吉' ) 】 执行耗时=42 52 | 53 | ```xml 54 | 2019-08-31 16:58:21.996 INFO 8762 --- [nio-7012-exec-1] s.b.a.MybatisSqlCompletePrintInterceptor : 【Mybatis Print SQL】【 select name, age, type from user WHERE ( name = '汪吉' ) 】 执行耗时=42 55 | ``` 56 | ![MyBatis Log 打印效果](https://github.com/WangJi92/mybatis-sql-log/blob/master/src/main/resources/image/mybatis-log.png) 57 | 或者通过mybatis-config原生配置处理 58 | ```text 59 | 60 | 61 | 62 | 63 | 67 | ## 2、mybatis 官方插件 68 | 69 | - [插件（plugins）](http://www.mybatis.org/mybatis-3/zh/configuration.html#plugins)
70 | MyBatis 允许你在已映射语句执行过程中的某一点进行拦截调用。默认情况下，MyBatis 允许使用插件来拦截的方法调用包括：
71 | Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
72 | ParameterHandler (getParameterObject, setParameters)
73 | ResultSetHandler (handleResultSets, handleOutputParameters)
74 | StatementHandler (prepare, parameterize, batch, update, query) 75 | 76 | 77 | ## 3、相关参考 Documentation 78 | 79 | - [Mybatis插件-sql日志美化输出](https://my.oschina.net/junjunyuanyuankeke/blog/1975439) 80 | - [MyBatis插件及示例----打印每条SQL语句及其执行时间](https://www.cnblogs.com/Xrq730/P/6972268.Html) 81 | 82 | 上面的两篇文章整体上思路都是一致的主要是在处理参数的问题上不是很完善。这里通过mybatis 自带的ParameterHandler处理参数就比较的简单，
而不是通过各种复杂的判断进行处理。org/apache/ibatis/scripting/defaults/DefaultParameterHandler 这里提供了很完善的参数处理。
如下的代码，可以清晰的了解整个参数的解析过程，无论是动态的参数，还是对象参数，都可以完善的处理参数的解析过程。 83 | 84 | ``` 85 | public void setParameters(PreparedStatement ps) { 86 | ErrorContext.instance().activity("setting parameters").object(mappedStatement.getParameterMap().getId()); 87 | List parameterMappings = boundSql.getParameterMappings(); 88 | if (parameterMappings != null) { 89 | for (int i = 0; i < parameterMappings.size(); i++) { 90 | ParameterMapping parameterMapping = parameterMappings.get(i); 91 | if (parameterMapping.getMode() != ParameterMode.OUT) { 92 | Object value; 93 | String propertyName = parameterMapping.getProperty(); 94 | if (boundSql.hasAdditionalParameter(propertyName)) { // issue #448 ask first for additional params 95 | value = boundSql.getAdditionalParameter(propertyName); 96 | } else if (parameterObject == null) { 97 | value = null; 98 | } else if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) { 99 | value = parameterObject; 100 | } else { 101 | MetaObject metaObject = configuration.newMetaObject(parameterObject); 102 | value = metaObject.getValue(propertyName); 103 | } 104 | TypeHandler typeHandler = parameterMapping.getTypeHandler(); 105 | JdbcType jdbcType = parameterMapping.getJdbcType(); 106 | if (value == null && jdbcType == null) { 107 | jdbcType = configuration.getJdbcTypeForNull(); 108 | } 109 | try { 110 | typeHandler.setParameter(ps, i + 1, value, jdbcType); 111 | } catch (TypeException e) { 112 | throw new TypeException("Could not set parameters for mapping: " + parameterMapping + ". Cause: " + e, e); 113 | } catch (SQLException e) { 114 | throw new TypeException("Could not set parameters for mapping: " + parameterMapping + ". Cause: " + e, e); 115 | } 116 | } 117 | } 118 | } 119 | } 120 | ``` 121 | 122 | 123 | ## 4、mybatis在执行期间，主要有四大核心接口对象： 124 | 125 | 执行器Executor，执行器负责整个SQL执行过程的总体控制。
参数处理器ParameterHandler，参数处理器负责PreparedStatement入参的具体设置。
语句处理器StatementHandler，语句处理器负责和JDBC层具体交互，包括prepare语句，执行语句，以及调用ParameterHandler.parameterize()设置参数。
结果集处理器ResultSetHandler，结果处理器负责将JDBC查询结果映射到java对象。 126 | 127 | 了解了这四大对象，其实我们的处理本次这个插件十分的重要，插件对象可以在Executor、或者StatementHandler两个上面处理。 128 | 129 | ## plugins 实现了两种 130 | 分别在两个分支中实现，可以根据自己的需求进行处理 131 | * [Executor plugins 方式拦截](https://github.com/WangJi92/mybatis-sql-log/tree/Executor) 132 | * [StatementHandler plugins 方式拦截](https://github.com/WangJi92/mybatis-sql-log/tree/StatementHandler) 133 | -------------------------------------------------------------------------------- /mvnw.cmd: -------------------------------------------------------------------------------- 1 | @REM ---------------------------------------------------------------------------- 2 | @REM Licensed to the Apache Software Foundation (ASF) under one 3 | @REM or more contributor license agreements. See the NOTICE file 4 | @REM distributed with this work for additional information 5 | @REM regarding copyright ownership. The ASF licenses this file 6 | @REM to you under the Apache License, Version 2.0 (the 7 | @REM "License"); you may not use this file except in compliance 8 | @REM with the License. You may obtain a copy of the License at 9 | @REM 10 | @REM https://www.apache.org/licenses/LICENSE-2.0 11 | @REM 12 | @REM Unless required by applicable law or agreed to in writing, 13 | @REM software distributed under the License is distributed on an 14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | @REM KIND, either express or implied. See the License for the 16 | @REM specific language governing permissions and limitations 17 | @REM under the License. 18 | @REM ---------------------------------------------------------------------------- 19 | 20 | @REM ---------------------------------------------------------------------------- 21 | @REM Maven2 Start Up Batch script 22 | @REM 23 | @REM Required ENV vars: 24 | @REM JAVA_HOME - location of a JDK home dir 25 | @REM 26 | @REM Optional ENV vars 27 | @REM M2_HOME - location of maven2's installed home dir 28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands 29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a key stroke before ending 30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven 31 | @REM e.g. to debug Maven itself, use 32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files 34 | @REM ---------------------------------------------------------------------------- 35 | 36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' 37 | @echo off 38 | @REM set title of command window 39 | title %0 40 | @REM enable echoing my setting MAVEN_BATCH_ECHO to 'on' 41 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 42 | 43 | @REM set %HOME% to equivalent of $HOME 44 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 45 | 46 | @REM Execute a user defined script before this one 47 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 48 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 49 | if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat" 50 | if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd" 51 | :skipRcPre 52 | 53 | @setlocal 54 | 55 | set ERROR_CODE=0 56 | 57 | @REM To isolate internal variables from possible post scripts, we use another setlocal 58 | @setlocal 59 | 60 | @REM ==== START VALIDATION ==== 61 | if not "%JAVA_HOME%" == "" goto OkJHome 62 | 63 | echo. 64 | echo Error: JAVA_HOME not found in your environment. >&2 65 | echo Please set the JAVA_HOME variable in your environment to match the >&2 66 | echo location of your Java installation. >&2 67 | echo. 68 | goto error 69 | 70 | :OkJHome 71 | if exist "%JAVA_HOME%\bin\java.exe" goto init 72 | 73 | echo. 74 | echo Error: JAVA_HOME is set to an invalid directory. >&2 75 | echo JAVA_HOME = "%JAVA_HOME%" >&2 76 | echo Please set the JAVA_HOME variable in your environment to match the >&2 77 | echo location of your Java installation. >&2 78 | echo. 79 | goto error 80 | 81 | @REM ==== END VALIDATION ==== 82 | 83 | :init 84 | 85 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 86 | @REM Fallback to current working directory if not found. 87 | 88 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 89 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 90 | 91 | set EXEC_DIR=%CD% 92 | set WDIR=%EXEC_DIR% 93 | :findBaseDir 94 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 95 | cd .. 96 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 97 | set WDIR=%CD% 98 | goto findBaseDir 99 | 100 | :baseDirFound 101 | set MAVEN_PROJECTBASEDIR=%WDIR% 102 | cd "%EXEC_DIR%" 103 | goto endDetectBaseDir 104 | 105 | :baseDirNotFound 106 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 107 | cd "%EXEC_DIR%" 108 | 109 | :endDetectBaseDir 110 | 111 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 112 | 113 | @setlocal EnableExtensions EnableDelayedExpansion 114 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 115 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 116 | 117 | :endReadAdditionalConfig 118 | 119 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 120 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 121 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 122 | 123 | set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar" 124 | FOR /F "tokens=1,2 delims==" %%A IN (%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties) DO ( 125 | IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B 126 | ) 127 | 128 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 129 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data. 130 | if exist %WRAPPER_JAR% ( 131 | echo Found %WRAPPER_JAR% 132 | ) else ( 133 | echo Couldn't find %WRAPPER_JAR%, downloading it ... 134 | echo Downloading from: %DOWNLOAD_URL% 135 | powershell -Command "(New-Object Net.WebClient).DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')" 136 | echo Finished downloading %WRAPPER_JAR% 137 | ) 138 | @REM End of extension 139 | 140 | %MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 141 | if ERRORLEVEL 1 goto error 142 | goto end 143 | 144 | :error 145 | set ERROR_CODE=1 146 | 147 | :end 148 | @endlocal & set ERROR_CODE=%ERROR_CODE% 149 | 150 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost 151 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 152 | if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat" 153 | if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd" 154 | :skipRcPost 155 | 156 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 157 | if "%MAVEN_BATCH_PAUSE%" == "on" pause 158 | 159 | if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE% 160 | 161 | exit /B %ERROR_CODE% 162 | -------------------------------------------------------------------------------- /src/main/java/com/mybatis/spring/boot/autoconfigure/MybatisSqlCompletePrintInterceptor.java: -------------------------------------------------------------------------------- 1 | package com.mybatis.spring.boot.autoconfigure; 2 | 3 | import lombok.extern.slf4j.Slf4j; 4 | import org.apache.ibatis.executor.statement.StatementHandler; 5 | import org.apache.ibatis.mapping.BoundSql; 6 | import org.apache.ibatis.mapping.ParameterMapping; 7 | import org.apache.ibatis.mapping.ParameterMode; 8 | import org.apache.ibatis.plugin.*; 9 | import org.apache.ibatis.reflection.MetaObject; 10 | import org.apache.ibatis.session.Configuration; 11 | import org.apache.ibatis.session.ResultHandler; 12 | import org.apache.ibatis.type.TypeHandlerRegistry; 13 | import org.springframework.core.Ordered; 14 | 15 | import java.sql.Statement; 16 | import java.text.SimpleDateFormat; 17 | import java.util.Date; 18 | import java.util.List; 19 | import java.util.Properties; 20 | import java.util.regex.Matcher; 21 | 22 | /** 23 | * 这里没有使用拦截 {@link org.apache.ibatis.executor.Executor 主要是因为PageHelp处理的时候，直接调用Executor的方法进行处理，没有调用invocation.proceed() 下一个拦截器处理，直接处理SQL 24 | * 的修改，因此，将这个拦截设置到最后的查询阶段去处理哦} 25 | * {@linkplain com.github.pagehelper.PageInterceptor executor.query(ms, parameter, rowBounds, resultHandler, cacheKey, boundSql) } 26 | *

27 | * 因此拦截StatementHandler 肯定不会错误【StatementHandler，语句处理器负责和JDBC层具体交互，包括prepare语句，执行语句，以及调用ParameterHandler.parameterize()设置参数】 28 | */ 29 | @Intercepts({@Signature(type = StatementHandler.class, method = "query", args = {Statement.class, ResultHandler.class}), 30 | @Signature(type = StatementHandler.class, method = "update", args = {Statement.class}), 31 | @Signature(type = StatementHandler.class, method = "batch", args = {Statement.class})}) 32 | @Slf4j 33 | public class MybatisSqlCompletePrintInterceptor implements Interceptor, Ordered { 34 | 35 | private Configuration configuration = null; 36 | 37 | 38 | public MybatisSqlCompletePrintInterceptor(Configuration configuration) { 39 | this.configuration = configuration; 40 | } 41 | 42 | private static final ThreadLocal DATE_FORMAT_THREAD_LOCAL = new ThreadLocal() { 43 | @Override 44 | protected SimpleDateFormat initialValue() { 45 | return new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS"); 46 | } 47 | }; 48 | 49 | @Override 50 | public Object intercept(Invocation invocation) throws Throwable { 51 | Object target = invocation.getTarget(); 52 | long startTime = System.currentTimeMillis(); 53 | try { 54 | return invocation.proceed(); 55 | } finally { 56 | String sql = this.getSql(target); 57 | long endTime = System.currentTimeMillis(); 58 | long sqlCost = endTime - startTime; 59 | log.info("SQL:{} cost={}", sql, sqlCost); 60 | } 61 | } 62 | 63 | /** 64 | * 获取sql 65 | * 66 | * @param target 67 | * @return 68 | * @throws IllegalAccessException 69 | */ 70 | private String getSql(Object target) { 71 | try { 72 | StatementHandler statementHandler = (StatementHandler) target; 73 | BoundSql boundSql = statementHandler.getBoundSql(); 74 | //替换参数格式化Sql语句，去除换行符 75 | return formatSql(boundSql, configuration); 76 | } catch (Exception e) { 77 | log.warn("get sql error {}", target, e); 78 | } 79 | return ""; 80 | } 81 | 82 | @Override 83 | public Object plugin(Object target) { 84 | return Plugin.wrap(target, this); 85 | } 86 | 87 | @Override 88 | public void setProperties(Properties properties) { 89 | 90 | } 91 | 92 | /** 93 | * 获取完整的sql实体的信息 94 | * 95 | * @param boundSql 96 | * @return 97 | */ 98 | private String formatSql(BoundSql boundSql, Configuration configuration) { 99 | String sql = boundSql.getSql(); 100 | List parameterMappings = boundSql.getParameterMappings(); 101 | Object parameterObject = boundSql.getParameterObject(); 102 | // 输入sql字符串空判断 103 | if (sql == null || sql.length() == 0) { 104 | return ""; 105 | } 106 | 107 | if (configuration == null) { 108 | return ""; 109 | } 110 | 111 | TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry(); 112 | 113 | // 美化sql 114 | sql = beautifySql(sql); 115 | /** 116 | * @see org.apache.ibatis.scripting.defaults.DefaultParameterHandler 参考Mybatis 参数处理 117 | */ 118 | if (parameterMappings != null) { 119 | for (ParameterMapping parameterMapping : parameterMappings) { 120 | if (parameterMapping.getMode() != ParameterMode.OUT) { 121 | Object value; 122 | String propertyName = parameterMapping.getProperty(); 123 | if (boundSql.hasAdditionalParameter(propertyName)) { 124 | value = boundSql.getAdditionalParameter(propertyName); 125 | } else if (parameterObject == null) { 126 | value = null; 127 | } else if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) { 128 | value = parameterObject; 129 | } else { 130 | MetaObject metaObject = configuration.newMetaObject(parameterObject); 131 | value = metaObject.getValue(propertyName); 132 | } 133 | String paramValueStr = ""; 134 | if (value instanceof String) { 135 | paramValueStr = "'" + value + "'"; 136 | } else if (value instanceof Date) { 137 | paramValueStr = "'" + DATE_FORMAT_THREAD_LOCAL.get().format(value) + "'"; 138 | } else { 139 | paramValueStr = value + ""; 140 | } 141 | // mybatis generator 中的参数不打印出来 142 | // mybatis plus 中的参数不打印出来 143 | if (!(propertyName.contains("frch_criterion") || propertyName.contains("ew.paramNameValuePairs"))) { 144 | paramValueStr = "/*" + propertyName + "*/" + paramValueStr; 145 | } 146 | // java.lang.IllegalArgumentException: Illegal group reference 147 | // https://github.com/WangJi92/mybatis-sql-log/issues/4 148 | sql = sql.replaceFirst("\\?", Matcher.quoteReplacement(paramValueStr)); 149 | } 150 | } 151 | } 152 | return sql; 153 | } 154 | 155 | /** 156 | * 美化Sql 157 | */ 158 | private String beautifySql(String sql) { 159 | sql = sql.replaceAll("[\\s\n ]+", " "); 160 | return sql; 161 | } 162 | 163 | 164 | @Override 165 | public int getOrder() { 166 | return Ordered.HIGHEST_PRECEDENCE; 167 | } 168 | } 169 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | com.github.WangJi92 6 | mybatis-sql-log 7 | 1.0.6 8 | mybatis-log 9 | spring boot start mybatis sql log plugins 10 | https://github.com/WangJi92/mybatis-sql-log 11 | 12 | 13 | 1.8 14 | 3.5.9 15 | 2.7.18 16 | 2.0.2 17 | 18 | 19 | 20 | 21 | The Apache Software License, Version 2.0 22 | http://www.apache.org/licenses/LICENSE-2.0.txt 23 | repo 24 | 25 | 26 | 27 | 28 | https://github.com/WangJi92/mybatis-sql-log 29 | https://github.com/WangJi92/mybatis-sql-log.git 30 | https://github.com/WangJi92/mybatis-sql-log.git 31 | 32 | 33 | 34 | 35 | wangji 36 | 983433479@qq.com 37 | https://github.com/WangJi92/mybatis-sql-log.git 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | org.springframework.boot 46 | spring-boot-dependencies 47 | ${spring-boot.version} 48 | pom 49 | import 50 | 51 | 52 | 53 | 54 | 55 | 56 | org.springframework.boot 57 | spring-boot-autoconfigure 58 | compile 59 | 60 | 61 | 62 | org.projectlombok 63 | lombok 64 | 1.18.6 65 | true 66 | provided 67 | 68 | 69 | 70 | org.springframework.boot 71 | spring-boot-starter-test 72 | test 73 | 74 | 75 | 76 | org.mybatis 77 | mybatis 78 | ${mybatis.version} 79 | 80 | 81 | 82 | org.mybatis 83 | mybatis-spring 84 | ${mybatis-spring.version} 85 | 86 | 87 | org.mybatis.spring.boot 88 | mybatis-spring-boot-starter 89 | 2.1.0 90 | provided 91 | 92 | 93 | com.github.pagehelper 94 | pagehelper-spring-boot-starter 95 | 1.2.12 96 | provided 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | org.apache.maven.plugins 105 | maven-source-plugin 106 | 3.0.1 107 | 108 | true 109 | 110 | 111 | 112 | compile 113 | 114 | jar 115 | 116 | 117 | 118 | 119 | 120 | org.apache.maven.plugins 121 | maven-javadoc-plugin 122 | 3.0.1 123 | 124 | 125 | package 126 | 127 | jar 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | release 138 | 139 | 140 | oss 141 | https://oss.sonatype.org/content/repositories/snapshots/ 142 | 143 | 144 | oss 145 | https://oss.sonatype.org/service/local/staging/deploy/maven2/ 146 | 147 | 148 | 149 | 150 | 151 | org.apache.maven.plugins 152 | maven-compiler-plugin 153 | 3.1 154 | 155 | 1.8 156 | 1.8 157 | 158 | 159 | 160 | 161 | org.apache.maven.plugins 162 | maven-source-plugin 163 | 3.0.1 164 | 165 | 166 | oss 167 | package 168 | 169 | jar-no-fork 170 | 171 | 172 | 173 | 174 | 175 | 176 | org.apache.maven.plugins 177 | maven-gpg-plugin 178 | 1.6 179 | 180 | 181 | oss 182 | verify 183 | 184 | sign 185 | 186 | 187 | 188 | 189 | 190 | org.sonatype.plugins 191 | nexus-staging-maven-plugin 192 | 1.6.8 193 | true 194 | 195 | oss 196 | https://oss.sonatype.org/ 197 | true 198 | 199 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | -------------------------------------------------------------------------------- /mvnw: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ---------------------------------------------------------------------------- 3 | # Licensed to the Apache Software Foundation (ASF) under one 4 | # or more contributor license agreements. See the NOTICE file 5 | # distributed with this work for additional information 6 | # regarding copyright ownership. The ASF licenses this file 7 | # to you under the Apache License, Version 2.0 (the 8 | # "License"); you may not use this file except in compliance 9 | # with the License. You may obtain a copy of the License at 10 | # 11 | # https://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, 14 | # software distributed under the License is distributed on an 15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 | # KIND, either express or implied. See the License for the 17 | # specific language governing permissions and limitations 18 | # under the License. 19 | # ---------------------------------------------------------------------------- 20 | 21 | # ---------------------------------------------------------------------------- 22 | # Maven2 Start Up Batch script 23 | # 24 | # Required ENV vars: 25 | # ------------------ 26 | # JAVA_HOME - location of a JDK home dir 27 | # 28 | # Optional ENV vars 29 | # ----------------- 30 | # M2_HOME - location of maven2's installed home dir 31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven 32 | # e.g. to debug Maven itself, use 33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files 35 | # ---------------------------------------------------------------------------- 36 | 37 | if [ -z "$MAVEN_SKIP_RC" ] ; then 38 | 39 | if [ -f /etc/mavenrc ] ; then 40 | . /etc/mavenrc 41 | fi 42 | 43 | if [ -f "$HOME/.mavenrc" ] ; then 44 | . "$HOME/.mavenrc" 45 | fi 46 | 47 | fi 48 | 49 | # OS specific support. $var _must_ be set to either true or false. 50 | cygwin=false; 51 | darwin=false; 52 | mingw=false 53 | case "`uname`" in 54 | CYGWIN*) cygwin=true ;; 55 | MINGW*) mingw=true;; 56 | Darwin*) darwin=true 57 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home 58 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html 59 | if [ -z "$JAVA_HOME" ]; then 60 | if [ -x "/usr/libexec/java_home" ]; then 61 | export JAVA_HOME="`/usr/libexec/java_home`" 62 | else 63 | export JAVA_HOME="/Library/Java/Home" 64 | fi 65 | fi 66 | ;; 67 | esac 68 | 69 | if [ -z "$JAVA_HOME" ] ; then 70 | if [ -r /etc/gentoo-release ] ; then 71 | JAVA_HOME=`java-config --jre-home` 72 | fi 73 | fi 74 | 75 | if [ -z "$M2_HOME" ] ; then 76 | ## resolve links - $0 may be a link to maven's home 77 | PRG="$0" 78 | 79 | # need this for relative symlinks 80 | while [ -h "$PRG" ] ; do 81 | ls=`ls -ld "$PRG"` 82 | link=`expr "$ls" : '.*-> \(.*\)$'` 83 | if expr "$link" : '/.*' > /dev/null; then 84 | PRG="$link" 85 | else 86 | PRG="`dirname "$PRG"`/$link" 87 | fi 88 | done 89 | 90 | saveddir=`pwd` 91 | 92 | M2_HOME=`dirname "$PRG"`/.. 93 | 94 | # make it fully qualified 95 | M2_HOME=`cd "$M2_HOME" && pwd` 96 | 97 | cd "$saveddir" 98 | # echo Using m2 at $M2_HOME 99 | fi 100 | 101 | # For Cygwin, ensure paths are in UNIX format before anything is touched 102 | if $cygwin ; then 103 | [ -n "$M2_HOME" ] && 104 | M2_HOME=`cygpath --unix "$M2_HOME"` 105 | [ -n "$JAVA_HOME" ] && 106 | JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 107 | [ -n "$CLASSPATH" ] && 108 | CLASSPATH=`cygpath --path --unix "$CLASSPATH"` 109 | fi 110 | 111 | # For Mingw, ensure paths are in UNIX format before anything is touched 112 | if $mingw ; then 113 | [ -n "$M2_HOME" ] && 114 | M2_HOME="`(cd "$M2_HOME"; pwd)`" 115 | [ -n "$JAVA_HOME" ] && 116 | JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" 117 | # TODO classpath? 118 | fi 119 | 120 | if [ -z "$JAVA_HOME" ]; then 121 | javaExecutable="`which javac`" 122 | if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then 123 | # readlink(1) is not available as standard on Solaris 10. 124 | readLink=`which readlink` 125 | if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then 126 | if $darwin ; then 127 | javaHome="`dirname \"$javaExecutable\"`" 128 | javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" 129 | else 130 | javaExecutable="`readlink -f \"$javaExecutable\"`" 131 | fi 132 | javaHome="`dirname \"$javaExecutable\"`" 133 | javaHome=`expr "$javaHome" : '\(.*\)/bin'` 134 | JAVA_HOME="$javaHome" 135 | export JAVA_HOME 136 | fi 137 | fi 138 | fi 139 | 140 | if [ -z "$JAVACMD" ] ; then 141 | if [ -n "$JAVA_HOME" ] ; then 142 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 143 | # IBM's JDK on AIX uses strange locations for the executables 144 | JAVACMD="$JAVA_HOME/jre/sh/java" 145 | else 146 | JAVACMD="$JAVA_HOME/bin/java" 147 | fi 148 | else 149 | JAVACMD="`which java`" 150 | fi 151 | fi 152 | 153 | if [ ! -x "$JAVACMD" ] ; then 154 | echo "Error: JAVA_HOME is not defined correctly." >&2 155 | echo " We cannot execute $JAVACMD" >&2 156 | exit 1 157 | fi 158 | 159 | if [ -z "$JAVA_HOME" ] ; then 160 | echo "Warning: JAVA_HOME environment variable is not set." 161 | fi 162 | 163 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher 164 | 165 | # traverses directory structure from process work directory to filesystem root 166 | # first directory with .mvn subdirectory is considered project base directory 167 | find_maven_basedir() { 168 | 169 | if [ -z "$1" ] 170 | then 171 | echo "Path not specified to find_maven_basedir" 172 | return 1 173 | fi 174 | 175 | basedir="$1" 176 | wdir="$1" 177 | while [ "$wdir" != '/' ] ; do 178 | if [ -d "$wdir"/.mvn ] ; then 179 | basedir=$wdir 180 | break 181 | fi 182 | # workaround for JBEAP-8937 (on Solaris 10/Sparc) 183 | if [ -d "${wdir}" ]; then 184 | wdir=`cd "$wdir/.."; pwd` 185 | fi 186 | # end of workaround 187 | done 188 | echo "${basedir}" 189 | } 190 | 191 | # concatenates all lines of a file 192 | concat_lines() { 193 | if [ -f "$1" ]; then 194 | echo "$(tr -s '\n' ' ' < "$1")" 195 | fi 196 | } 197 | 198 | BASE_DIR=`find_maven_basedir "$(pwd)"` 199 | if [ -z "$BASE_DIR" ]; then 200 | exit 1; 201 | fi 202 | 203 | ########################################################################################## 204 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 205 | # This allows using the maven wrapper in projects that prohibit checking in binary data. 206 | ########################################################################################## 207 | if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then 208 | if [ "$MVNW_VERBOSE" = true ]; then 209 | echo "Found .mvn/wrapper/maven-wrapper.jar" 210 | fi 211 | else 212 | if [ "$MVNW_VERBOSE" = true ]; then 213 | echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." 214 | fi 215 | jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.4.2/maven-wrapper-0.4.2.jar" 216 | while IFS="=" read key value; do 217 | case "$key" in (wrapperUrl) jarUrl="$value"; break ;; 218 | esac 219 | done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" 220 | if [ "$MVNW_VERBOSE" = true ]; then 221 | echo "Downloading from: $jarUrl" 222 | fi 223 | wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" 224 | 225 | if command -v wget > /dev/null; then 226 | if [ "$MVNW_VERBOSE" = true ]; then 227 | echo "Found wget ... using wget" 228 | fi 229 | wget "$jarUrl" -O "$wrapperJarPath" 230 | elif command -v curl > /dev/null; then 231 | if [ "$MVNW_VERBOSE" = true ]; then 232 | echo "Found curl ... using curl" 233 | fi 234 | curl -o "$wrapperJarPath" "$jarUrl" 235 | else 236 | if [ "$MVNW_VERBOSE" = true ]; then 237 | echo "Falling back to using Java to download" 238 | fi 239 | javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" 240 | if [ -e "$javaClass" ]; then 241 | if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 242 | if [ "$MVNW_VERBOSE" = true ]; then 243 | echo " - Compiling MavenWrapperDownloader.java ..." 244 | fi 245 | # Compiling the Java class 246 | ("$JAVA_HOME/bin/javac" "$javaClass") 247 | fi 248 | if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 249 | # Running the downloader 250 | if [ "$MVNW_VERBOSE" = true ]; then 251 | echo " - Running MavenWrapperDownloader.java ..." 252 | fi 253 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") 254 | fi 255 | fi 256 | fi 257 | fi 258 | ########################################################################################## 259 | # End of extension 260 | ########################################################################################## 261 | 262 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} 263 | if [ "$MVNW_VERBOSE" = true ]; then 264 | echo $MAVEN_PROJECTBASEDIR 265 | fi 266 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 267 | 268 | # For Cygwin, switch paths to Windows format before running java 269 | if $cygwin; then 270 | [ -n "$M2_HOME" ] && 271 | M2_HOME=`cygpath --path --windows "$M2_HOME"` 272 | [ -n "$JAVA_HOME" ] && 273 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` 274 | [ -n "$CLASSPATH" ] && 275 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"` 276 | [ -n "$MAVEN_PROJECTBASEDIR" ] && 277 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` 278 | fi 279 | 280 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 281 | 282 | exec "$JAVACMD" \ 283 | $MAVEN_OPTS \ 284 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 285 | "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 286 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 287 | --------------------------------------------------------------------------------