在使用mybatis-plus（mybatis）的時候，往往需要列印完整的sql語句，然而輸出的日誌不是很理想：
因為sql語句中的關鍵欄位資訊都是用？來代替的。那有什麼方法實現完整的sql列印呢？有是有的，我記得IDEA的外掛市場有一款外掛可以實現完整sql的列印，但是好像是要收費的。今天刷某音的時候看到了某博主分享了一下自己寫了一個攔截器實現了sql完整的列印，以下是實現的效果： 
可以看到了sql的執行時間和完整的sql語句。sql的執行時間沒啥好說的，關鍵是sql語句的完整列印。現在先來分享一下程式碼吧。
程式碼
controller的設計
這裏僅展示關鍵的程式碼，一個更新的操作，一個分頁查詢的操作。
@PostMapping(value = "update")
public Result<String> update(@RequestBody @Validated(value = UpdateGroup.class) User user) {
int update = userMapper.updateById(user);
return update > 0 ? Result.ok(null) : Result.err(null);
}
@GetMapping(value = "get")
public Result<List<User>> get(@RequestParam(value = "id", required = false) Integer id,
@RequestParam(value = "name", required = false) String name
) {
LambdaQueryWrapper<User> queryChainWrapper = new LambdaQueryWrapper<>();
queryChainWrapper.eq(id != null, User::getId, id);
queryChainWrapper.eq(name != null, User::getUsername, name);
List<User> records = userMapper.selectPage(new Page<User>(0, 10), queryChainWrapper).getRecords();
return Result.ok(records);
}
攔截器設計
雖然這裏是mybatis-plus框架，但是還是需要使用到mybatis的功能。
/**
* @author yk.li
* @date 2024/6/16 10:01
*/
@Intercepts({
@Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}),
@Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class, CacheKey.class, BoundSql.class}),
@Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class})
})
@Slf4j
public class SqlInterceptor implements Interceptor {
@Override
public Object intercept(Invocation invocation) throws Throwable {
// 統計sql執行耗時
long startTime = System.currentTimeMillis();
Object proceed = invocation.proceed();
long endTime = System.currentTimeMillis();
String printSql = null;
try {
printSql = generateSql(invocation);
} catch (Exception exception) {
log.error("獲取sql異常", exception);
} finally {
long costTime = endTime - startTime;
log.info("\n 執行SQL耗時：{}ms \n 執行SQL：{}", costTime, printSql);
}
return proceed;
}
private static String generateSql(Invocation invocation) {
MappedStatement statement = (MappedStatement) invocation.getArgs()[0];
Object parameter = null;
if (invocation.getArgs().length > 1) {
parameter = invocation.getArgs()[1];
}
Configuration configuration = statement.getConfiguration();
BoundSql boundSql = statement.getBoundSql(parameter);
// 獲取引數物件
Object parameterObject = boundSql.getParameterObject();
// 獲取引數對映
List<ParameterMapping> params = boundSql.getParameterMappings();
// 獲取到執行的SQL
String sql = boundSql.getSql();
// SQL中多個空格使用一個空格代替
sql = sql.replaceAll("[\s]+", " ");
if (!ObjectUtils.isEmpty(params) && !ObjectUtils.isEmpty(parameterObject)) {
// TypeHandlerRegistry 是 MyBatis 用來管理 TypeHandler 的註冊器 TypeHandler 用於在 Java 型別和 JDBC 型別之間進行轉換
TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
// 如果引數物件的型別有對應的 TypeHandler，則使用 TypeHandler 進行處理
if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
sql = sql.replaceFirst("\?", Matcher.quoteReplacement(getParameterValue(parameterObject)));
} else {
// 否則，逐個處理引數對映
for (ParameterMapping param : params) {
// 獲取引數的屬性名
String propertyName = param.getProperty();
MetaObject metaObject = configuration.newMetaObject(parameterObject);
// 檢查物件中是否存在該屬性的 getter 方法，如果存在就取出來進行替換
if (metaObject.hasGetter(propertyName)) {
Object obj = metaObject.getValue(propertyName);
sql = sql.replaceFirst("\?", Matcher.quoteReplacement(getParameterValue(obj)));
// 檢查 BoundSql 物件中是否存在附加引數
} else if (boundSql.hasAdditionalParameter(propertyName)) {
Object obj = boundSql.getAdditionalParameter(propertyName);
sql = sql.replaceFirst("\?", Matcher.quoteReplacement(getParameterValue(obj)));
} else {
// SQL匹配不上，帶上“缺失”方便找問題
sql = sql.replaceFirst("\?", "缺失");
}
}
}
}
return sql;
}
private static String getParameterValue(Object object) {
String value = "";
if (object instanceof String) {
value = "'" + object + "'";
} else if (object instanceof Date) {
DateFormat format = DateFormat.getDateTimeInstance(DateFormat.DEFAULT, DateFormat.DEFAULT, Locale.CHINA);
value = "'" + format.format((Date) object) + "'";
} else if (!ObjectUtils.isEmpty(object)) {
value = object.toString();
}
return value;
}
@Override
public Object plugin(Object target) {
return Plugin.wrap(target, this);
}
}
直接貼的程式碼，其實就是在sql執行完畢之後，根據sql的template和sql引數進行？的替換。
這裏不分析程式碼，希望能親自debug看一下。
配置類
這裏的配置我都寫在了mybatis-plus的配置程式碼裏邊。
@Configuration
@MapperScan(value = "main.java.shigen.demo.dao")
public class MybatisPlusConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
// 分頁外掛
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
// 樂觀鎖外掛
interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
return interceptor;
}
@Bean
public ConfigurationCustomizer configurationCustomizer() {
return configuration -> {
configuration.addInterceptor(new SqlInterceptor());
};
}
}
以上就是核心的程式碼了，實測遇到的問題有一個：
分頁查詢的時候，無法顯示
limit 0,10這個sql字尾
希望有時間的時候能夠再次最佳化一下。同時，也沒有經過實際的專案測試，只是簡單的demo測試。僅具有參考價值，無法保證實際的應用。
