发布于 由admin

JAVA MyBatis 日志打印不全？logImpl 与 SLF4J 配置问题

MyBatis 日志打印不全？logImpl 与 SLF4J 配置问题

大家好，今天我们来聊聊在使用 MyBatis 时经常遇到的一个问题：日志打印不全。这个问题可能导致我们在开发和调试阶段难以追踪 SQL 执行情况，从而影响开发效率。我们将深入探讨导致此问题的原因，特别是 logImpl 的选择以及与 SLF4J 的集成，并提供详细的解决方案。

问题描述：MyBatis 日志打印不全的现象

在使用 MyBatis 的过程中，我们期望能够打印出完整的 SQL 语句、参数信息以及执行结果，以便更好地了解程序的运行状态。然而，有时我们会发现 MyBatis 仅仅打印了部分信息，例如只显示了 SQL 语句，而没有显示参数，或者日志完全没有输出。

这种现象可能表现为：

  • 只有 SQL 语句，没有参数值。
  • 只有部分 SQL 语句，例如只有 SELECT * FROM，没有 WHERE 子句。
  • 完全没有 SQL 日志输出。

问题根源：logImpl 的选择和配置

MyBatis 提供了多种日志实现方式，通过 logImpl 属性进行配置。这个属性决定了 MyBatis 使用哪个日志框架来输出日志。常见的 logImpl 有以下几种：

logImpl 值 对应的日志框架 说明
SLF4J SLF4J 桥接器，将 MyBatis 的日志输出到 SLF4J，需要配置 SLF4J 绑定到具体的日志实现框架，如 Logback、Log4j 等。推荐使用。
LOG4J Log4j 1.x 使用 Log4j 1.x 作为日志实现。
LOG4J2 Log4j 2.x 使用 Log4j 2.x 作为日志实现。
JDK_LOGGING JDK Logging 使用 JDK 自带的 Logging API。
COMMONS_LOGGING Commons Logging 使用 Commons Logging 作为日志实现。
STDOUT_LOGGING System.out 直接将日志输出到标准输出（控制台）。
NO_LOGGING 不输出日志 禁用日志输出。

问题往往出在 logImpl 的选择和配置上：

  1. logImpl 未配置或配置错误： 如果没有在 MyBatis 的配置文件（mybatis-config.xml）中配置 logImpl，MyBatis 会尝试自动检测可用的日志框架，如果检测失败，可能导致没有日志输出或者使用默认的 NO_LOGGING。
  2. logImpl 与实际使用的日志框架不匹配： 例如，配置了 logImpl="LOG4J"，但项目中实际上使用的是 Logback，这会导致 MyBatis 无法正确输出日志。
  3. SLF4J 配置问题： 如果使用 logImpl="SLF4J"，但没有正确配置 SLF4J 的绑定，或者 SLF4J 绑定到了一个没有正确配置的日志框架，也会导致日志输出不完整。

使用 SLF4J 的优势

我们推荐使用 SLF4J 作为 MyBatis 的日志实现，因为它具有以下优势：

  • 解耦性： SLF4J 只是一个日志接口，不依赖于具体的日志实现。这意味着你可以在不修改代码的情况下切换不同的日志框架。
  • 性能： SLF4J 具有良好的性能，对应用程序的影响较小。
  • 灵活性： 可以根据需要选择不同的 SLF4J 绑定，例如 Logback、Log4j 等，以满足不同的日志需求。

解决方案：配置 logImpl 和 SLF4J

下面我们将详细介绍如何配置 logImpl 为 SLF4J，并正确配置 SLF4J 的绑定。

步骤 1：配置 mybatis-config.xml

在 mybatis-config.xml 文件中，添加或修改 settings 节点，配置 logImpl 属性：

<configuration>
  <settings>
    <setting name="logImpl" value="SLF4J"/>
  </settings>
  <!-- ... 其他配置 ... -->
</configuration>

步骤 2：添加 SLF4J 依赖

在 pom.xml 文件中，添加 SLF4J API 的依赖：

<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-api</artifactId>
  <version>1.7.36</version> <!-- 使用最新版本 -->
</dependency>

步骤 3：选择 SLF4J 绑定

你需要选择一个 SLF4J 绑定，将其绑定到具体的日志框架。常见的选择有 Logback 和 Log4j 2。

  • 使用 Logback：

    在 pom.xml 文件中，添加 Logback 的依赖：

    <dependency>
  <groupId>ch.qos.logback</groupId>
  <artifactId>logback-classic</artifactId>
  <version>1.2.11</version> <!-- 使用最新版本 -->
</dependency>

    Logback 默认会加载 logback.xml 或 logback-test.xml 文件作为配置文件。你需要在 src/main/resources 目录下创建 logback.xml 文件，并配置日志输出的格式、级别和目的地。

    一个简单的 logback.xml 示例：

    <configuration>
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
  </appender>

  <logger name="org.mybatis" level="DEBUG"/>
  <logger name="java.sql.Connection" level="DEBUG"/>
  <logger name="java.sql.Statement" level="DEBUG"/>
  <logger name="java.sql.PreparedStatement" level="DEBUG"/>

  <root level="INFO">
    <appender-ref ref="STDOUT"/>
  </root>
</configuration>

    这个配置文件会将 MyBatis 的日志输出到控制台，并将日志级别设置为 DEBUG。org.mybatis 设置为DEBUG，才能打印出完整的sql语句和参数。java.sql.开头的logger也设置为DEBUG，可以打印出数据库操作的详细信息。

  • 使用 Log4j 2：

    在 pom.xml 文件中，添加 Log4j 2 的依赖：

    <dependency>
  <groupId>org.apache.logging.log4j</groupId>
  <artifactId>log4j-slf4j-impl</artifactId>
  <version>2.17.2</version> <!-- 使用最新版本 -->
</dependency>
<dependency>
  <groupId>org.apache.logging.log4j</groupId>
  <artifactId>log4j-api</artifactId>
  <version>2.17.2</version> <!-- 使用最新版本 -->
</dependency>
<dependency>
  <groupId>org.apache.logging.log4j</groupId>
  <artifactId>log4j-core</artifactId>
  <version>2.17.2</version> <!-- 使用最新版本 -->
</dependency>

    Log4j 2 默认会加载 log4j2.xml、log4j2.json 或 log4j2.properties 文件作为配置文件。你需要在 src/main/resources 目录下创建 log4j2.xml 文件，并配置日志输出的格式、级别和目的地。

    一个简单的 log4j2.xml 示例：

    <?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
  <Appenders>
    <Console name="Console" target="SYSTEM_OUT">
      <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
    </Console>
  </Appenders>
  <Loggers>
    <Logger name="org.mybatis" level="DEBUG"/>
    <Logger name="java.sql.Connection" level="DEBUG"/>
    <Logger name="java.sql.Statement" level="DEBUG"/>
    <Logger name="java.sql.PreparedStatement" level="DEBUG"/>
    <Root level="INFO">
      <AppenderRef ref="Console"/>
    </Root>
  </Loggers>
</Configuration>

    这个配置文件会将 MyBatis 的日志输出到控制台，并将日志级别设置为 DEBUG。同样，org.mybatis 和 java.sql.* 的 logger 也设置为 DEBUG 级别。

步骤 4：确保依赖冲突得到解决

在使用 Maven 或 Gradle 等构建工具时，可能会出现依赖冲突。确保你的项目中没有其他日志框架的依赖与 SLF4J 或其绑定发生冲突。可以使用 Maven 的 mvn dependency:tree 命令或 Gradle 的 dependencies 命令来查看依赖树，并解决冲突。

步骤 5：检查 MyBatis 的 Mapper 文件

确保你的 MyBatis Mapper 文件（例如 UserMapper.xml）没有错误，例如 SQL 语句错误或参数类型错误。这些错误可能导致 MyBatis 无法正确执行 SQL 语句，从而导致日志输出不完整。

步骤 6：测试

完成以上配置后，运行你的 MyBatis 应用程序，并检查控制台或日志文件中是否输出了完整的 SQL 语句、参数信息和执行结果。如果仍然有问题，可以尝试调整日志级别或修改日志配置，以获取更详细的日志信息。

深入排查：其他可能导致日志打印不全的原因

除了 logImpl 和 SLF4J 配置问题之外，还有一些其他原因可能导致 MyBatis 日志打印不全：

  1. 事务问题： 如果你的 MyBatis 应用程序使用了事务，并且事务没有正确提交或回滚，可能会导致 SQL 语句没有实际执行，从而没有日志输出。检查你的事务管理代码，确保事务正确提交或回滚。
  2. 缓存问题： MyBatis 具有一级缓存和二级缓存。如果 SQL 语句的结果是从缓存中获取的，而不是实际执行的，可能不会有日志输出。可以通过配置 MyBatis 的缓存策略来控制缓存的使用。
  3. 拦截器问题： 如果你的 MyBatis 应用程序使用了拦截器（Interceptor），拦截器可能会修改 SQL 语句或参数，从而影响日志输出。检查你的拦截器代码，确保拦截器没有错误地修改 SQL 语句或参数。
  4. 数据库驱动问题： 某些数据库驱动可能不会将完整的 SQL 语句传递给 MyBatis，从而导致日志输出不完整。尝试更新数据库驱动到最新版本，或者更换其他数据库驱动。
  5. 连接池配置问题： 连接池的配置不当，例如最大连接数设置过小，可能导致 MyBatis 无法获取数据库连接，从而无法执行 SQL 语句，也就没有日志输出。检查你的连接池配置，确保连接池配置正确。

代码示例

下面是一个完整的示例，演示如何配置 MyBatis 和 SLF4J + Logback：

1. pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.example</groupId>
  <artifactId>mybatis-logging-example</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>jar</packaging>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <mybatis.version>3.5.10</mybatis.version>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis</artifactId>
      <version>${mybatis.version}</version>
    </dependency>

    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>1.7.36</version>
    </dependency>

    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>1.2.11</version>
    </dependency>

    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>8.0.29</version>
    </dependency>

    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.13.2</version>
      <scope>test</scope>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.8.1</version>
        <configuration>
          <source>1.8</source>
          <target>1.8</target>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

2. mybatis-config.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC"/>
      <dataSource type="POOLED">
        <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://localhost:3306/testdb"/>
        <property name="username" value="root"/>
        <property name="password" value="password"/>
      </dataSource>
    </environment>
  </environments>

  <settings>
    <setting name="logImpl" value="SLF4J"/>
  </settings>

  <mappers>
    <mapper resource="UserMapper.xml"/>
  </mappers>
</configuration>

3. logback.xml

<configuration>
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
  </appender>

  <logger name="org.mybatis" level="DEBUG"/>
  <logger name="java.sql.Connection" level="DEBUG"/>
  <logger name="java.sql.Statement" level="DEBUG"/>
  <logger name="java.sql.PreparedStatement" level="DEBUG"/>

  <root level="INFO">
    <appender-ref ref="STDOUT"/>
  </root>
</configuration>

4. 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.UserMapper">
  <select id="getUserById" resultType="com.example.User">
    SELECT * FROM users WHERE id = #{id}
  </select>
</mapper>

5. Java 代码示例

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.io.InputStream;

public class Main {

  private static final Logger logger = LoggerFactory.getLogger(Main.class);

  public static void main(String[] args) throws IOException {
    String resource = "mybatis-config.xml";
    InputStream inputStream = Resources.getResourceAsStream(resource);
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

    try (SqlSession session = sqlSessionFactory.openSession()) {
      UserMapper mapper = session.getMapper(UserMapper.class);
      User user = mapper.getUserById(1); // 假设数据库中存在 id 为 1 的用户
      logger.info("User: {}", user);
    }
  }
}

确保 User 类和 UserMapper 接口存在，并与 UserMapper.xml 中的定义匹配。 在这个例子中，我们配置了 SLF4J + Logback，并将 org.mybatis 和 java.sql.* 的日志级别设置为 DEBUG，以便能够打印出完整的 SQL 语句和参数信息。

解决日志打印不全，清晰掌握SQL执行细节

今天我们深入探讨了 MyBatis 日志打印不全的问题，着重分析了 logImpl 的选择以及与 SLF4J 的集成。正确配置 logImpl 和 SLF4J 绑定是解决问题的关键。

排查其他原因，全面保障日志完整性

除了 logImpl 和 SLF4J 配置问题，我们还讨论了其他可能导致日志打印不全的原因，例如事务问题、缓存问题、拦截器问题等。

实践是检验真理的唯一标准，动手配置并测试

通过本文提供的解决方案和代码示例，希望大家能够解决 MyBatis 日志打印不全的问题，并更好地了解和调试 MyBatis 应用程序。

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注