Log4j 1.x 迁移到 Log4j 2.x：解决XML配置解析错误-java教程-PHP中文网

Log4j 1.x 迁移到 Log4j 2.x：解决XML配置解析错误

霞舞

发布： 2025-08-20 17:28:02

原创

660人浏览过

log4j 1.x 迁移到 log4j 2.x：解决xml配置解析错误

本文档旨在帮助开发者将项目从 Log4j 1.x 迁移到 Log4j 2.x，重点解决在迁移过程中可能出现的 XML 配置解析错误，例如 "The prefix "log4j" for element "log4j:configuration" is not bound"。文章将详细介绍如何修改 XML 配置文件，使其符合 Log4j 2.x 的规范，并提供相应的代码示例，确保平滑过渡。

Log4j 2.x 带来了许多改进，包括性能提升、更灵活的配置选项以及更好的插件支持。然而，从 Log4j 1.x 迁移到 2.x 需要修改代码和配置文件，其中 XML 配置文件的更改尤为重要。

XML 配置文件的修改

Log4j 2.x 使用不同的 XML 配置文件格式。最常见的错误之一是尝试使用 Log4j 1.x 的 XML 格式，这会导致解析错误，例如 "The prefix "log4j" for element "log4j:configuration" is not bound"。

以下是 Log4j 1.x 的 XML 配置示例：

<?xml version="1.0" encoding="UTF-8" ?>
<log4j:configuration>
  <appender name="ConsoleAppender" class="org.apache.log4j.ConsoleAppender">
    <layout class="org.apache.log4j.PatternLayout">
      <param name="ConversionPattern" value="%d{MM/dd HH:mm:ss} %-5p %30.30c %x - %m\n"/>
    </layout>
  </appender>
  <root>
    <level value="error" />
    <appender-ref ref="ConsoleAppender"/>
  </root>
</log4j:configuration>

登录后复制

要将其转换为 Log4j 2.x 兼容的格式，需要进行以下更改：

根元素： 将 <log4j:configuration> 替换为 <Configuration>. log4j: 前缀不再使用。
Appender 定义： 将 <appender> 元素替换为 <Appenders> 元素下的具体 Appender 类型，例如 <Console> 或 <RollingFile>。 class 属性被移除，并使用特定的元素和属性来配置 Appender。
Layout 定义： <layout> 元素被 <PatternLayout> 元素替换。
Root Logger 和 Logger 定义： <root> 和 <category> 元素被 <Loggers> 元素下的 <Root> 和 <Logger> 元素替换。
参数配置： <param> 元素被替换为直接的属性设置。

以下是 Log4j 2.x 的等效 XML 配置示例：

<Configuration status="WARN">
    <Appenders>
        <Console name="STDOUT" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{MM/dd HH:mm:ss} %-5p %30.30c %x - %m%n"/>
        </Console>
        <RollingFile name="RollingFile" fileName="/opt/tomcat/logs/MyCustomClassLogs.log" filePattern="/opt/tomcat/logs/MyCustomClassLogs.log-%i">
            <PatternLayout>
                <pattern>%d{MM/dd HH:mm:ss} %-5p %30.30c %x - %m%n</pattern>
            </PatternLayout>
            <Policies>
                <SizeBasedTriggeringPolicy size="5 MB" />
            </Policies>
            <DefaultRolloverStrategy max="5"/>
        </RollingFile>
    </Appenders>
    <Loggers>
        <Root level="error">
            <AppenderRef ref="STDOUT"/>
        </Root>
    </Loggers>
</Configuration>

登录后复制

关键更改说明：

<Configuration status="WARN">: 这是根元素，status 属性用于控制 Log4j 2.x 内部的日志级别。
<Appenders>: 包含所有 Appender 的定义。
<Console name="STDOUT" target="SYSTEM_OUT">: 定义了一个名为 "STDOUT" 的 Console Appender，并将输出定向到标准输出。
<PatternLayout pattern="%d{MM/dd HH:mm:ss} %-5p %30.30c %x - %m%n"/>: 定义了日志消息的格式。 %n 用于换行，替代了 Log4j 1.x 中的 \n。
<RollingFile>: 定义了一个 RollingFile Appender，用于将日志写入文件，并根据大小进行滚动。
<Policies> 和 <SizeBasedTriggeringPolicy>: 定义了滚动策略，例如基于文件大小。
<DefaultRolloverStrategy>: 定义了滚动文件的最大数量。
<Loggers>: 包含所有 Logger 的定义。
<Root level="error">: 定义了根 Logger，并将日志级别设置为 "error"。
<AppenderRef ref="STDOUT"/>: 将根 Logger 关联到 "STDOUT" Appender。

代码修改

除了 XML 配置文件之外，还需要修改 Java 代码以使用 Log4j 2.x API。

导入： 替换 Log4j 1.x 的导入语句：

import org.apache.log4j.Logger;
import org.apache.log4j.xml.DOMConfigurator;

登录后复制

为 Log4j 2.x 的导入语句：

import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.core.config.Configurator;

登录后复制

获取 Logger 实例： 替换 Log4j 1.x 的 Logger 获取方式：

X Studio
网易云音乐·X Studio

91

查看详情
```
private static Logger myLogger = Logger.getLogger(MyCustomClass.class);
```
登录后复制
为 Log4j 2.x 的 Logger 获取方式：
```
private static Logger myLogger = LogManager.getLogger(MyCustomClass.class);
```
登录后复制
配置 Log4j： 在 Log4j 2.x 中，通常不需要显式配置。如果需要手动配置，请替换 Log4j 1.x 的配置方式：
```
DOMConfigurator.configure("/home/user/TEST_log4j.xml");
```
登录后复制
为 Log4j 2.x 的配置方式（通常不需要，除非需要指定配置文件的位置）：
```
Configurator.initialize(null, "/home/user/TEST_log4j.xml");
```
登录后复制
注意： 在大多数情况下，Log4j 2.x 会自动检测 classpath 中的 log4j2.xml 或 log4j2.properties 文件，因此不需要手动配置。

注意事项和总结

XML 验证： 使用 XML 验证工具来验证 Log4j 2.x 的 XML 配置文件，以确保其格式正确。

依赖管理： 确保项目中包含了 Log4j 2.x 的依赖项。如果使用 Maven，可以在 pom.xml 文件中添加以下依赖项：

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-api</artifactId>
    <version>2.17.1</version>
</dependency>
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>2.17.1</version>
</dependency>

登录后复制