MyBatis（27）如何配置 MyBatis 实现打印可执行的 SQL 语句

MyBatis 是一个流行的 Java 持久层框架，它通过简单的 XML 或注解将对象与数据库中的记录进行映射。为了方便开发人员调试和确认 SQL 语句的正确性，MyBatis 提供了多种方式来输出可执行的 SQL 语句。本文将详细介绍如何配置 MyBatis 打印 SQL 语句，并提供完整的代码示例。

1. 配置 MyBatis

在使用 MyBatis 之前，我们需要首先配置 MyBatis。可以通过 XML 或 Java 配置来实现。以下示例使用 XML 配置。

首先，你需要在你的项目中引入 MyBatis 的相关依赖，例如 Maven 项目中可以添加如下依赖：

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.7</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.30</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>1.7.30</version>
</dependency>

2. MyBatis 配置文件

创建一个名为 mybatis-config.xml 的配置文件，并进行如下配置：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org/DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <settings>
        <setting name="logImpl" value="LOG4J2"/>
    </settings>

    <plugins>
        <plugin interceptor="org.mybatis.example.ExamplePlugin">
            <property name="someProperty" value="value"/>
        </plugin>
    </plugins>

    <mappers>
        <mapper resource="your/mapper/PathMapper.xml"/>
    </mappers>
</configuration>

在这里，logImpl 设置为 LOG4J2，作为日志实现的库，接下来我们需要配置 Log4j2 来输出日志。

3. Log4j2 配置

在项目的资源目录下创建 log4j2.xml 的配置文件，内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1} - %m%n"/>
        </Console>
    </Appenders>
    <Loggers>
        <Logger name="org.mybatis" level="DEBUG" additivity="false">
            <AppenderRef ref="Console"/>
        </Logger>
        <Root level="INFO">
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
</Configuration>

这段配置将在控制台打印出 SQL 执行的详细信息。

4. Mapper 文件

创建一个 Mapper 文件，例如 PathMapper.xml，内容如下：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org/DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="your.mapper.PathMapper">

    <select id="selectPath" resultType="String">
        SELECT path_name FROM paths WHERE id = #{id}
    </select>

</mapper>

5. 测试 SQL 输出

接下来在你的 Java 代码中执行 Mapper 方法，确保能看到 SQL 语句的打印。

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.example.util.MyBatisUtil;

public class MyBatisTest {
    public static void main(String[] args) {
        SqlSessionFactory sqlSessionFactory = MyBatisUtil.getSqlSessionFactory();
        try (SqlSession session = sqlSessionFactory.openSession()) {
            PathMapper mapper = session.getMapper(PathMapper.class);
            String pathName = mapper.selectPath(1);
            System.out.println("Path Name: " + pathName);
        }
    }
}

总结

通过以上步骤，您可以成功配置 MyBatis 打印 SQL 语句。首先配置 MyBatis 的 XML 文件和 Log4j2 日志框架，然后创建 Mapper 文件并进行 SQL 查询，运行代码便可在控制台中看到执行的 SQL 语句。这种调试方式非常有效，能够帮助开发人员快速定位问题和优化 SQL 语句。