MyBatis插件实践：打印SQL与执行时间

"mybatis 插件用于打印 SQL 语句及执行时间的实现方法" 在 MyBatis 框架中，插件(Plugins)是一个强大的特性，它允许开发者在特定点拦截已经映射的语句执行。通过插件，我们可以对 MyBatis 的核心组件如 Executor、ParameterHandler、ResultSetHandler 和 StatementHandler 的方法进行拦截。这些组件包括了执行更新、查询、设置参数、处理结果集等关键操作。不过，需要注意的是，修改这些底层类和方法可能会破坏 MyBatis 的正常工作，因此使用时应谨慎。 在实际开发中，有时我们需要监控 SQL 的执行情况，例如打印出每条 SQL 语句以及它的执行时间。MyBatis 自带的日志功能虽然可以记录 SQL，但存在一些局限性：参数被替换为问号，难以看出实际参数值；SQL 格式化不友好，多行显示影响阅读；并且不提供执行时间信息。 为了克服这些限制，我们可以编写一个自定义的 MyBatis 插件。以 `SqlCostInterceptor` 为例，这个插件实现了 `Interceptor` 接口。下面是如何创建这样一个插件的步骤： ```java / * Sql执行时间记录拦截器 */ @Intercepts({@Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class})}) public class SqlCostInterceptor implements Interceptor { // ... } ``` 在上面的代码中，`@Intercepts` 注解指定了我们要拦截的目标，这里是 `StatementHandler` 类的 `prepare` 方法，该方法通常在 SQL 执行前调用。`args = {Connection.class}` 表示该方法接受一个 `Connection` 参数。 接下来，我们需要重写 `Interceptor` 的 `intercept` 方法，这个方法会在目标方法执行前后被调用。在这里，我们可以在方法开始时记录当前时间，然后在方法结束时计算并打印 SQL 执行时间。同时，通过获取 SQL 语句和参数，我们可以得到实际执行的 SQL，如下所示： ```java @Override public Object intercept(Invocation invocation) throws Throwable { long start = System.currentTimeMillis(); Object proceed = invocation.proceed(); // 继续执行目标方法 long end = System.currentTimeMillis(); // 获取 SQL 语句和参数 Statement stmt = (Statement) invocation.getArgs()[1]; String sql = getSql(stmt); // 打印 SQL 和执行时间 log(sql, end - start); return proceed; } private void log(String sql, long cost) { System.out.println("SQL: " + sql + ", Cost: " + cost + "ms"); } private String getSql(Statement stmt) { // 这里根据不同的数据库驱动获取 SQL 语句，例如使用 stmt.toString() 或其他方式 } ``` 这样，每当 SQL 被执行，我们的插件就会自动记录并打印出 SQL 语句及其执行时间，方便我们分析和优化数据库操作性能。在实际项目中，可以考虑将日志输出配置为更高级的日志框架，如 Log4j 或 SLF4J，以便更好地管理和控制日志信息。 MyBatis 插件为我们提供了一种灵活的方式来扩展和增强框架的功能。通过自定义插件，我们可以实现诸如打印 SQL、计算执行时间等实用功能，有助于提升开发效率和优化数据库性能。