log4j平滑升级为log4j2(不需改动源码)

川长思鸟来 2022-06-12 03:22 298阅读 0赞

公司的项目决定升级log4j,因为log4j2有一个自动删除日志的功能，这样可以减轻运维的一些工作，而且在多线程环境下，log4j2的异步日志系统比log4j和logback提高了十倍的性能（吞吐量和延迟率），官方原文如下： Log4j 2 contains next-generation Asynchronous Loggers based on the LMAX Disruptor library. In multi-threaded scenarios Asynchronous Loggers have 10 times higher throughput and orders of magnitude lower latency than Log4j 1.x and Logback.  因为是升级，原项目用的是log4j或者slf4j打印日志，获取logger的方式不同。

比如log4j：

import org.apache.log4j.Logger;  
方法：private static final Logger LOGGER = Logger.getLogger(xxxx.class);

比如slf4j：

import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  
方法：private static final Logger logger = LoggerFactory.getLogger(xxxx.class);

而如果用log4j2的话，API将有所不同：

import org.apache.logging.log4j.LogManager;  
import org.apache.logging.log4j.Logger;

方法：private static final Logger logger = LogManager.getLogger(xxxx.class);

如果在升级的过程中，我们要去改代码的话，那将是一项很大的繁琐工程，log4j2[架构][Link 1]已经考虑到这一点，给我们提供了转换的包，我们只需要导入几个转换包就可以使用log4j2，而且还不需要修改代码。

官方原文：

Perhaps the simplest way to convert to using Log4j 2 is to replace the log4j 1.x jar file with Log4j 2's log4j-1.2-api.jar. However, to use this successfully applications must meet the following requirements:

1.  They must not access methods and classes internal to the Log4j 1.x implementation such as Appenders, LoggerRepository or Category's callAppendersmethod.
2.  They must not programmatically configure Log4j.
3.  They must not configure by calling the classes DOMConfigurator or PropertyConfigurator

第一步：我是maven项目，就以maven项目为例子，进行讲解了。

删掉pom.xml文件中关于log4j的依赖，添加新依赖

**\[html\]**  [view plain][]   [copy][view plain]

1.   **<****dependency****>**  
2.      **<****groupId****>**org.apache.logging.log4j**</****groupId****>**  
3.      **<****artifactId****>**log4j-api**</****artifactId****>**  
4.      **<****version****>**2.7**</****version****>**  
5.        
6.  **</****dependency****>**  
7.  **<****dependency****>**  
8.      **<****groupId****>**org.apache.logging.log4j**</****groupId****>**  
9.      **<****artifactId****>**log4j-1.2-api**</****artifactId****>**  
10.     **<****version****>**2.7**</****version****>**  
11. **</****dependency****>**  
12. **<****dependency****>**  
13.     **<****groupId****>**org.apache.logging.log4j**</****groupId****>**  
14.     **<****artifactId****>**log4j-core**</****artifactId****>**  
15.     **<****version****>**2.7**</****version****>**  
16.       
17. **</****dependency****>**  
18. **<****dependency****>**  
19.     **<****groupId****>**org.apache.logging.log4j**</****groupId****>**  
20.     **<****artifactId****>**log4j-web**</****artifactId****>**  
21.     **<****version****>**2.7**</****version****>**  
22.     **<****scope****>**runtime**</****scope****>**  
23. **</****dependency****>**

PS：log4j-1.2-api为log4j和log4j2的连接包。

第二步：删掉以前的log4j.properties,改为log4j2.xml，这里起名字的时候，不要写错了

**\[html\]**  [view plain][]   [copy][view plain]

1.  **<?****xml** version="1.0" encoding="UTF-8"**?>**  
2.  **<****configuration** status="info"**>**  
3.      **<****Properties****>**  
4.          **<****Property** name="LOG\_HOME"**>**$\{sys:catalina.base\}/var/logs**</****Property****>**  
5.          **<****Property** name="APP\_LOG\_HOME"**>**$\{LOG\_HOME\}/uas**</****Property****>**  
6.      **</****Properties****>**  
7.    
8.      **<****Appenders****>**  
9.          **<****Console** name="Console" target="SYSTEM\_OUT"**>**  
10.               
11.               
14.             **<****PatternLayout**  
15.                 pattern="%d\{yyyy-MM-dd HH:mm:ss.SSS\} %-5level %class\{36\} %L %M - %msg%xEx%n" **/>**  
16.         **</****Console****>**  
17.         **<****RollingRandomAccessFile** name="uas\_appender"  
18.             immediateFlush="true" fileName="$\{APP\_LOG\_HOME\}/uas.log"  
19.             filePattern="$\{APP\_LOG\_HOME\}/uas.log.%d\{yyyy-MM-dd\}.gz"**>**  
20.               
32.               
33.             **<****DefaultRolloverStrategy****>**  
34.                 **<****Delete** basePath="$\{APP\_LOG\_HOME\}" maxDepth="1"**>**  
35.                     **<****IfFileName** glob="uas.log.\*.gz" **/>**  
36.                     **<****IfLastModified** age="30d" **/>**  
37.                 **</****Delete****>**  
38.             **</****DefaultRolloverStrategy****>**  
39.         **</****RollingRandomAccessFile****>**  
40.     **</****Appenders****>**  
41.   
42.     **<****Loggers****>**  
43.         **<****logger** name="org.spring" level="error" additivity="false"**>**  
44.             **<****AppenderRef** ref="Console" **/>**  
45.             **<****AppenderRef** ref="uas\_appender" **/>**  
46.         **</****logger****>**  
47.         **<****logger** name="org.springframework" level="error" additivity="false"**>**  
48.             **<****AppenderRef** ref="Console" **/>**  
49.             **<****AppenderRef** ref="uas\_appender" **/>**  
50.         **</****logger****>**  
51.         **<****logger** name="org.apache.zookeeper" level="error" additivity="false"**>**  
52.             **<****AppenderRef** ref="Console" **/>**  
53.             **<****AppenderRef** ref="uas\_appender" **/>**  
54.         **</****logger****>**  
55.         **<****logger** name="com.alibaba.dubbo" level="error" additivity="false"**>**  
56.             **<****AppenderRef** ref="Console" **/>**  
57.             **<****AppenderRef** ref="uas\_appender" **/>**  
58.         **</****logger****>**  
59.         **<****logger** name="xx.xx.xx" level="info" additivity="false"**>**  
60.             **<****AppenderRef** ref="Console" **/>**  
61.             **<****appender-ref** ref="uas\_appender" **/>**  
62.         **</****logger****>**  
63.         **<****root** level="info"**>**  
64.             **<****appender-ref** ref="Console" **/>**  
65.             **<****appender-ref** ref="uas\_appender" **/>**  
66.         **</****root****>**  
67.     **</****Loggers****>**  
68.   
69. **</****configuration****>**

这里需要注意的有以下几点：

1.log4j2.\*版本中获取home路径是$\{sys:catalina.base\}  
2.要在<root>标签中添加<appender-ref ref="Console"/>,<appender-ref ref="log"/>才能在控制台、和文件中打印日志

第三步：在web.xml中配置，注释掉以前关于加载log4j的配置，重新配置，这里我的log4j2.xml放在classpath/conf下

**\[html\]**  [view plain][]   [copy][view plain]

1.  **<****context-param****>**  
2.          **<****param-name****>**log4jConfiguration**</****param-name****>**  
3.          **<****param-value****>**classpath:conf/log4j2.xml**</****param-value****>**  
4.  **</****context-param****>**

配置放在web.xml的<display-name/>下方， 如此log4j升级log4j2升级成功。

扩展：如果原项目中用的是slf4j打印日志，那么导包的时候需要导入：

**\[html\]**  [view plain][]   [copy][view plain]

1.  **<****dependency****>**  
2.      **<****groupId****>**org.slf4j**</****groupId****>**  
3.      **<****artifactId****>**slf4j-api**</****artifactId****>**  
4.      **<****version****>**$\{slf4j.version\}**</****version****>**  
5.  **</****dependency****>**  
6.  **<****dependency****>**  
7.      **<****groupId****>**org.slf4j**</****groupId****>**  
8.      **<****artifactId****>**slf4j-log4j12**</****artifactId****>**  
9.      **<****version****>**$\{slf4j.version\}**</****version****>**  
10. **</****dependency****>**

也是不需要修改代码，关于slf4j继承log4j2的详细解决方案，可参考： [http://blog.csdn.net/zouxucong/article/details/56005725][http_blog.csdn.net_zouxucong_article_details_56005725]

[Link 1]: http://lib.csdn.net/base/architecture
[view plain]: http://blog.csdn.net/zouxucong/article/details/56013053?utm_source=itdadao&utm_medium=referral#
[http_blog.csdn.net_zouxucong_article_details_56005725]: http://blog.csdn.net/zouxucong/article/details/56005725

发表评论取消回复

表情：

评论列表（有 0 条评论，298人围观）

还没有评论，来说两句吧...

相关阅读

相关 log4j2模板，log4j模板，log4j相关属性

文章目录 1. log4j2模板 1.1 \`pom.xml\`依赖 1.2 \`log4j2.xml\`配置文件

r囧r小猫/ 2022年12月15日 11:26/ 0 赞/ 188 阅读

相关将log4j的项目升级到log4j2

0.背景虽然大部分的java项目使用的都是logback，但是仍然有很多开源项目使用log4j，例如kafka、zookeeper。但是log4j已经于2012年停止更

小鱼儿/ 2022年12月15日 06:14/ 0 赞/ 545 阅读

相关 [Log4j] 配置Log4j

Log4J的配置文件(Configuration File)就是用来设置记录器的级别、存放器和布局的，它可接key=value格式的设置或xml格式的设置信息。通过配置，可以创

旧城等待，/ 2022年08月14日 01:43/ 0 赞/ 229 阅读

相关 [Log4j] 配置Log4j

Log4J的配置文件(Configuration File)就是用来设置记录器的级别、存放器和布局的，它可接key=value格式的设置或xml格式的设置信息。通过配置，可以创

小咪咪/ 2022年08月10日 11:55/ 0 赞/ 279 阅读

相关 log4j平滑升级为log4j2(不需改动源码)

公司的项目决定升级log4j,因为log4j2有一个自动删除日志的功能，这样可以减轻运维的一些工作，而且在多线程环境下，log4j2的异步日志系统比log4j和

川长思鸟来/ 2022年06月12日 03:22/ 0 赞/ 299 阅读

相关 log4j与log4j2区别

log4j的配置文件是log4j.properties，是以.properties后缀名结尾的文件命名，而log4j2的配置文件一般是xml文件或json，以.xml或.jso

客官°小女子只卖身不卖艺/ 2022年05月24日 05:06/ 0 赞/ 238 阅读

相关深入Log4J源码之Log4J Core

毕业又赶上本科的同学会，还去骑车环了趟崇明岛，六月貌似就没消停过，不过终于这些事情基本上都结束了，我也可以好好的看些书、读些源码、写点博客了。 Log4J将写日志功

快来打我*/ 2021年09月26日 07:14/ 0 赞/ 268 阅读

相关 log4j升级为log4j2(不需要改动代码)

[http://blog.csdn.net/zouxucong/article/details/56013053][http_blog.csdn.net_zouxucong_a

Myth丶恋晨/ 2021年09月12日 08:56/ 0 赞/ 1061 阅读

相关 log4j1 如何平滑升级到log4j2呢

如题，log4j1 如何平滑升级到log4j2呢？原来使用Logger.getLogger方法获取到org.apache.log4j.Logger对象的，现在LogMan

曾经终败给现在/ 2021年06月24日 15:56/ 0 赞/ 632 阅读

相关 log4j2 升级问题（包含log4j与slf4j版本）

所需版本及jar： <table style="border-collapse:collapse; margin:0px; overflow-x:auto;

ゞ浴缸里的玫瑰/ 2021年06月24日 15:56/ 0 赞/ 1272 阅读