mybatisplus开启sql打印的三种方式

MyBatis-Plus 是一款基于 MyBatis 的增强工具，它为开发者提供了许多便利的功能，其中包括 SQL 打印功能。通过 SQL 打印，我们可以在控制台上查看生成的 SQL 语句及其执行参数，这对于调试和性能优化非常有帮助。MyBatis-Plus 的 SQL 打印可以通过三种主要方式来开启：全局配置、日志配置和开发工具类配置。接下来，我们将逐一介绍这三种方式，并附上相应的代码示例。

一、全局配置

MyBatis-Plus 允许通过全局配置来开启 SQL 打印。你可以在 application.yml 或 application.properties 文件中进行配置。

以 application.yml 为例：

mybatis-plus:
  global-config:
    sql-logger: true

将 sql-logger 设置为 true，这样在执行 SQL 语句的时候，MyBatis-Plus 会自动在控制台输出日志信息。以上配置适用于 Spring Boot 的项目。

二、日志配置

除了全局配置外，我们还可以通过日志框架来配置 SQL 打印。MyBatis-Plus 支持多种日志框架，比如 Log4j、Slf4j、Logback 等。这里以 Logback 为例：

首先，在 pom.xml 中添加 Logback 依赖（如果还没有添加的话）：

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.3</version>
</dependency>

接着在 src/main/resources 目录下创建或修改 logback-spring.xml 文件，添加以下配置：

<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} - %-5level - %msg%n</pattern>
        </encoder>
    </appender>

    <logger name="com.baomidou.mybatisplus" level="DEBUG" />
    <logger name="org.apache.ibatis" level="DEBUG" />

    <root level="INFO">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

这里我们将 MyBatis-Plus 和 MyBatis 的日志级别设置为 DEBUG，这样可以打印出 SQL 语句及对应的参数信息。

三、开发工具类配置

如果你在某些特定场合下需要动态开启或关闭 SQL 打印，可以使用 MyBatis-Plus 提供的工具类。在某些场景下（例如：开发环境与生产环境的切换），你可能需要更加灵活的控制。

以下是一个简单的示例，展示如何在代码中动态地设置 SQL 打印：

import com.baomidou.mybatisplus.core.MybatisPlusConfiguration;
import com.baomidou.mybatisplus.core.MybatisSqlSessionFactoryBean;

public class MybatisPlusConfig {
    public MybatisSqlSessionFactoryBean mybatisSqlSessionFactoryBean() {
        MybatisSqlSessionFactoryBean sqlSessionFactory = new MybatisSqlSessionFactoryBean();

        // 修改全局配置
        MybatisPlusConfiguration configuration = new MybatisPlusConfiguration();
        configuration.setSqlLogger(true); // 开启 SQL 打印
        sqlSessionFactory.setConfiguration(configuration);

        return sqlSessionFactory;
    }
}

需要注意的是，以上代码仅为示例，具体实现可能会根据项目的实际情况有所不同。

总结

MyBatis-Plus 提供了多种方式来实现 SQL 打印，便于开发者在实际开发中对 SQL 进行调试和优化。通过全局配置、日志配置以及开发工具类的方式，我们可以灵活地控制 SQL 日志的输出。在实际的开发过程中，合理利用这些设置，可以大大提高我们的工作效率。希望这篇文章能够帮助你更好地理解 MyBatis-Plus 的 SQL 打印功能。