springboot log4j2不能打印框架错误日志的解决方案

我们先来介绍一些概念：

Spring Boot：Spring Boot 旨在帮助您创建基于生产的最小限度的应用程序，使用 Spring 平台和第三方库，少量配置的方式，快速启动和运行应用程序。Spring Boot 提供了基础的生产级特性（例如，内嵌 Tomcat，配置管理，或者添加重量级依赖项）。

Log4j2：是目前业界使用广泛的日志框架之一，它提供了丰富的日志功能和简单的配置属性，支持滚动文件、文件分割等操作。

了解这些以后，我们来看一下 Spring Boot 的日志系统。Spring Boot 默认使用 Logback 作为日志框架，但是在实际应用中，也有很多人使用 Log4j2。但是，在使用 Log4j2 时，可能会出现一个问题，就是无法打印框架错误日志。接下来，我们一起探讨一下这个问题的解决方案。

问题分析

在使用 Log4j2 作为日志框架时，可能会遇到一些奇怪的问题。比如，在使用 Spring Boot 时，如果出现框架错误，无法在日志中打印出错误信息，这可能是由于 Log4j2 的框架错误捕捉机制导致的。

要理解这个问题，需要知道 Log4j2 是如何捕捉框架错误的。在 Log4j2 中，有一个类叫做 ThrowableProxy，它用于捕捉传递给日志系统的异常。Log4j2 的 ThrowableProxy 会检查异常的类是否以 “java.” 开始，如果是，则认为这个异常是框架错误，并将其抑制。这就是为什么我们无法在日志中看到框架错误的原因。

解决方案

要解决这个问题，我们需要在 Log4j2 的配置文件中加入以下配置：

<Configuration packages="org.apache.logging.log4j.core">
...
</Configuration>

这个配置告诉 Log4j2 在包 org.apache.logging.log4j.core 中查找 ThrowableProxy，这样就能正确地捕捉框架错误了。

下面，我们来看一下几个示例。

示例一

我们先创建一个简单的 Spring Boot 应用，并使用 Log4j2 进行日志记录。在应用程序中，我们引入一个不存在的类来触发框架错误。这时，在日志中应该可以看到一个类似这样的错误：

java.lang.ClassNotFoundException: com.example.demo.DoesNotExist

但是，在默认配置下，我们无法看到这个错误。接下来，我们来解决这个问题。

第一步，我们需要添加以下依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
    <version>2.2.6.RELEASE</version>
</dependency>

第二步，我们需要在 resources 目录下创建一个 log4j2.xml 文件，并添加以下内容：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration packages="org.apache.logging.log4j.core">
  <Appenders>
    <Console name="Console" target="SYSTEM_OUT">
      <PatternLayout pattern="%d %-5p [%t] %C{2} - %m%n"/>
    </Console>
  </Appenders>
  <Loggers>
    <Root level="info">
      <AppenderRef ref="Console"/>
    </Root>
  </Loggers>
</Configuration>

我们可以看到，这个配置文件包含了我们之前提到的 packages 配置。现在，重新运行应用程序，我们就可以在控制台上看到框架错误了。

示例二

我们再来看一种更为复杂的情况，假设我们的应用程序需要使用到第三方的日志组件，比如 MyBatis。在使用 MyBatis 时，如果出现异常，我们无法在日志中看到异常信息。接下来，我们来解决这个问题。

第一步，我们需要添加以下依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
    <version>2.2.6.RELEASE</version>
</dependency>

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.1.3</version>
</dependency>

第二步，我们需要在 resources 目录下创建一个 log4j2.xml 文件，并添加以下内容：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration packages="org.apache.logging.log4j.core">
  <Appenders>
    <Console name="Console" target="SYSTEM_OUT">
      <PatternLayout pattern="%d %-5p [%t] %C{2} - %m%n"/>
    </Console>
  </Appenders>
  <Loggers>
    <Root level="info">
      <AppenderRef ref="Console"/>
    </Root>
    <Logger name="org.mybatis" level="trace">
      <AppenderRef ref="Console"/>
    </Logger>
  </Loggers>
</Configuration>

在这个配置文件中，我们在 Logger 标签中添加了一个名为 org.mybatis 的记录器，并将日志级别设置为 trace。这意味着，当出现异常时，MyBatis 会输出 trace 级别的日志，我们就可以在日志中看到详细的错误信息了。

综上，我们可以看到，在使用 Log4j2 作为 Spring Boot 的日志框架时，需要特别注意框架错误的捕捉机制。通过添加 packages 配置，我们可以正确地捕捉到框架错误，并在日志中显示出来。