### Spring Boot 中
打印 MyBatis 生成的 SQL 配置
在 Spring Boot 应用程序中，可以通过多种方法实现
MyBatis 的 SQL 日志
打印功能。以下是几种常见的配置方式：
#### 方法一：通过 application.yml 或 application.properties 配置文件设置日志级别
可以在 `application.yml` 或 `application.properties` 文件中调整
MyBatis 和数据库驱动的日志级别来启用 SQL
打印。
对于 `application.yml`：
```yaml
logging:
level:
com.example.mapper: DEBUG # 替换为实际 Mapper 包路径
```
或者在 `application.properties` 中：
```properties
logging.level.com.example.mapper=DEBUG # 替换为实际 Mapper 包路径
```
这种方式利用了 Log4j、Logback 等日志框架的功能，可以有效控制 SQL 输出[^1]。
---
#### 方法二：修改
MyBatis 配置以显式指定日志实现类
如果希望更直观地查看 SQL 及其执行结果，可以直接在 `application.yml` 或 `application.properties` 中配置
MyBatis 使用标准输出作为日志记录工具。
例如，在 `application.yml` 中添加如下内容：
```yaml
mybatis:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
```
此配置会让
MyBatis 将所有的 SQL 查询及其参数直接
打印到控制台。
---
#### 方法三：自定义拦截器实现 SQL
打印
为了进一步增强灵活性并捕获更多细节（如耗时统计），可以创建一个自定义拦截器用于
打印 SQL。
以下是一个简单的拦截器实现示例：
```java
import net.sf.jsqlparser.util.deparser.StatementDeParser;
import org.apache.ibatis.executor.statement.BaseStatementHandler;
import org.apache.ibatis.plugin.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.sql.PreparedStatement;
import java.sql.SQLException;
import java.text.MessageFormat;
import java.util.Properties;
@Intercepts({
@Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class})
})
public class
MybatisSqlPrint implements Interceptor {
private static final Logger logger = LoggerFactory.getLogger(
MybatisSqlPrint.class);
@Override
public Object intercept(Invocation invocation) throws Throwable {
BaseStatementHandler statementHandler = (BaseStatementHandler) Plugin.wrap(invocation.getTarget(), this);
PreparedStatement preparedStatement = (PreparedStatement) invocation.proceed();
String rawSql = ((BaseStatementHandler) statementHandler).getBoundSql().getSql();
try {
StringBuilder formattedSql = new StringBuilder(rawSql.length());
MessageFormat formatter = new MessageFormat(rawSql);
Object[] parameters = ((BaseStatementHandler) statementHandler).getParameterHandler().getParameterObject();
if (parameters != null && parameters.length > 0) {
formattedSql.append(formatter.format(parameters));
}
logger.debug("Executed SQL: {}", formattedSql.toString());
} catch (Exception e) {
logger.error("Error while formatting SQL.", e);
}
return preparedStatement;
}
@Override
public Object plugin(Object target) {
return Plugin.wrap(target, this);
}
@Override
public void setProperties(Properties properties) {}
}
```
接着需要将该拦截器注册到
MyBatis 中。一种常见的方式是在配置类中完成这一操作：
```java
@Configuration
public class
MybatisConfig {
@Autowired
private SqlSessionFactory sqlSessionFactory;
@PostConstruct
public void init() {
sqlSessionFactory.getConfiguration().addInterceptor(new
MybatisSqlPrint());
}
}
```
这种方法允许开发者完全掌控 SQL 的格式化逻辑和额外信息展示[^2]。
---
#### 方法四：基于
MyBatis-Plus 自动支持 SQL
打印
当项目引入了
MyBatis-Plus 后，默认情况下也可以轻松开启 SQL
打印功能。只需确保 POM 文件中有正确的依赖项即可。
针对不同版本的 Spring Boot，请选择合适的 Starter 包。例如，Spring Boot 3.x 用户应使用以下依赖：
```xml
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>
mybatis-plus-spring-boot3-starter</artifactId>
<version>3.5.6</version>
</dependency>
```
之后同样可通过调整日志级别或启用插件的方式来观察 SQL 调试信息[^4]。
---
### 总结
以上介绍了四种主要的技术手段帮助开发人员实现在 Spring Boot 下
打印由
MyBatis 自动生成的 SQL
语句的目标。每种方案各有优劣，具体选用哪一种取决于团队需求和技术栈现状。
扫一扫
2263
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
