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

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

心靈之曲

发布： 2025-08-20 17:54:04

原创

1007人浏览过

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 1.x 迁移到 Log4j 2.x 时，除了代码层面的修改，XML 配置文件也需要进行相应的调整。常见的错误之一是 "The prefix "log4j" for element "log4j:configuration" is not bound"，这表明 Log4j 2.x 无法正确解析 Log4j 1.x 的配置文件格式。这是因为 Log4j 2.x 使用了不同的 XML 命名空间和配置结构。

XML 配置文件的修改

Log4j 2.x 使用 <Configuration> 作为根元素，并使用不同的元素和属性来定义 appenders、loggers 等。为了解决上述错误，需要将 Log4j 1.x 的配置文件转换为 Log4j 2.x 的格式。

以下是一个 Log4j 1.x 的配置文件示例：

<?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 配置文件应如下所示：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN" monitorInterval="30">
    <Appenders>
        <Console name="ConsoleAppender" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{MM/dd HH:mm:ss} %-5p %30.30c %x - %m%n"/>
        </Console>
    </Appenders>
    <Loggers>
        <Root level="error">
            <AppenderRef ref="ConsoleAppender"/>
        </Root>
    </Loggers>
</Configuration>

登录后复制

关键修改点：

根元素： 将 <log4j:configuration> 替换为 <Configuration>。注意 Configuration 标签可以添加 status 和 monitorInterval 属性，分别用于设置 Log4j 内部状态的日志级别和自动重新配置的时间间隔。
Appenders： 将 <appender> 元素移动到 <Appenders> 元素内，class 属性修改为 name 属性。
Layout： org.apache.log4j.PatternLayout 修改为 <PatternLayout>，<param> 标签修改为 <PatternLayout> 标签的属性。
Loggers: 将 <root> 和 <category> 元素移动到 <Loggers> 元素内，<category> 标签修改为 <Logger> 标签，<priority> 标签修改为 <Logger> 标签的 level 属性。
AppenderRef: <appender-ref> 标签保持不变，但是需要确保 ref 属性的值与 <Appenders> 中定义的 name 属性一致。

完整的迁移示例

以下是一个更完整的 Log4j 1.x 配置文件及其对应的 Log4j 2.x 配置文件。

X Studio

网易云音乐·X Studio

查看详情

Log4j 1.x (/home/user/TEST_log4j.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>
  <appender name="Fileappender" class="org.apache.log4j.RollingFileAppender">
        <param name="file" value="/opt/tomcat/logs/MyCustomClassLogs.log"/>
        <param name="MaxFileSize" value="5MB"/>
        <param name="MaxBackupIndex" value="5"/>
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%d{MM/dd HH:mm:ss} %-5p %30.30c %x - %m\n"/>
        </layout>
  </appender>
  <appender name="ResetClass" class="org.apache.log4j.RollingFileAppender">
            <param name="file" value="/opt/tomcat/logs/resetTrace.log"/>
            <param name="MaxFileSize" value="1MB"/>
            <param name="MaxBackupIndex" value="5"/>
            <layout class="org.apache.log4j.PatternLayout">
                <param name="ConversionPattern" value="%d{MM/dd HH:mm:ss} %-5p %30.30c %x - %m\n"/>
            </layout>
  </appender>
  <category name="com.demo.custom.filter.ResetClass" additivity="false">
        <priority value="TRACE"/>
        <appender-ref ref="ResetClass"/>
  </category>
  <category name="com.demo.custom.test.MyCustomClass" additivity="false">
        <priority value="TRACE"/>
        <appender-ref ref="Fileappender"/>
  </category>
  <root>
    <level value="error" />
    <appender-ref ref="ConsoleAppender"/>
  </root>
</log4j:configuration>

登录后复制

Log4j 2.x (/home/user/TEST_log4j.xml):

<Configuration status="WARN" monitorInterval="30">
    <Appenders>
        <Console name="ConsoleAppender" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{MM/dd HH:mm:ss} %-5p %30.30c %x - %m%n"/>
        </Console>
        <RollingFile name="Fileappender" fileName="/opt/tomcat/logs/MyCustomClassLogs.log"
                     filePattern="/opt/tomcat/logs/MyCustomClassLogs.log-%i.log">
            <PatternLayout>
                <pattern>%d{MM/dd HH:mm:ss} %-5p %30.30c %x - %m%n</pattern>
            </PatternLayout>
            <Policies>
                <SizeBasedTriggeringPolicy size="5MB"/>
            </Policies>
            <DefaultRolloverStrategy max="5"/>
        </RollingFile>
        <RollingFile name="ResetClass" fileName="/opt/tomcat/logs/resetTrace.log"
                     filePattern="/opt/tomcat/logs/resetTrace.log-%i.log">
            <PatternLayout>
                <pattern>%d{MM/dd HH:mm:ss} %-5p %30.30c %x - %m%n</pattern>
            </PatternLayout>
            <Policies>
                <SizeBasedTriggeringPolicy size="1MB"/>
            </Policies>
            <DefaultRolloverStrategy max="5"/>
        </RollingFile>
    </Appenders>
    <Loggers>
        <Logger name="com.demo.custom.filter.ResetClass" level="TRACE" additivity="false">
            <AppenderRef ref="ResetClass"/>
        </Logger>
        <Logger name="com.demo.custom.test.MyCustomClass" level="TRACE" additivity="false">
            <AppenderRef ref="Fileappender"/>
        </Logger>
        <Root level="error">
            <AppenderRef ref="ConsoleAppender"/>
        </Root>
    </Loggers>
</Configuration>

登录后复制

代码层面的修改：

除了 XML 配置文件，还需要修改代码中的 Log4j 引用。例如：

import org.apache.log4j.Logger; // Log4j 1.x
import org.apache.log4j.xml.DOMConfigurator; // Log4j 1.x

import org.apache.logging.log4j.Logger; // Log4j 2.x
import org.apache.logging.log4j.LogManager; // Log4j 2.x
import org.apache.logging.log4j.core.config.Configurator; // Log4j 2.x

// ...

// Log4j 1.x
// private static Logger myLogger = Logger.getLogger(MyCustomClass.class);
// DOMConfigurator.configure("/home/user/TEST_log4j.xml");

// Log4j 2.x
private static Logger myLogger = LogManager.getLogger(MyCustomClass.class);
// Configurator.initialize(null, "/home/user/TEST_log4j.xml"); // 使用 XML 配置文件时，通常不需要手动初始化

登录后复制

注意事项：

确保 Log4j 2.x 的依赖已正确添加到项目中。
仔细检查 XML 配置文件中的所有元素和属性，确保它们符合 Log4j 2.x 的规范。
Log4j 2.x 的配置文件可以采用 XML、JSON 或 YAML 格式。
filePattern 属性用于定义滚动日志的文件名模式，需要根据实际需求进行调整。
additivity="false" 属性用于阻止日志消息传递到父 logger。

总结：

将 Log4j 1.x 迁移到 Log4j 2.x 需要修改代码和 XML 配置文件。通过本文档的指导，你应该能够解决 "The prefix "log4j" for element "log4j:configuration" is not bound" 错误，并成功完成迁移。记住，仔细阅读 Log4j 2.x 的官方文档是解决迁移过程中遇到的问题的关键。

以上就是Log4j 1.x 迁移至 Log4j 2.x：解决 XML 配置解析错误的详细内容，更多请关注php中文网其它相关文章！

大家都在看：

安装 Apache Maven Apache Tomcat的简要介绍和其功能探索Apache Tomcat的功能和特性了解Apache和Tomcat：它们在网页服务器中的职责是什么？如何根据需求选择适合的服务器：比较Apache和Tomcat的区别