轻松掌握Springboot项目中Mybatis输出SQL日志的三种姿势，让你从此告别数据库查询疑难杂症！

后端

2023-03-30 20:50:27

在 Spring Boot 项目中轻松输出 MyBatis SQL 日志

简介

在软件开发中，数据库查询是程序员最常见的操作之一。当代码出现问题时，定位到具体的 SQL 语句却常常让人抓狂不已。这往往需要我们对代码进行大量的调试和分析，耗费大量的时间和精力。

输出 SQL 日志的重要性

因此，在 Spring Boot 项目中，学会输出 SQL 日志就显得尤为重要。通过输出 SQL 日志，我们可以轻松地查看执行的 SQL 语句，从而快速定位到问题的根源，大大提高开发效率。

输出 MyBatis SQL 日志的三种方法

那么，在 Spring Boot 项目中，如何输出 MyBatis 的 SQL 日志呢？以下三种方法，请收好！

1. 使用 Log4j2Appender 输出 SQL 日志

Log4j2Appender 是 Spring Boot 默认的日志框架，也是使用最广泛的日志框架之一。要使用 Log4j2Appender 来输出 SQL 日志，需要在 Spring Boot 项目中添加如下依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

添加依赖后，需要在配置文件 application.yaml 中进行如下配置：

logging:
  level:
    root: warn
    org.mybatis: debug
  file:
    name: mybatis.log

其中，level.org.mybatis: debug 表示将 org.mybatis 包的日志级别设置为 debug，file.name: mybatis.log 表示将日志输出到 mybatis.log 文件中。

这样，当 Spring Boot 项目启动时，MyBatis 执行的 SQL 语句就会被输出到 mybatis.log 文件中，方便我们进行查看和分析。

2. 使用 Spring Boot 的 debug 模式输出 SQL 日志

在 Spring Boot 项目中，还可以使用 debug 模式来输出 SQL 日志。要开启 debug 模式，需要在 Spring Boot 项目启动时添加如下参数：

--debug

添加该参数后，Spring Boot 项目就会以 debug 模式启动，并会将 MyBatis 执行的 SQL 语句输出到控制台。

DEBUG org.mybatis.spring.MyBatisSystemException: nested exception is org.apache.ibatis.exceptions.PersistenceException:
*** Error querying database. Cause: java.sql.SQLException: No suitable driver found for jdbc:sqlserver://127.0.0.1:1433;DatabaseName=yqdzx_rs;user=sa;password=123456

3. 使用第三方工具输出 SQL 日志

除了以上两种方法，还可以使用第三方工具来输出 SQL 日志。这里推荐使用 Mybatis-Log 工具，它可以方便地将 MyBatis 执行的 SQL 语句输出到控制台或文件中。

要使用 Mybatis-Log 工具，需要在 Spring Boot 项目中添加如下依赖：

<dependency>
    <groupId>com.github.abel533</groupId>
    <artifactId>mybatis-log</artifactId>
    <version>1.2.0</version>
</dependency>

添加依赖后，需要在 Spring Boot 项目启动类中添加如下代码：

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
        MybatisLog.enableDebugLogging(); // 启用 Mybatis-Log 工具
    }
}