日志之log4j2

我会带着你远行 2022-03-25 04:58 431阅读 0赞

# 日志之log4j2 #

### 1.1 简介 ###

log4j2，一个日志的实现框架，是log4j的升级版本，于2014年7月正式亮相。与第一代log4j不同，log4j2完全重写了log4j的日志实现，并不是在原有基础上进行的升级，解决了log4j中的一些问题，例如：多线程下性能低下、api不支持占位符\{\}的使用、配置文件不能自动重新加载等。

为什么说log4j在多线程情况下性能低下呢？主要是synchronized锁在作怪，当我们的log4jzai 获取appender对象时，需要进行加锁处理；而接下来对appender操作(将要进行日志打印)时，也进行了加锁处理，这样一来性能自然得不到提升，从而导致整个应用的qps下降。

而在log4j2中，由于引入了异步logger，使得log4j2的性能得到了巨大的提升，相比于log4j，logback而言，提升了数10倍之多。关于异步logger的情况，我们后面进行讲解。

### 1.2 log4j2结构 ###

![img][]

![img][img 1]

LoggerContext：Logger上下文，主要负责读取log4j2的配置以及获取Logger对象的工作；

Logger：日志对象，负责日志信息的打印；跟之前的几个日志框架相同，log4j2也包含了5大日志级别，分别为TRACE,DEBUG,INFO,WARN,ERROR 以及FATAL；具体等级如下：TRACE < DEBUG < INFO < WARN < ERROR < FATAL;

LoggerConfig：Logger的配置对象，每一个Logger的配置信息就是一个LoggerConfig对象；

Configuration：log4j2配置文件的解析，当我们的配置文件是xml的格式时，具体的实现是XmlConfiguration；每一个LoggerContext都有一个Configuration对象，包含了所有的Appender、Filter、LoggerConfig

### 1.3 使用 ###

首先，需要在应用的pom.xml中添加依赖：

<dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-api</artifactId>
            <version>2.8.2</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <version>2.8.2</version>
        </dependency>

其次，声明测试代码：

public class log4j2Demo { 
    
        private Logger logger = LogManager.getLogger(log4j2Demo.class);
    
        @Test
        public void test() throws InterruptedException { 
            logger.error("Error Message!");
            logger.warn("Warn Message!");
            logger.info("Info Message!");
            logger.debug("Debug Message!");
            logger.trace("Trace Message!");
        }
    }

最后，在classpath下声明配置文件：log4j2.xml:

<?xml version="1.0" encoding="UTF-8"?>
    <Configuration status="info" monitorInterval="30">
        <Appenders>
            
            <Console name="Console" target="SYSTEM_OUT">-->
                <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
            </Console>
    
            
            <File name="File" fileName="e:/log.out" append="true" immediateFlush="true" >
                <PatternLayout>
                    <Pattern>%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %L- %msg%n</Pattern>
                </PatternLayout>
            </File>
        </Appenders>
        <Loggers>
            <Root level="debug" >
                <AppenderRef ref="File"/>
                <AppenderRef ref="Console"/>
            </Root>
        </Loggers>
    </Configuration>

通过以上步骤，log4j2就可以正常的运行了。

### 1.4 log4j2配置文件详解 ###

与log4j不同的是，log4j2只支持.xml或者.json格式的配置文件，不在支持.properties格式的配置文件。那么，下面我们就以.xml来进行讲解：

默认情况下，系统会在classpath下查找配置文件：（按照以下顺序）

1.classpath下名为 log4j-test.json 或者log4j-test.jsn文件
    2.classpath下名为 log4j2-test.xml
    3.classpath下名为 log4j.json 或者log4j.jsn文件
    4.classpath下名为 log4j2.xml

请注意，此处我们常用的是log4j2.xml，这块与log4j不同；

以下是log4j2常用的配置信息：（逐一进行讲解）

<?xml version="1.0" encoding="UTF-8"?>
    <Configuration status="info" monitorInterval="30">
        <Appenders>
    
            
            <Console name="Console" target="SYSTEM_OUT">
                <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
            </Console>
    
            
            <File name="File" fileName="e:/log.out" append="true" immediateFlush="false" bufferedIO="true" bufferSize="1024">
                <PatternLayout>
                    <Pattern>%d{ HH:mm:ss.SSS} [%t] %-5level %logger{ 36} - %L- %msg%n</Pattern>
                </PatternLayout>
            </File>
    
            
            <Async name="Async">
                <AppenderRef ref="File"/>
            </Async>
    
            
            <RollingFile name="RollingFile" fileName="e:/log.out" filePattern="e:/app-%d{yyyy-MM-dd_HH-mm}-%i.out">
                <PatternLayout>
                    <Pattern>%d{ HH:mm:ss.SSS} [%t] %-5level %logger{ 36} - %msg%n</Pattern>
                </PatternLayout>
                
                <Policies>
                    <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
                    <SizeBasedTriggeringPolicy size="100 kb"/> 
                </Policies>
                <DefaultRolloverStrategy max="5"/>
            </RollingFile>
    
        </Appenders>
    
        <Loggers>
           
            
            <Logger name="com.jiaboyan.logDemo.log4j2Demo" level="info" additivity="false" includeLocation="true">
                <AppenderRef ref="File"/>
            </Logger>
            
            
            <Root level="info" >
                <AppenderRef ref="Async"/>
                <AppenderRef ref="File"/>
                <AppenderRef ref="Console"/>
            </Root>
            
            
            <AsyncRoot level="info">
                <AppenderRef ref="File"/>
            </AsyncRoot>
        </Loggers>
    
    </Configuration>

1.Configuration – 根节点

<Configuration status="debug" monitorInterval="30"></Configuration>
        Configuration：表示log4j2中的Configuration对象，实际为XmlConfiguration;
        
        status：表示log4j2本身的日志信息打印级别，当设置为TRACE 或者 DEBUG 级别时，便会打印出log4j2内部初始化的一些日志信息； 
        
        monitorInterval：表示每隔一定时间重新加载log4j2配置文件，单位秒；

2.Appenders – Console

<Console name="Console" target="SYSTEM_OUT">
        <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
    </Console>
    
    name：表示控制台Appender的名称，<logger>中会依赖此名称，起名没有具体要求，但最好简明直译；
    
    target：表示ConsoleAppender使用哪种方式将日志输出到控制台，一般调用System.out.println()方法；
    
    PatternLayout--pattern：表示日志信息输出的格式；

3.Appenders – File

<File name="File" fileName="e:/log.out" append="true" immediateFlush="false" bufferedIO="true" bufferSize="8096">
        <PatternLayout>
            <Pattern>%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %L- %msg%n</Pattern>
        </PatternLayout>
    </File>
    
    name：表示文件Appender的名称，<logger>中会依赖此名称，起名没有具体要求，但最好简明直译；
    
    fileName：表示生成的日志文件名称；
    
    append：表示新生成的日志是否追加到日志文件中，如果为true则表示追加，false表示覆盖原有日志信息；
    
    immediateFlush：表示日志打印请求是否立即输出，true为立即，false表示使用缓存；
    
    bufferedIO：表示日志打印请求是否使用缓存，true为使用，false为不使用；
    
    bufferSize：表示日志打印请求的使用缓存的大小，默认为8096字节；
    
    PatternLayout--pattern：同上；

4.Appenders – RollingFile

<RollingFile name="RollingFile" fileName="e:/log.out" filePattern="e:/app-%d{yyyy-MM-dd_HH-mm}-%i.out">
        <PatternLayout>
            <Pattern>%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n</Pattern>
        </PatternLayout>
        <Policies>
            <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
            <CronTriggeringPolicy schedule="0 0 * * * ?"/>
            <SizeBasedTriggeringPolicy size="100 kb"/> 
        </Policies>
        <DefaultRolloverStrategy max="5"/>
    </RollingFile>
    
    name：表示滚动文件Appender的名称，<logger>中会依赖此名称，起名没有具体要求，但最好简明直译；
    
    fileName：表示当前日志所在的日志文件名称； 
    
    filePattern：表示滚动日志的文件名称模板，当日志文件进行滚动后，滚动后的文件按照此模板进行命名；
    
    PatternLayout--pattern：同上；
    
    Policies：表示日志文件滚动策略；
    
    Policies -- TimeBasedTriggeringPolicy：表示日志文件按照时间间隔来进行滚动；
    
    Policies -- CronTriggeringPolicy：表示日志文件按照设置的时间点来进行滚动；
    
    Policies -- SizeBasedTriggeringPolicy：表示日志文件按照文件大小来进行滚动；
    
    DefaultRolloverStrategy：表示log4j2进行滚动后保存的日志文件数量，默认为7个；

6.CronTriggeringPolicy

<CronTriggeringPolicy schedule="0 0 * * * ?"/>
    
    CronTriggeringPolicy表示按照Cron表达式设置的时间点进行切割日志；
    
    schedule：表示设置的cron表达式；

7.SizeBasedTriggeringPolicy

<SizeBasedTriggeringPolicy size="100 kb"/> 
    
    SizeBasedTriggeringPolicy表示按照规定的日志文件大小进行切割日志；
    
    size：表示进行切割日志文件大小的极值，当日志文件大小满足size的值时，就会进行日志的切割；

DefaultRolloverStrategy

<DefaultRolloverStrategy max="5"/>
    
    DefaultRolloverStrategy表示log4j2每单位时间内最多能保存多少个日志切割文件，一般与SizeBasedTriggeringPolicy结合使用；
    
    max:表示保存的最大值，默认为7；
    
    例如：你的log4j2.xml设置如下：fileName="e:/log.out" filePattern="e:/app-%d{yyyy-MM-dd_HH-mm}-%i.out"
    那么在每分钟内，你可以保留2个日志切割文件，多余的日志进行覆盖；

8.Appenders – Async

<Async name="Async">
        <AppenderRef ref="File"/>
    </Async>
    
    name：表示异步Appender的名称，<logger>中会依赖此名称，起名没有具体要求，但最好简明直译；
    异步Appender使用消费者生产者模式进行日志信息的打印，适用于并发量较大的情况；

9.PatternLayout

<PatternLayout>
        <Pattern>%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n</Pattern>
    </PatternLayout>
    
    Pattern:设置输出的日志信息格式；具体格式如下：
    
    %d{yyyy-MM-dd HH:mm:ss, SSS} : 日志生产时间
    %t : 线程名称
    %p : 日志级别
    %level : 日志级别
    %c : logger的名称
    %logger : logger的名称
    %C : Java类名
    %m : 日志内容
    %n : 换行符
    %L : 日志输出所在行数
    %M : 日志输出所在方法名

10.Loggers – Logger

<Logger name="com.jiaboyan.logDemo.log4j2Demo" level="info" additivity="false">
        <AppenderRef ref="File"/>
    </Logger>
    
    在<Loggers>节点下，对某个类单独进行日志配置，便可使用<logger>节点；
    上例中，我们对名称为com.jiaboyan.logDemo.log4j2Demo的类进行日志配置。
    level指定级别，additivity表示是否向上传递打印日志信息（若为true则向上传递，那么root根对象也会进行日志打印）；

11.Loggers – Root

<Root level="info" >
        <AppenderRef ref="Async"/>
        <AppenderRef ref="File"/>
        <AppenderRef ref="Console"/>
    </Root>
    
    Root根日志节点，指定具体的日志级别，以及使用何种Appender进行日志输出；

12.Loggers – AsyncRoot

<AsyncRoot level="info" includeLocation="false">
        <AppenderRef ref="File"/>
    </AsyncRoot>
        
    如果想使用异步logger，还需要在pom.xml中添加disruptor的依赖。
    includeLocation结合异步logger使用，当其设置为true时，才会显示具体的行号，以及日志所在的类名；
    如果设置为false，哪怕<Pattern>设置了输出行号也不会显示出来；

### 1.5 log4j2源码分析 ###

暂略

### 1.6 log4j2性能测试 ###

[Java日志框架性能比较][Java]

### 1.7 DISRUPTOR RING BUFFER介绍 ###

暂略

[img]: /images/20220325/04d33fe1b1f3442d82f2203695f65113.png
[img 1]: http://i.imgur.com/HxxSeYc.png
[Java]: https://www.jianshu.com/p/3098942fbcbf