在 MyBatis 中如何查看生成的 SQL 语句

在使用MyBatis进行数据库操作时，有时候我们想要查看生成的SQL语句以便调试和优化，本文将介绍如何通过配置和具体代码示例来实现在MyBatis中查看SQL语句。

1. 配置MyBatis显示SQL语句

要在MyBatis中查看SQL语句，首先需要做一些配置。在MyBatis的配置文件mybatis-config.xml中添加以下配置：

<configuration>
    <settings>
        <setting name="logImpl" value="STDOUT_LOGGING" />
    </settings>
</configuration>

这个配置告诉MyBatis使用STDOUT_LOGGING作为日志输出器，这样MyBatis执行SQL语句时会打印出相应的SQL语句。

2. 编写Mapper文件

假设有一个User表对应的实体类User，我们来编写一个简单的Mapper文件UserMapper.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="com.example.mapper.UserMapper">
    <select id="selectUserById" resultType="com.example.model.User">
        SELECT * FROM user WHERE id = #{id}
    </select>
</mapper>

3. 编写Java代码

接下来，我们编写Java代码来使用这个Mapper文件，并查看生成的SQL语句。假设有一个UserService类：

package com.example.service;

import com.example.model.User;
import com.example.mapper.UserMapper;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public class UserService {
    private static final Logger logger = LogManager.getLogger(UserService.class);

    private SqlSessionFactory sqlSessionFactory;

    public UserService(SqlSessionFactory sqlSessionFactory) {
        this.sqlSessionFactory = sqlSessionFactory;
    }

    public User getUserById(int id) {
        try (SqlSession sqlSession = sqlSessionFactory.openSession()) {
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            User user = userMapper.selectUserById(id);
            logger.info(sqlSession.getConfiguration().getMappedStatement("com.example.mapper.UserMapper.selectUserById").getBoundSql(user).getSql());
            return user;
        }
    }
}

4. 查看生成的SQL语句

最后，我们可以通过调用getUserById方法来查看生成的SQL语句。例如在main方法中：

public static void main(String[] args) {
    String resource = "mybatis-config.xml";
    try (InputStream inputStream = Resources.getResourceAsStream(resource)) {
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        UserService userService = new UserService(sqlSessionFactory);
        User user = userService.getUserById(1);

        // 这里将会输出生成的SQL语句
    } catch (IOException e) {
        e.printStackTrace();
    }
}

运行程序后，你会在日志中看到打印的SQL语句，这样就能方便地查看MyBatis生成的SQL语句了。

通过以上配置和代码示例，你可以在MyBatis中方便地查看生成的SQL语句，帮助你调试和优化数据库操作。祝你学习进步！