在公司时接到了一个需求,由于log4j存在安全漏洞,公司要求项目日志框架进行更换,从log4j升级到log4j2,本人也是第一次进行jar包升级,在此过程中也是踩了很多的坑,作为毕业大半年第一次在此写博客,记录一下我遇到的问题,希望对你有所帮助。
一、删除项目中引用的log4j jar包
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j.version}</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>${slf4j.version}</version>
</dependency>
二、引入log4j2 jar包
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
<version>2.13.0</version>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-1.2-api</artifactId>
<version>2.13.0</version>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
<version>2.13.0</version>
</dependency>
若使用了slf4j需要引入
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-slf4j-impl</artifactId>
<version>2.13.0</version>
</dependency>
三、删除log4j.properties 新建log4j2.xml
<?xml version="1.0" encoding="UTF-8" ?>
<configuration monitorInterval="5">
<appenders>
<!-- 将日志输出到控制台-->
<console name="console" target="SYSTEM_OUT">
<!-- 日志输出格式-->
<PatternLayout pattern="%d{yyyy-MM-dd hh:mm:ss}:%p %t %c %l- %mn"/>
<!-- 控制台只输出level及其以上的信息(onMatch),其他的直接拒绝(onMismatch)-->
<ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
</console>
<!--文件会打印出所有信息,这个log每次运行程序会自动清空,由append属性决定,适合临时测试用-->
<File name="Filelog" fileName="$../logs/mapi/test/test.log" append="false">
<PatternLayout pattern="../logs/mapi/test/test.log.%d{yyyyMMdd}.log"/>
</File>
示例1:
<RollingFile name="consumer" fileName="../logs/mapi/consumer/consumer.log"
filePattern="../logs/mapi/consumer/consumer.log.%d{yyyyMMdd}.log">
<PatternLayout>
<Pattern>%d{yyyy-MM-dd HH:mm:ss:SSS} %p %t %c{1} - %mn</Pattern>
</PatternLayout>
<!--控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->
<ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
<Policies>
<!--interval属性用来指定多久滚动一次,默认是1 hour filePattern最后时间单位为天则为一天-->
<TimeBasedTriggeringPolicy modulate="true" inyrtval="1"/>
</Policies>
</RollingFile>
示例2:
<!-- 这个会打印出所有的info及以下级别的信息,每次大小超过size,则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,作为存档-->
<RollingFile name="RollingFileInfo" fileName="../logs/mapi/consumer/consumer.log"
filePattern="../logs/mapi/consumer/consumer.log.%d{yyyyMMdd}_%i.log.gz">
<!--控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->
<ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout>
<Pattern>%d{yyyy-MM-dd HH:mm:ss:SSS} %p %t %c{1} - %mn</Pattern>
</PatternLayout>
<Policies>
<!--interval属性用来指定多久滚动一次,默认是1 hour-->
<TimeBasedTriggeringPolicy interval="1"/>
<SizeBasedTriggeringPolicy size="10MB"/>
</Policies>
<!-- DefaultRolloverStrategy属性如不设置,则默认为最多同一文件夹下7个文件开始覆盖-->
<!-- 1.max参数是与filePattern中的计数器%i配合起作用的,若filePattern为filePattern="../logs/mapi/consumer/consumer.log.%d{yyyyMMdd}.log">,由于没有设置%i计数器,max参数将不起作用。-->
<!-- 2.max参数不是需要保留的文件的最大个数,日志文件date/time pattern不再符合filePattern时,计算器将被重置为1,日志总个数超过了max的指定值。-->
<!-- 可认为max参数规定了一定时间范围内归档文件的最大个数,默认为7-->
<DefaultRolloverStrategy max="15"/>
</RollingFile>
</appenders>
</configuration>
四、配置参数详解
1、日志级别:如果一条日志信息的级别大于等于配置文件的级别,就记录。
• trace:追踪,就是程序推进一下,可以写个trace输出
• debug:调试,一般作为最低级别,trace基本不用。
• info:输出重要的信息,使用较多
• warn:警告,有些信息不是错误信息,但也要给程序员一些提示。
• error:错误信息。用的也很多。
• fatal:致命错误。
2、PatternLayout自定义日志布局:
%d{yyyy-MM-dd HH:mm:ss, SSS} : 日志生产时间,输出到毫秒的时间
%-5level : 输出日志级别,-5表示左对齐并且固定输出5个字符,如果不足在右边补0
%c : logger的名称(%logger)
%t : 输出当前线程名称
%p : 日志输出格式
%m : 日志内容,即 logger.info("message")
%n : 换行符
%C : Java类名(%F)
%L : 行号
%M : 方法名
%l : 输出语句所在的行数, 包括类名、方法名、文件名、行数
hostName : 本地机器名
hostAddress : 本地ip地址
3、log4j2配置详解
根节点Configuration
有两个属性:• status
• monitorinterval
有两个子节点:
• Appenders
• Loggers(表明可以定义多个Appender和Logger).
status用来指定log4j本身的打印日志的级别.
monitorinterval用于指定log4j自动重新配置的监测间隔时间,单位是s,最小是5s.Appenders节点
常见的有三种子节点:Console、RollingFile、FileConsole节点用来定义输出到控制台的Appender.
• name:指定Appender的名字.
• target:SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT.
• PatternLayout:输出格式,不设置默认为:%m%n.
File节点用来定义输出到指定位置的文件的Appender.
• name:指定Appender的名字.
• fileName:指定输出日志的目的文件带全路径的文件名.
• PatternLayout:输出格式,不设置默认为:%m%n.
RollingFile节点用来定义超过指定条件自动删除旧的创建新的Appender.
• name:指定Appender的名字.
• fileName:指定输出日志的目的文件带全路径的文件名.
• PatternLayout:输出格式,不设置默认为:%m%n.
• filePattern : 指定当发生Rolling时,文件的转移和重命名规则.
• Policies:指定滚动日志的策略,就是什么时候进行新建日志文件输出日志.
• TimeBasedTriggeringPolicy:Policies子节点,基于时间的滚动策略,interval属性用来指定多久滚动一次,默认是1 hour。modulate=true用来调整时间:比如现在是早上3am,interval是4,那么第一次滚动是在4am,接着是8am,12am...而不是7am.
• SizeBasedTriggeringPolicy:Policies子节点,基于指定文件大小的滚动策略,size属性用来定义每个日志文件的大小.
• DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的,创建新的(通过max属性)。
Loggers节点,常见的有两种:Root和Logger.
Root节点用来指定项目的根日志,如果没有单独指定Logger,那么就会默认使用该Root日志输出• level:日志输出级别,共有8个级别,按照从低到高为:All < Trace < Debug < Info < Warn < Error < AppenderRef:Root的子节点,用来指定该日志输出到哪个Appender.
• Logger节点用来单独指定日志的形式,比如要为指定包下的class指定不同的日志级别等。
• level:日志输出级别,共有8个级别,按照从低到高为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
• name:用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点.
• AppenderRef:Logger的子节点,用来指定该日志输出到哪个Appender,如果没有指定,就会默认继承自Root.如果指定了,那么会在指定的这个Appender和Root的Appender中都会输出,此时我们可以设置Logger的additivity="false"只在自定义的Appender中进行输出。