Log4j无缝升级到Log4j2+Slf4j

关注

原创最新推荐文章于 2026-06-21 12:15:45 发布 6.9k 阅读 AI 写同款· GEO 优化 ›

将log4j的项目升级到log4j2 0.背景虽然大部分的java项目使用的都是logback，但是仍然有很多开源项目使用log4j，例如kafka、zookeeper。但是log4j已经于2012年停止更新，并且log4j扫出如下安全漏洞： https://rnd-vulncenter.huawei.com/vuln/toViewOfficialDetail?cveId=CVE-2020-9488 https://rnd-vulncenter.huawei.com/vuln/toViewOfficialDetail?cveId=CVE-20 阅读详情

修改记录

20190627:
1修改日志文件切分配置错误:配置的切分标签必须在内
另外:filePattern不要用变量Properties引用变量名,那样启动会检测不到里面的%d{yyyy-MM-dd}会报错.

<!-- 反例 -->
<RollingFile name="error_log" fileName="${rolling_fileName}" filePattern="${basePath}/${loggz}/hrapp-%d{yyyy-MM-dd}.log">
    <!-- 其他配置略-->       
	<TimeBasedTriggeringPolicy interval="1" modulate="true"/>
	<SizeBasedTriggeringPolicy size="20 MB"/>
 </RollingFile>

<!-- 正例 -->
<RollingFile name="error_log" fileName="${rolling_fileName}" filePattern="${basePath}/${loggz}/hrapp-%d{yyyy-MM-dd}.log">
    <!-- 其他配置略-->
    <Policies>       
		<TimeBasedTriggeringPolicy interval="1" modulate="true"/>
		<SizeBasedTriggeringPolicy size="20 MB"/>
	</Policies>
 </RollingFile>

2另外发现当windows环境下配置的不是完整日志输出文件路径导致自动切分日志规则不生效的问题
具体配置如下:
log4j2.xml配置里配置的属性

<!--不完整的路径,在tomcat所在目录的所在盘下生成路径:D:\opt\maxtech\tomcat_logs\projectname,启动tomcat会有日志文件,但是动态规则的拆分日志(按日期/大小等规则)不生效了. -->
<property name="basePath">/opt/maxtech/tomcat_logs/projectname</property>
<!--改为以下全路径(可以用变量,tomcat路径之类的变量) -->
<property name="basePath">D:\opt\maxtech\tomcat_logs\projectname</property>

Step1: 修改maven项目的pom.xml

移除原有项目log4j的依赖内容模块
加入以下内容,属性部分加入

 <properties>
         <!--设置Log4j2 跟 slfj0-->
         <log4j.version>2.11.2</log4j.version>
         <slf4j.version>1.7.26</slf4j.version>
    </properties>

添加log4j2和slf4j的依赖

        <!--slf4j的依赖-->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>${slf4j.version}</version>
        </dependency>
        <!--log4j2 的依赖-->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-api</artifactId>
            <version>${log4j.version}</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <version>${log4j.version}</version>
        </dependency>
        <!--用于与sfl4j保持桥接-->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-slf4j-impl</artifactId>
            <version>${log4j.version}</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-web</artifactId>
            <version>${log4j.version}</version>
            <scope>runtime</scope>
        </dependency>
        <!--  用来无缝切换Log4j到log4j2的中间层 注意版本号要跟用的log4j2的版本号一致 -->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-1.2-api</artifactId>
            <version>${log4j.version}</version>
        </dependency>

Step2:删除原有Log4j的配置

	<!-- 加载LOG4J -->
<!--	<context-param>-->
<!--		<param-name>log4jConfigLocation</param-name>-->
<!--		<param-value>/WEB-INF/log4j.xml</param-value>-->
<!--	</context-param>-->

Step3:添加Log4j2配置文件

本次示例使用的xml配置文件名为log4j2.xml,Log4j2新版情况是不用配置文件的位置的,默认会自动扫描文件名是log4j2的配置文件(格式可能是xml.yml等)

<?xml version="1.0" encoding="UTF-8"?>
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration后面的status,这个用于设置log4j2自身内部的信息输出,可以不设置,当设置成trace时,你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身,设置间隔秒数-->
<configuration status="off" monitorInterval="60">
    <Properties>
        <!-- 日志默认存放的位置,这里设置为项目根路径下,也可指定绝对路径 -->
        <!-- ${web:rootDir}是web项目根路径,java项目没有这个变量,需要删掉,否则会报异常 ;${sys:catalina.home}默认是tomcat的根目录,根据需要调整,可以设置项目服务器绝对路径-->
        <property name="basePath">${sys:catalina.home}/WebAppLogs/你希望文件夹名(可以是项目名+log)</property>
        <property name="loggz">loggz</property>
        
        <!-- <property name="basePath">d:/qfxSpringMVCMybaitsDemoLogs</property> -->

        <!-- 控制台默认输出格式,"%-5level":日志级别,"%l":输出完整的错误位置,是小写的L,因为有行号显示,所以影响日志输出的性能 -->
        <property name="console_log_pattern">%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] %l - %m%n</property>
        <!-- 日志文件默认输出格式,不带行号输出(行号显示会影响日志输出性能);%C:大写,类名;%M:方法名;%m:错误信息;%n:换行 -->
        <property name="log_pattern">%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] %C.%M - %m%n</property>

        <!-- 日志默认切割的最小单位 -->
        <property name="every_file_size">20MB</property>
        <!-- 日志默认输出级别 -->
        <property name="output_log_level">INFO</property>

        <!-- 日志默认存放路径(所有级别日志) -->
        <!--<property name="rolling_fileName">${basePath}/all.log</property>-->
        <!--&lt;!&ndash; 日志默认压缩路径,将超过指定文件大小的日志,自动存入按"年月"建立的文件夹下面并进行压缩,作为存档 &ndash;&gt;-->
        <property name="rolling_filePattern">${basePath}/${loggz}/all-${date:yyyy-MM-dd}-%i.log.gz</property>
        <!--&lt;!&ndash; 日志默认同类型日志,同一文件夹下可以存放的数量,不设置此属性则默认为7个 &ndash;&gt;-->
        <property name="rolling_max">50</property>

        <!-- Info日志默认存放路径(Info级别日志) -->
        <property name="info_fileName">${basePath}/info-${date:yyyy-MM-dd}.log</property>
        <!-- Info日志默认压缩路径,将超过指定文件大小的日志,自动存入按"年月"建立的文件夹下面并进行压缩,作为存档 -->
        <property name="info_filePattern">${basePath}/${loggz}/info-${date:yyyy-MM-dd}-%i.log.gz</property>
        <!-- Info日志默认同一文件夹下可以存放的数量,不设置此属性则默认为7个 -->
        <property name="info_max">30</property>

        <!-- Warn日志默认存放路径(Warn级别日志) -->
        <property name="warn_fileName">${basePath}/warn-${date:yyyy-MM-dd}.log</property>
        <!-- Warn日志默认压缩路径,将超过指定文件大小的日志,自动存入按"年月"建立的文件夹下面并进行压缩,作为存档 -->
        <property name="warn_filePattern">${basePath}/${loggz}/warn-${date:yyyy-MM-dd}-%i.log.gz</property>
        <!-- Warn日志默认同一文件夹下可以存放的数量,不设置此属性则默认为7个 -->
        <property name="warn_max">30</property>

        <!-- Error日志默认存放路径(Error级别日志) -->
        <property name="error_fileName">${basePath}/error-${date:yyyy-MM-dd}.log</property>
        <!-- Error日志默认压缩路径,将超过指定文件大小的日志,自动存入按"年月"建立的文件夹下面并进行压缩,作为存档 -->
        <property name="error_filePattern">${basePath}/${loggz}/error-${date:yyyy-MM-dd}-%i.log.gz</property>
        <!-- Error日志默认同一文件夹下可以存放的数量,不设置此属性则默认为7个 -->
        <property name="error_max">30</property>

        <!-- 控制台显示的日志最低级别 -->
        <property name="console_print_level">DEBUG</property>

    </Properties>

    <!--定义appender -->
    <appenders>
        <!-- 用来定义输出到控制台的配置 -->
        <Console name="Console" target="SYSTEM_OUT">
            <!-- 设置控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->
            <ThresholdFilter level="${console_print_level}" onMatch="ACCEPT" onMismatch="DENY"/>
            <!-- 设置输出格式,不设置默认为:%m%n -->
            <PatternLayout pattern="${console_log_pattern}"/>
        </Console>

        <!--&lt;!&ndash; 打印root中指定的level级别以上的日志到文件 &ndash;&gt;-->
        <!--<RollingFile name="RollingFile" fileName="${rolling_fileName}" filePattern="${rolling_filePattern}">-->
            <!--<PatternLayout pattern="${log_pattern}"/>-->
            <!--<SizeBasedTriggeringPolicy size="${every_file_size}"/>-->
            <!--&lt;!&ndash; 设置同类型日志,同一文件夹下可以存放的数量,如果不设置此属性则默认存放7个文件 &ndash;&gt;-->
            <!--<DefaultRolloverStrategy max="${rolling_max}" />-->
            <!--&lt;!&ndash; 匹配INFO以及以上级别 &ndash;&gt;-->
            <!--<Filters>-->
                <!--<ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>-->
            <!--</Filters>-->
        <!--</RollingFile>-->

        <!-- 打印INFO级别的日志到文件 -->
        <RollingFile name="InfoFile" fileName="${info_fileName}" filePattern="${info_filePattern}">
        <!--设置输出日志的编码格式,根据需求自行调整.-->
            <PatternLayout charset="UTF-8"  pattern="${log_pattern}"/>
            <Policies>
            	<SizeBasedTriggeringPolicy size="${every_file_size}"/>
                <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
            </Policies>
            <DefaultRolloverStrategy max="${info_max}" />
            <!-- 匹配INFO级别 -->
            <Filters>
                <ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL"/>
                <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
            </Filters>
        </RollingFile>

        <!-- 打印WARN级别的日志到文件 -->
        <RollingFile name="WarnFile" fileName="${warn_fileName}" filePattern="${warn_filePattern}">
            <PatternLayout charset="UTF-8"  pattern="${log_pattern}"/>
            <Policies>       
				<TimeBasedTriggeringPolicy interval="1" modulate="true"/>
				<SizeBasedTriggeringPolicy size="20 MB"/>
			</Policies>
            <DefaultRolloverStrategy max="${warn_max}" />
            <!-- 匹配WARN级别 -->
            <Filters>
                <ThresholdFilter level="ERROR" onMatch="DENY" onMismatch="NEUTRAL"/>
                <ThresholdFilter level="WARN" onMatch="ACCEPT" onMismatch="DENY"/>
            </Filters>
        </RollingFile>

        <!-- 打印ERROR级别的日志到文件 -->
        <RollingFile name="ErrorFile" fileName="${error_fileName}" filePattern="${error_filePattern}">
            <PatternLayout charset="UTF-8"  pattern="${log_pattern}"/>
            <Policies>       
				<TimeBasedTriggeringPolicy interval="1" modulate="true"/>
				<SizeBasedTriggeringPolicy size="20 MB"/>
			</Policies>
            <DefaultRolloverStrategy max="${error_max}" />
            <!-- 匹配ERROR级别 -->
            <Filters>
                <ThresholdFilter level="FATAL" onMatch="DENY" onMismatch="NEUTRAL"/>
                <ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY"/>
            </Filters>
        </RollingFile>
    </appenders>

    <!--然后定义logger,只有定义了logger并引入的appender,appender才会生效-->
    <loggers>
        <!-- 设置对打印sql语句的支持 -->
        <logger name="java.sql" level="debug" additivity="false">
            <appender-ref ref="Console"/>
        </logger>


        <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
        <logger name="org.springframework" level="info"></logger>
        <logger name="org.mybatis" level="info"></logger>

        <!-- 第三方日志系统 -->

        <logger name="org.springframework.core" level="info" additivity="true">
        </logger>
        <logger name="org.springframework.beans" level="info">
        </logger>
        <logger name="org.springframework.context" level="info">
        </logger>
        <logger name="org.springframework.web" level="info">
        </logger>

        <!--建立一个默认的root的logger-->
        <root level="${output_log_level}">
            <!--<appender-ref ref="RollingFile"/>-->
            <appender-ref ref="Console"/>
            <appender-ref ref="InfoFile" />
            <appender-ref ref="WarnFile" />
            <appender-ref ref="ErrorFile"/>
        </root>
    </loggers>
</configuration>

标签解释:
TimeBasedTriggeringPolicy
关键点在于 filePattern后的日期格式，以及TimeBasedTriggeringPolicy的interval，日期格式精确到哪一位，interval也精确到哪一个单位,也就是日志切分的步长,比如如果filePattern最后精确单位是HH,interval=“4”,则间隔4个小时切分日志文件. -
modulateboolean型，说明是否对封存时间进行修正。若modulate=true(默认值)，则封存时间将以0点为边界进行偏移计算。比如，modulate=true，interval=4hours，那么假设上次封存日志的时间为03:00，则下次封存日志的时间为04:00，之后的封存时间依次为08:00，12:00，16:00，。。。