Log4j 1到Log4j 2迁移后仍旧寻找log4j.xml的排查与解决

本文旨在解决从log4j 1迁移至log4j 2后，尽管已更新所有依赖和配置文件，应用启动时仍出现log4j 1配置错误的问题。核心内容是揭示并移除`web.xml`中遗留的log4j 1相关配置，如`log4jconfiglistener`及其上下文参数，这些配置是导致系统仍尝试加载旧版log4j配置文件的根本原因。文章将提供详细的排查步骤和解决方案，并给出迁移过程中的通用注意事项。

Log4j 1到Log4j 2迁移中遗留配置的排查与解决

在JavaEE项目中，将日志框架从Log4j 1.x升级到Log4j 2.x是一项常见的任务，旨在利用Log4j 2的性能提升和新特性。然而，即使仔细地更新了Maven/Gradle依赖、将log4j.xml转换为log4j2.xml并添加了必要的依赖排除项，项目在启动时仍可能意外地报告Log4j 1相关的配置错误，例如“log4j:WARN L'élément racine de document "Configuration" doit correspondre à la racine DOCTYPE "null".”或“log4j:ERROR DOM element is - not a <log4j:configuration> element.”。这通常意味着应用程序的某个部分仍在尝试加载Log4j 1的配置文件，导致旧版解析器被激活。

问题根源分析

当Log4j 1的配置错误在Log4j 2迁移后依然出现时，最常见的误区是认为所有Log4j 1的痕迹都已从项目代码和依赖中清除。然而，问题往往隐藏在项目的基础配置，尤其是Web应用程序的部署描述符web.xml中。许多JavaEE项目，特别是那些使用Spring框架的项目，会通过web.xml来集成Log4j 1的初始化逻辑。

具体来说，web.xml中可能包含以下与Log4j 1相关的配置：

1. log4jConfigLocation 上下文参数： 指定Log4j 1配置文件的位置，通常指向classpath:log4j.xml。
2. log4jExposeWebAppRoot 上下文参数： 用于控制Log4j 1是否将Web应用根目录暴露为系统属性。
3. org.springframework.web.util.Log4jConfigListener 监听器： 这是Spring框架为Log4j 1提供的集成监听器，它负责在Web应用启动时初始化Log4j 1。

即使项目不再包含Log4j 1的JAR包，这些web.xml中的配置项仍然会指示Web容器（如Tomcat）或Spring框架去寻找并尝试加载Log4j 1的配置文件。由于找不到Log4j 1的解析器或配置文件格式不匹配，就会抛出上述警告和错误。

解决方案：移除web.xml中的遗留配置

解决此问题的关键在于识别并移除web.xml中所有指向Log4j 1的配置。

以下是典型的Log4j 1相关web.xml配置片段，这些是需要被移除的：

<context-param>
    <param-name>log4jConfigLocation</param-name>
    <param-value>classpath:log4j.xml</param-value>
</context-param>

<context-param>
    <param-name>log4jExposeWebAppRoot</param-name>
    <param-value>false</param-value>
</context-param>

<listener>
    <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
</listener>

操作步骤：

1. 打开项目中的web.xml文件。 通常位于src/main/webapp/WEB-INF/目录下。
2. 查找并删除上述所示的<context-param>和<listener>配置块。 确保完全移除这些与Log4j 1相关的配置。
3. 保存web.xml文件。
4. 重新构建并部署应用程序。

移除这些配置后，应用程序将不再尝试通过Spring的Log4j 1集成机制初始化日志，而是会依赖Log4j 2自身的初始化机制（通常是自动查找log4j2.xml或log4j2.properties文件）。

寻光

阿里达摩院寻光视频创作平台，以视觉AIGC为核心功能，用PPT制作的方式创作视频

70

查看详情

迁移过程中的注意事项与最佳实践

为了确保Log4j 1到Log4j 2的顺利迁移，并避免类似问题，请考虑以下几点：

1. 彻底清理依赖：

   • 使用Maven的mvn dependency:tree或Gradle的./gradlew dependencies命令，仔细检查项目的运行时依赖树，确保没有Log4j 1的JAR包（如log4j:log4j）被间接引入。
   • 对于那些仍依赖Log4j 1的第三方库，务必在项目的pom.xml或build.gradle中添加明确的排除项。
   • 引入Log4j 2的桥接库（如log4j-1.2-api），以确保那些仍尝试调用Log4j 1 API的代码能够被重定向到Log4j 2。

2. 更新配置文件：

   • 将所有log4j.xml、log4j.properties等Log4j 1配置文件彻底替换为Log4j 2的配置文件（如log4j2.xml、log4j2.properties）。Log4j 2的配置语法与Log4j 1有显著差异。
   • 确保新的Log4j 2配置文件放置在classpath下，以便Log4j 2能够自动发现。

3. 检查所有配置入口：

   • 除了web.xml，还要检查Spring配置文件（如applicationContext.xml）、其他框架的配置文件（如Struts的配置）以及任何可能通过编程方式初始化Log4j 1的代码。
   • 对于Spring项目，如果之前使用了Log4jConfigListener，迁移到Log4j 2后，通常不再需要显式配置日志监听器，Log4j 2会通过其自身的机制进行初始化。如果需要更高级的集成，可以考虑使用Spring Boot的日志集成或Log4j 2自身的Spring-Cloud-Log4j2扩展。

4. 验证日志输出：

   • 迁移完成后，启动应用程序并仔细检查日志输出。确保日志信息能够正常打印，并且没有Log4j 1相关的警告或错误。
   • 测试不同的日志级别和Appender，以确认Log4j 2配置生效。

总结

从Log4j 1迁移到Log4j 2是一个涉及多方面的过程。当遇到迁移后仍出现Log4j 1配置错误时，务必将排查范围扩大到项目的部署描述符web.xml。移除其中遗留的Log4jConfigListener及其相关的上下文参数是解决此类问题的关键一步。通过彻底清理依赖、更新配置文件、检查所有配置入口以及仔细验证，可以确保Log4j 2在项目中正确且高效地运行。

以上就是Log4j 1到Log4j 2迁移后仍旧寻找log4j.xml的排查与解决的详细内容，更多请关注php中文网其它相关文章！