MyBatis 打印完整SQL。
描述
一种比较笨笨的办法,在控制台打印完整SQL。
案例
控制台打印如下结果
==> Preparing: UPDATE menu SET menu_name=? WHERE id=?
======================
RUN-SQL-author: Yzemin ::com.yangzemin.test200701.startup.MenuMapper.updateName
UPDATE menu SET menu_name= '更新名称' WHERE id= '17766430903107584'
======================
==> Parameters: 更新名称(String), 17766430903107584(Long)
<== Updates: 1
Rolling back JDBC Connection [com.mysql.jdbc.JDBC4Connection@40844aab]
实现说明
在MyBatis 中 接口 org.apache.ibatis.executor.parameter.ParameterHandler (参数处理器),在参数处理前收集到参数及SQL,再进行转换就能打印完整SQL。
以下用 MyBatis 3.3.0 为 基准。
找到 ParameterHandler 的实现类只有一个 org.apache.ibatis.scripting.defaults.DefaultParameterHandler ,将其调整为一下代码
package org.apache.ibatis.scripting.defaults;
import org.apache.ibatis.executor.ErrorContext;
import org.apache.ibatis.executor.parameter.ParameterHandler;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.ParameterMapping;
import org.apache.ibatis.mapping.ParameterMode;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.TypeHandler;
import org.apache.ibatis.type.TypeHandlerRegistry;
import java.sql.PreparedStatement;
import java.sql.SQLException;
import java.text.SimpleDateFormat;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
/**
* 默认参数处理器
*/
public class DefaultParameterHandler implements ParameterHandler {
// 时间转换
private final static SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
private final static DateTimeFormatter dateTimeFormatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
private final static DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern("yyyy-MM-dd");
private final TypeHandlerRegistry typeHandlerRegistry;
private final MappedStatement mappedStatement;
private final Object parameterObject;
private final BoundSql boundSql;
private final Configuration configuration;
public DefaultParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {
this.mappedStatement = mappedStatement;
this.configuration = mappedStatement.getConfiguration();
this.typeHandlerRegistry = mappedStatement.getConfiguration().getTypeHandlerRegistry();
this.parameterObject = parameterObject;
this.boundSql = boundSql;
}
// SQL 转换方法
private static String toStringSql(List<Object> keys, String sql) {
if (keys.isEmpty()) return sql;
StringBuilder returnSQL = new StringBuilder();
String[] subSQL = sql.split("\\?");
for (int i = 0; i < keys.size(); i++) {
if (keys.get(i) instanceof LocalDateTime) {
returnSQL.append(subSQL[i]).append(" '").append(
dateTimeFormatter.format((LocalDateTime) keys.get(i))
).append("' ");
} else if (keys.get(i) instanceof LocalDate) {
returnSQL.append(subSQL[i]).append(" '").append(dateFormatter.format((LocalDate) keys.get(i))).append("' ");
} else if (keys.get(i)