log4j和log4j2依赖冲突的解决办法

2020-08-22

< view all posts

log4j是一个功能强大的日志组件,利用log4j,我们可以将日志信息记录在控制台、文件、GUI组件、服务器等等位置,还可以方便地自定义日志的显示格式。在2015年,log4j 1.x停止更新,而log4j2相比于log4j 1.x有显著的性能和吞吐量的提升。

如果需要在项目中使用log4j2,有时会遇到这样的情况:项目引入的一些jar包是依赖于log4j 1.x的,直接使用Maven打包后,运行时会报错:

java.lang.NoClassDefFoundError: org/apache/log4j/LogManager

这是因为log4j的1和2版本同时引入,存在依赖冲突。只靠Maven的优先级管理,是无法用log4j2覆盖掉log4j 1.x的(比如利用pom文件中申明顺序优先原则,并不能够解决冲突)。

这时我们可以通过log4j-1.2-api将老版本的日志输出桥接到新版本的log4j2。在pom文件中添加以下依赖:

<dependency>
   <groupId>org.apache.logging.log4j</groupId>
   <artifactId>log4j-1.2-api</artifactId>
   <version>2.9.1</version>
</dependency>
<dependency>
  <groupId>org.apache.logging.log4j</groupId>
  <artifactId>log4j-api</artifactId>
  <version>2.9.1</version>
</dependency>
<dependency>
  <groupId>org.apache.logging.log4j</groupId>
  <artifactId>log4j-core</artifactId>
  <version>2.9.1</version>
</dependency>
<dependency>
  <groupId>org.apache.logging.log4j</groupId>
  <artifactId>log4j-slf4j-impl</artifactId>
  <version>2.9.1</version>
</dependency>

之后,在项目中就可以使用log4j2了,而依赖于log4j 1.x的包也能够正常地输出日志。

官方对于相关问题的说明可以在此处找到。

附:log4j 1.x 和 log4j2.x 的配置文件格式示例

因为log4j 1 和 2 的配置文件是互相不兼容的,搜索相关资料时两种版本相互混杂,分辨比较麻烦。这里给两个版本各列出一个配置文件,可以用于格式的参考和对应:

log4j 1.x 的配置文件格式:

<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration debug="false">
    <appender name="console" class="org.apache.log4j.ConsoleAppender">
        <param name="Target" value="System.out"/>
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n" />
        </layout>
    </appender>
    <root>
        <priority value ="debug"/>
        <appender-ref ref="console"/>
    </root>
</log4j:configuration>

log4j 2.x 的配置文件格式:

<Configuration status="WARN" monitorInterval="300">
    <Appenders>
          <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
          </Console>
          <File name="MyFile" fileName="D:/logs/app.log">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
          </File>
    </Appenders>
    <Loggers>
          <Logger name="mylog" level="trace" additivity="true">
            <AppenderRef ref="MyFile" />
          </Logger>
          <Root level="error">
            <AppenderRef ref="Console" />
          </Root>
    </Loggers>
</Configuration>