在 MySQL JDBC 驱动程序中记录原始 SQL

Dear 丶 2023-09-26 09:32 35阅读 0赞

我最近想看看休眠/JPA正在执行哪些SQL语句。在这篇文章中，我将展示一个使用 MySQL JDBC 驱动程序中的内置功能的简单解决方案。

### 我想完成什么 ###

*  记录*正在执行的所有* SQL 语句。最好采用可以复制/粘贴到 SQL 控制台中的格式。
 *  最好是，日志记录将由我自己使用某种事件处理程序来实现，因为我希望控制日志记录逻辑以添加[结构化日志记录][Link 1]。
 *  漂亮的印刷很好，但不是必需的。

经过一些实验，这排除了

*  休眠内部记录器。我无法轻松修改日志消息的格式，并且只能让它记录带有可变占位符的预准备语句。`?`
 *  数据源包装器，如 [GitHub - jdbc-observations/datasource-proxy: Provide listener framework for JDBC interactions and query executions via proxy.][GitHub - jdbc-observations_datasource-proxy_ Provide listener framework for JDBC interactions and query executions via proxy.]。同样，我无法让它在没有占位符的情况下记录“原始”SQL语句。`?`

幸运的是，我发现 MySQL JDBC 驱动程序支持注册 ，允许您记录正在执行的所有 SQL 查询。`ProfilerEventHandler`

@Bean // Example of integration with spring boot
    public DataSource mysqlDataSource() throws SQLException {
        MysqlDataSource dataSource = new MysqlDataSource();
        dataSource.setServerName("127.0.0.1");
        // ... more lines here setting user, password, etc.
        dataSource.setProfileSQL(true);
        dataSource.setProfilerEventHandler(
            MySQLQueryLogger.class.getName()
        );
        return dataSource;
    }

public class MySQLQueryLogger extends LoggingProfilerEventHandler {
        private final Logger logger = LoggerFactory.getLogger(MySQLQueryLogger.class);
    
        @Override
        public void consumeEvent(ProfilerEvent evt) {
            if (evt.getEventType() == ProfilerEvent.TYPE_QUERY) {
                logger.info("{}; /* {}{} */",
                    evt.getMessage(),
                    evt.getEventDuration(),
                    evt.getDurationUnits()
                );
            }
        }
    }

使用上面的内容，我现在可以在日志中看到以下内容：

Application      : Saving two new customers
    MySQLQueryLogger : SET autocommit=1; /* 1ms */
    MySQLQueryLogger : SET sql_mode='STRICT_TRANS_TABLES'; /* 1ms */
    MySQLQueryLogger : SET autocommit=0; /* 0ms */
    MySQLQueryLogger : insert into customers (name) values ('John Doe'); /* 1ms */
    MySQLQueryLogger : insert into customers (name) values ('Jane Doe'); /* 1ms */
    MySQLQueryLogger : commit; /* 2ms */
    MySQLQueryLogger : SET autocommit=1; /* 1ms */
    Application      : Saving done

有关完整示例，请参阅 [GitHub - remen/spring-boot-mysql-logger: Companion project to https://hairoftheyak.com/posts/logging-raw-sql-in-mysql-jdbc-driver][GitHub - remen_spring-boot-mysql-logger_ Companion project to https_hairoftheyak.com_posts_logging-raw-sql-in-mysql-jdbc-driver] 中的源代码

[Link 1]: https://www.elastic.co/blog/structured-logging-filebeat
[GitHub - jdbc-observations_datasource-proxy_ Provide listener framework for JDBC interactions and query executions via proxy.]: https://github.com/ttddyy/datasource-proxy
[GitHub - remen_spring-boot-mysql-logger_ Companion project to https_hairoftheyak.com_posts_logging-raw-sql-in-mysql-jdbc-driver]: https://github.com/remen/spring-boot-mysql-logger