mybatis 插件: 打印 sql 及其执行时间实现方法

Mybatis插件是Mybatis框架提供的一种可插拔的机制，可以在Mybatis执行过程中通过拦截拦截器接口来修改其处理逻辑或者增加额外的处理逻辑。其中比较常见的插件是对 SQL 以及它们所需参数的拦截。下面给出实现Mybatis插件打印SQL及其执行时间的完整攻略。

1、实现拦截器类

在Mybatis中实现插件需要实现Interceptor接口，并重写其中的方法intercept()以及plugin()。下面给出一个样例代码：

public class SqlStatementInterceptor implements Interceptor {

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        // 在intercept方法中对SQL进行增强处理
        // 获取执行的SQL语句
        MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];
        Object parameter = invocation.getArgs()[1];
        BoundSql boundSql = mappedStatement.getBoundSql(parameter);
        String sql = boundSql.getSql();
        // 计时处理时间
        long startTime = System.currentTimeMillis();
        Object result = invocation.proceed();
        long endTime = System.currentTimeMillis();
        long sqlCost = endTime - startTime;
        // 打印SQL及其执行时间
        System.out.println("执行 SQL：[" + sql + "]，耗时：" + sqlCost + " ms");
        return result;
    }

    @Override
    public Object plugin(Object target) {
        // 使用Plugin的wrap方法生成动态代理对象，对Executor、StatementHandler接口进行拦截
        return Plugin.wrap(target, this);
    }

    @Override
    public void setProperties(Properties properties) {
        // 可以实现Interceptor接口中的setProperties方法，进行一些配置信息的设置
    }
}

该类实现了Mybatis的拦截器接口Interceptor，并在该接口的intercept()方法中完成了对SQL及其执行时间的拦截及打印。在plugin()方法中创建了一个动态代理对象，对Executor、StatementHandler接口进行拦截。

2、添加插件配置

拦截器类实现后，需要在Mybatis的配置文件中进行插件配置。在<configuration>标签中添加<plugins>标签，在其中添加<plugin>子标签，声明实现的插件类SqlStatementInterceptor，示例代码如下：

<configuration>
    <!-- 配置自定义的数据库连接信息 -->
    <dataSource type="UNPOOLED">
        <property name="driver" value="${db.driver}" />
        <property name="url" value="${db.url}" />
        <property name="username" value="${db.username}" />
        <property name="password" value="${db.password}" />
    </dataSource>

    <!-- 配置Mybatis插件 -->
    <plugins>
        <plugin interceptor="com.example.interceptor.SqlStatementInterceptor" />
    </plugins>

    <!-- 配置Mapper接口 -->
    <mappers>
        <mapper resource="com/example/mapper/UserMapper.xml" />
    </mappers>
</configuration>

3、示例说明

我们可以通过添加插件配置，启用拦截器，来实现打印 SQL 及其执行时间。下面给出两个示例：

示例一

@Test
public void testSelectUserById() {
    SqlSession sqlSession = sqlSessionFactory.openSession();
    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
    userMapper.selectUserById(1L);
}

在执行上述代码时，因为我们已经在Mybatis的配置文件中添加了拦截器配置，因此Mybatis会对执行的SQL进行拦截，最终输出以下日志：

DEBUG [main] - ==>  Preparing: SELECT * FROM tb_user WHERE id = ? 
DEBUG [main] - ==> Parameters: 1(Long)
DEBUG [main] - <==      Total: 1
执行 SQL：[SELECT * FROM tb_user WHERE id = ?]，耗时：4 ms

我们可以看到实际执行的SQL语句以及该语句的执行时间。

示例二

@Test
public void testSelectUsers() {
    SqlSession sqlSession = sqlSessionFactory.openSession();
    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
    userMapper.selectUsers("张", null, 2, 2);
    sqlSession.close();
}

在执行该示例代码时，Mybatis会对其执行的SQL进行拦截并输出日志。对于selectUsers()方法，我们在mapper的xml文件中进行了动态SQL拼接，因此实际执行的SQL语句为：

SELECT * FROM tb_user WHERE name like '%张%' LIMIT 2,2

最终输出以下日志：

DEBUG [main] - ==>  Preparing: SELECT * FROM tb_user WHERE name like ? LIMIT ?,? 
DEBUG [main] - ==> Parameters: %张%(String), 2(Integer), 2(Integer)
DEBUG [main] - <==      Total: 2
执行 SQL：[SELECT * FROM tb_user WHERE name like '%张%' LIMIT 2,2]，耗时：2 ms

我们可以看到拦截器成功拦截了该语句，并输出实际执行的SQL语句以及执行时间。