本文旨在解决MyBatis在多XML Mapper文件场景下查询日志配置的挑战。针对传统`java.sql`配置失效的问题，文章提供了两种主要解决方案：一是通过配置Mapper命名空间的共同包前缀实现批量日志输出，二是推荐使用如JdbcDsLog等外部JDBC日志工具，尤其适用于Mapper命名空间无共同前缀或需更高级日志功能的场景。文章将详细阐述配置方法和适用场景，帮助开发者高效管理MyBatis查询日志。
MyBatis查询日志配置概述
在从iBATIS迁移到MyBatis，并升级Spring框架版本后，许多开发者可能会遇到之前通过简单配置java.sql来记录SQL查询日志的方法不再奏效的问题。尤其当项目中存在数百个XML Mapper文件时，逐个配置每个Mapper的命名空间进行日志记录变得不切实际且难以维护。本教程将探讨如何在MyBatis与Spring集成环境下，高效地配置查询日志，以满足大规模项目的需求。
挑战：传统java.sql日志配置失效
在iBATIS时代，通过在日志配置文件（如logs.properties）中添加java.sql=DEBUG通常足以输出SQL查询及其参数。然而，在MyBatis中，尤其是在与Spring框架集成时，这种配置可能不再直接生效。目前，唯一能直接记录查询的方法是为每个XML Mapper的命名空间单独设置日志级别。例如，如果一个Mapper的命名空间是com.example.mapper.UserMapper，则需要在日志配置文件中添加com.example.mapper.UserMapper=DEBUG。对于拥有500多个不同位置的XML Mapper文件的大型项目来说，这种方法显然是不可行的。
解决方案一：利用Mapper命名空间的共同包前缀
如果您的MyBatis Mapper命名空间遵循一定的命名规范，即它们共享一个共同的包前缀，那么您可以利用这个共同前缀来批量配置日志级别。这种方法极大地简化了配置过程，避免了为每个Mapper单独设置。
实现原理： MyBatis在内部会使用Mapper接口或XML命名空间作为日志记录器的名称。如果所有Mapper都位于同一个逻辑包下（例如，命名空间都以com.example.data.mapper开头），您就可以为这个共同的包前缀设置一个日志级别。
配置示例：
假设您的MyBatis Mapper命名空间如下：
- com.example.data.mapper.UserMapper
- com.example.data.mapper.ProductMapper
- com.example.data.mapper.OrderMapper
它们的共同包前缀是com.example.data.mapper。
使用JDK Logger (通过logging.properties)
# 设置所有以 com.example.data.mapper 开头的日志记录器的级别为 FINE (等同于DEBUG) com.example.data.mapper.level=FINE
使用Log4j (通过log4j.properties)
# 设置所有以 com.example.data.mapper 开头的日志记录器的级别为 DEBUG log4j.logger.com.example.data.mapper=DEBUG, stdout
使用Logback (通过logback.xml)
注意事项：
- 请确保您的所有Mapper命名空间确实共享一个共同的、可识别的前缀。
- 根据您使用的具体日志框架（JDK Logger, Log4j, Logback等），配置语法会有所不同。
- 日志级别（如FINE, DEBUG）的选择应根据您的需求来定。DEBUG通常用于开发环境，生产环境应谨慎使用或调整级别。
解决方案二：采用外部JDBC日志工具
当Mapper命名空间没有共同的包前缀，或者您需要更高级的日志功能（如更详细的参数格式化、性能统计等）时，使用外部JDBC日志工具是更优的选择。这些工具通常通过代理或包装JDBC驱动/数据源的方式，在SQL语句执行前拦截并记录相关信息，与MyBatis本身的日志机制解耦，提供更灵活和强大的日志能力。
推荐工具：JdbcDsLog
JdbcDsLog 是一个流行的JDBC日志工具，它通过包装您的数据源来实现SQL语句的拦截和日志记录。它的优点是：
- 与MyBatis解耦： 无需修改MyBatis配置，只需在数据源层面进行配置。
- 统一日志： 无论有多少个Mapper，都能统一记录所有通过该数据源执行的SQL。
- 详细信息： 通常能提供SQL语句、执行时间、参数等详细信息。
- 易于集成： 通常只需修改Spring配置中的数据源定义。
集成JdbcDsLog示例（以Spring Boot为例，配置数据源）
首先，您需要将JdbcDsLog的依赖添加到您的项目中。
com.github.adrianshum jdbcdslog 最新版本
然后，在Spring配置中，将您的数据源包装成ProxyDataSource。
使用Java配置方式 (推荐)
import com.github.adrianshum.jdbcdslog.ProxyDataSource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.jdbc.datasource.DriverManagerDataSource;
import javax.sql.DataSource;
@Configuration
public class DataSourceConfig {
@Bean
public DataSource originalDataSource() {
DriverManagerDataSource dataSource = new DriverManagerDataSource();
dataSource.setDriverClassName("com.mysql.cj.jdbc.Driver"); // 替换为您的数据库驱动
dataSource.setUrl("jdbc:mysql://localhost:3306/yourdb");
dataSource.setUsername("user");
dataSource.setPassword("password");
return dataSource;
}
@Bean
public DataSource proxyDataSource() {
// 将原始数据源包装为 ProxyDataSource
return new ProxyDataSource(originalDataSource());
}
}在Spring XML配置中
配置完成后，JdbcDsLog会拦截所有通过proxyDataSource执行的SQL语句，并将其输出到您配置的日志系统中。您需要在日志配置文件中为com.github.adrianshum.jdbcdslog或其子包设置适当的日志级别。
使用Log4j (通过log4j.properties)
log4j.logger.com.github.adrianshum.jdbcdslog=DEBUG, stdout
总结
在MyBatis与Spring集成项目中，高效配置查询日志是开发和调试的关键。当传统的java.sql配置不再适用，且项目包含大量XML Mapper文件时，我们提供了两种主要策略：
- 利用共同包前缀： 如果Mapper命名空间有共同的包前缀，这是最简单直接的解决方案。通过在日志配置文件中为该前缀设置日志级别，可以批量开启查询日志。
- 采用外部JDBC日志工具： 对于命名空间无共同前缀，或需要更强大、更灵活的日志功能的场景，如JdbcDsLog这样的外部工具是更专业的选择。它们通过在数据源层面拦截SQL，提供与MyBatis解耦的统一日志解决方案。
根据项目的具体情况、Mapper命名规范以及对日志详细程度的需求，选择最适合您的解决方案。无论选择哪种方法，都应确保在生产环境中谨慎管理日志级别，以避免性能开销和敏感信息泄露。
