Log4j2日志框架详解

一、关于常用的日志框架：

介绍：

  • java.util.logging：是JDK在1.4版本中引入的Java原生日志框架
  • log4j：Apache的一个开源项目，可以控制日志信息输送的目的地是控制台、文件、GUI组件等，可以控制每一条日志的输出格式，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。虽然已经停止维护了，但目前绝大部分企业都是用的log4j
  • logBack：是Log4j的一个改良版本
  • log4j2：Log4j2已经不仅仅是Log4j的一个升级版本了，它从头到尾都被重写了

性能比较：

在这列举一下一些网上其他博文中对它们的性能评测：

微信截图_20220816143503

  • 可以看到在同步日志模式下, logback的性能是最糟糕的
  • log4j2的性能无论在同步日志模式还是异步日志模式下都是最佳的，而且相比与其他的日志系统，log4j2采用了disruptor技术丢数据这种情况少，在多线程环境下，性能高于logback等10倍以上；利用jdk1.5并发的特性，减少了死锁的发生；

微信截图_20220816143722

  • log4j2优越的性能其原因在于log4j2使用了LMAX,一个无锁的线程间通信库代替了logback和log4j之前的队列. 并发性能大大提升。

二、整合Springboot+Log4j

1. 修改pom.xml

由于springboot默认是用logback的日志框架的，所以需要排除logback，不然会出现jar依赖冲突的报错。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<dependency>  
    <groupId>org.springframework.boot</groupId>  
    <artifactId>spring-boot-starter</artifactId>  
    <exclusions><!-- 去掉springboot默认配置 -->  
        <exclusion>  
            <groupId>org.springframework.boot</groupId>  
            <artifactId>spring-boot-starter-logging</artifactId>  
        </exclusion>  
    </exclusions>  
</dependency> 

<dependency> <!-- 引入log4j2依赖 -->  
    <groupId>org.springframework.boot</groupId>  
    <artifactId>spring-boot-starter-log4j2</artifactId>  
</dependency>

2. 修改application.properties

1
2
#配置文件默认为log4j2-spring.xml，不修改就不用配置
logging.config=classpath:xxx.xml

3. 添加xml配置文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
<?xml version="1.0" encoding="UTF-8"?>
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration monitorInterval="5">
    <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->

    <!--变量配置-->
    <Properties>
        <!-- 格式化输出：%date表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度 %msg：日志消息，%n是换行符-->
        <!-- %logger{36} 表示 Logger 名字最长36个字符 -->
        <property name="LOG_PATTERN" value="%date{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n" />
        <!-- 定义日志存储的路径 -->
        <property name="FILE_PATH" value="更换为你的日志路径" />
        <property name="FILE_NAME" value="更换为你的项目名" />
    </Properties>

    <appenders>

        <console name="Console" target="SYSTEM_OUT">
            <!--输出日志的格式-->
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <!--控制台只输出level及其以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
        </console>

        <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，适合临时测试用-->
        <File name="Filelog" fileName="${FILE_PATH}/test.log" append="false">
            <PatternLayout pattern="${LOG_PATTERN}"/>
        </File>

        <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/info.log" filePattern="${FILE_PATH}/${FILE_NAME}-INFO-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

        <!-- 这个会打印出所有的warn及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileWarn" fileName="${FILE_PATH}/warn.log" filePattern="${FILE_PATH}/${FILE_NAME}-WARN-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

        <!-- 这个会打印出所有的error及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileError" fileName="${FILE_PATH}/error.log" filePattern="${FILE_PATH}/${FILE_NAME}-ERROR-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

    </appenders>

    <!--Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。-->
    <!--然后定义loggers，只有定义了logger并引入的appender，appender才会生效-->
    <loggers>

        <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
        <logger name="org.mybatis" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </logger>
        <!--监控系统信息-->
        <!--若是additivity设为false，则 子Logger 只会在自己的appender里输出，而不会在 父Logger 的appender里输出。-->
        <Logger name="org.springframework" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </Logger>

        <root level="info">
            <appender-ref ref="Console"/>
            <appender-ref ref="Filelog"/>
            <appender-ref ref="RollingFileInfo"/>
            <appender-ref ref="RollingFileWarn"/>
            <appender-ref ref="RollingFileError"/>
        </root>
    </loggers>

</configuration>

机制：如果一条日志信息的级别大于等于配置文件的级别，就记录 ，常用的配置参数简介：

  1. 日志级别
  • trace：追踪，就是程序推进一下，可以写个trace输出
  • debug：调试，一般作为最低级别，trace基本不用。
  • info：输出重要的信息，使用较多
  • warn：警告，有些信息不是错误信息，但也要给程序员一些提示。
  • error：错误信息。用的也很多。
  • fatal：致命错误。
  1. 格式
  • SimpleLayout：以简单的形式显示
  • HTMLLayout：以HTML表格显示
  • PatternLayout：自定义形式显示
参数（pattern的配置） 描述
%d{pattern} 日志生产时间,输出到毫秒的时间:pattern={yyyy-MM-dd HH:mm:ss, SSS}
%-5level 输出日志级别，-5表示左对齐并且固定输出5个字符，如果不足在右边补空格
%c或%logger 输出logName，如 Logger log = LoggerFactory.getLogger(“com.test.logName”); 则输出为“com.test.logName” ，如果格式为%c{参数}，则输出内容参考官网：
%C 输出为所在类的全路径名
%t 输出当前线程名称
%p 日志输出格式
%m 日志内容，即 logger.info(“message”)
%M 方法名
%n 换行符
%l 输出语句所在的行数, 包括类名、方法名、文件名、行数
%L 行号
hostName 本地机器名
hostAddress 本地ip地址
%F 输出所在类名.java，如所在类为com.test.LogTest，则输出为LogTest.java
%T 输出线程id
%tp 输出线程优先级
%sn 输出自增序列 
1
2
3
4
5
<!--如果用了log4j2没有日志颜色或者想要logback初始的pattern-->
pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %highlight{%-5level} %style{%t}{magenta} --- [%15.15t] %style{%-40.40logger{39}}{cyan} : %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}"

<!--还需在启动类配置的vm选项中加入-->
-Dlog4j.skipJansi=false

3.配置详解

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<Configuration status monitorinterval>
    
    <Appenders>
        <console></console>
        
        <RollingFile>
            <Policies>
                <TimeBasedTriggeringPolicy/>
            </Policies>
        </RollingFile>
        
        <File></File>
        
    </Appenders>
    
    <Loggers>
        <logger></logger>
        <root></root>
    </Loggers>
    
</Configuration>

  • Configuration为配置根节点包含Appenders、Loggers

    • status：用来指定log4j本身的打印日志的级别

    • monitorinterval：用于指定log4j自动重新配置的监测间隔时间，单位是s,最小是5s

  • Appenders常见的节点为：Console、RollingFile、File

  • Console节点用来定义输出到控制台的Appender

    • name ：指定Appender的名字
    • target:SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT
    • PatternLayout：输出格式，不设置默认为:%m%n

  • RollingFile节点用来定义超过指定条件自动删除旧的创建新的Appender

    • name：指定Appender的名字

    • fileName：指定输出日志的目的文件带全路径的文件名

    • PatternLayout：输出格式，不设置默认为:%m%n

    • filePattern：指定当发生Rolling时，文件的转移和重命名规则

      1
      2
      3
      4
      5
      6
      7
      <!--filepattern 中的日期格式精确位数决定了生成日志的日期单位interval 决定该单位下的间隔数-->
      <!-- 按小时生成日志文件 -->
      filePattern = "${LOG_HOME}/app-%d{yyyy-MM-dd-HH-mm}.log"
      <!-- 按天生成日志文件 -->
      filePattern="${LOG_HOME}/app-%d{yyyy-MM-dd}.log"
      <!-- 按月生成日志文件 -->
      filePattern="${LOG_HOME}/app-%d{yyyy-MM}.log"

  • Policies:指定滚动日志的策略，就是什么时候进行新建日志文件输出日志

  • TimeBasedTriggeringPolicy：Policies子节点，基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1 hour。modulate=true用来调整时间：比如现在是早上3am，interval是4，那么第一次滚动是在4am，接着是8am，12am…而不是7am.

  • SizeBasedTriggeringPolicy：Policies子节点，基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小

  • DefaultRolloverStrategy：用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的，创建新的(通过max属性)。

  • File节点用来定义输出到指定位置的文件的Appender

  • 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中进行输出

4.简单使用

1
2
3
4
5
6
7
8
9
10
11
12
13
14
public class LogExample {
private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class);

public static void main(String... args) {
log.error("Something else is wrong here");
}
}
//也可使用lombok的工具简化
@Slf4j
public class LogExample {
public static void main(String... args) {
log.error("Something else is wrong here");
}
}