注意： 可以看到Druid监控中是看不到具体的完整SQL的，那么如果我们想要显示完整SQL，就需要添加一个 MybatisPlus 优化器
控制台日志输出通用也看不到完整SQL
创建SqlBeautyInterceptor类
package com.ssm.interceptor;
import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.ParameterMapping;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.defaults.DefaultSqlSession.StrictMap;
import java.lang.reflect.Field;
import java.sql.Statement;
import java.util.*;
@Intercepts(value = {
@Signature(args = {Statement.class, ResultHandler.class}, method = "query", type = StatementHandler.class),
@Signature(args = {Statement.class}, method = "update", type = StatementHandler.class),
@Signature(args = {Statement.class}, method = "batch", type = StatementHandler.class)})
public class SqlBeautyInterceptor implements Interceptor {
//可以看到Druid监控中是看不到具体的完整SQL的，那么如果我们想要显示完整SQL（控制台显示完整参数），就需要添加一个 MybatisPlus 优化器
@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 = formatSql(sql, parameterObject, parameterMappingList);
System.out.println("SQL： [ " + sql + " ]执行耗时[ " + sqlCost + "ms ]");
}
}
@Override
public Object plugin(Object o) {
return Plugin.wrap(o, this);
}
@Override
public void setProperties(Properties properties) {
}
private String formatSql(String sql, Object parameterObject, List<ParameterMapping> parameterMappingList) {
if (sql == "" || sql.length() == 0) {
return "";
}
sql = beautifySql(sql);
if (parameterObject == null || parameterMappingList == null || parameterMappingList.size() == 0) {
return sql;
}
String sqlWithoutReplacePlaceholder = sql;
try {
if (parameterMappingList != null) {
Class<?> parameterObjectClass = parameterObject.getClass();
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)) {
Map<?, ?> paramMap = (Map<?, ?>) parameterObject;
sql = handleMapParameter(sql, paramMap, parameterMappingList);
} else {
sql = handleCommonParameter(sql, parameterMappingList, parameterObjectClass, parameterObject);
}
}
} catch (Exception e) {
return sqlWithoutReplacePlaceholder;
}
return sql;
}
private String handleCommonParameter(String sql, List<ParameterMapping> parameterMappingList,
Class<?> parameterObjectClass, Object parameterObject) throws Exception {
Class<?> originalParameterObjectClass = parameterObjectClass;
List<Field> allFieldList = new ArrayList<>();
while (parameterObjectClass != null) {
allFieldList.addAll(new ArrayList<>(Arrays.asList(parameterObjectClass.getDeclaredFields())));
parameterObjectClass = parameterObjectClass.getSuperclass();
}
Field[] fields = new Field[allFieldList.size()];
fields = allFieldList.toArray(fields);
parameterObjectClass = originalParameterObjectClass;
for (ParameterMapping parameterMapping : parameterMappingList) {
String propertyValue = null;
if (isPrimitiveOrPrimitiveWrapper(parameterObjectClass)) {
propertyValue = parameterObject.toString();
} else {
String propertyName = parameterMapping.getProperty();
Field field = null;
for (Field everyField : fields) {
if (everyField.getName().equals(propertyName)) {
field = everyField;
}
}
field.setAccessible(true);
propertyValue = String.valueOf(field.get(parameterObject));
if (parameterMapping.getJavaType().isAssignableFrom(String.class)) {
propertyValue = """ + propertyValue + """;
}
}
sql = sql.replaceFirst("\?", propertyValue);
}
return sql;
}
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 handleListParameter(String sql, Collection<?> col) {
if (col != null && col.size() != 0) {
for (Object obj : col) {
String value = null;
Class<?> objClass = obj.getClass();
if (isPrimitiveOrPrimitiveWrapper(objClass)) {
value = obj.toString();
} else if (objClass.isAssignableFrom(String.class)) {
value = """ + obj.toString() + """;
}
sql = sql.replaceFirst("\?", value);
}
}
return sql;
}
private String beautifySql(String sql) {
sql = sql.replaceAll("[\s\n ]+", " ");
return sql;
}
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的内部类StrictMap
*/
private boolean isStrictMap(Class<?> parameterObjectClass) {
return parameterObjectClass.isAssignableFrom(StrictMap.class);
}
/**
* 是否List的实现类
*/
private boolean isList(Class<?> clazz) {
Class<?>[] interfaceClasses = clazz.getInterfaces();
for (Class<?> interfaceClass : interfaceClasses) {
if (interfaceClass.isAssignableFrom(List.class)) {
return true;
}
}
return false;
}
/**
* 是否Map的实现类
*/
private boolean isMap(Class<?> parameterObjectClass) {
Class<?>[] interfaceClasses = parameterObjectClass.getInterfaces();
for (Class<?> interfaceClass : interfaceClasses) {
if (interfaceClass.isAssignableFrom(Map.class)) {
return true;
}
}
return false;
}
}
创建MybatisConfiguration类
说明： 如果我们想要使用 SqlBeautyInterceptor类，那么我们需要将这个类集成进我们的框架，就需要创建相应的配置类！
@ConditionalOnProperty 是否生效交由业务方来定夺！
package com.ssm.config;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import com.ssm.interceptor.SqlBeautyInterceptor;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;
@Configuration
public class MybatisConfiguration {
//如果我们想要使用SqlBeautyInterceptor类，那么我们需要将这个类集成进mybatisplus的框架，就需要创建相应的配置类！
@Bean //havingValue期望值 matchIfMissing默认值，为true即某模块没有在yml文件配置时，该模块自动生效sql优化
@ConditionalOnProperty(value = {"sql.beauty.show"}, havingValue = "true", matchIfMissing = true)
public SqlBeautyInterceptor sqlBeautyInterceptor() {
return new SqlBeautyInterceptor();
}
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor());
return mybatisPlusInterceptor;
}
}
