Log4j2——SpringBoot集成及配置属性介绍

概述：

一般经常能听到日志组件有log4j, log4j2, logback，以及slf4j。

首先slf4j是一个简单的门面模式，意思就是说这只是一个日志标准，并不是日志系统的具体实现，slf4j只做两件事：提供日志接口和提供获取具体日志对象的方法。

至于log4j，已经在几年前停止更新了

logback是log4j的升级版，目前是springboot的默认日志组件

log4j2相对于log4j有了重大变化，官网宣称的优势有多线程下10几倍于log4j和logback的高吞吐量、可配置的审计型日志、基于插件架构的各种灵活配置等，所以这里重点介绍上log4j2的使用 以及一些概念

跟SpringBoot集成：

1、Maven导入依赖：

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-web</artifactId>
	<exclusions>
        <!--去除spring自带的logback-->
		<exclusion>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-logging</artifactId>
		</exclusion>
	</exclusions>
</dependency>

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

2、配置log4j2

log4j2可以通过xml、yml、json配置文件进行配置，也可以通过代码的方式进行配置，这里主要介绍xml配置方式。

log4j2的配置文件默认命名为log4j2.xml，路径在classpath，当然也可以自己自定义文件名，比如log4j2-test.xml，这时需要在application.properties配置log4j2.xml文件路径名，比如：

logging.config=classpath:log4j2-test.xml

简单配置 ：

先来一个简单的配置文件，可以对log4j2.xml有个直观的认识：

<?xml version="1.0" encoding="UTF-8"?>

<configuration status="OFF">
    <appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} {%t} %-5level %logger[36] -%msg%n"/>
        </Console>
    </appenders>

    <loggers>
        <logger name="test.go" level="info" additivity="false">
            <appender-ref ref="Console"/>
        </logger>
        <root level="error">
            <appender-ref ref="Console"/>
        </root>
    </loggers>

</configuration>

测试文件：

package com.test.log.test;

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

public class TestLog {
    private static Logger logger1 = LogManager.getLogger("test.go");
    private static Logger logger2 = LogManager.getLogger(TestLog.class);
    public static void main(String[] args) {
        logger1.info("------------info log1, FROM log name: test.og");
        logger2.info("++++++++++++info log2, From log name: TestLog.class");
    }
}

目录结构：

输出结果：

说明：

这里定义了一个简单的log4j2日志配置，用于把log输出到控制台Console，并且自定义了一个日志器Logger，名字叫test.go，日志级别为INFO，并且把根日志器Root的日志级别为Error，也是输出到控制台Console。(配置详细会在下面说明)

在测试文件中，定义了两个logger对象，分别用"test.go" 和 TestLog.class进行构造，同时打印info日志，这时发现输出的日志只有"test.go"的。

这时可以做个改动，把log4j2.xml中的日志输出级别由error改成info：

<logger name="test.go" level="info" additivity="false">
    <appender-ref ref="Console"/>
</logger>
<root level="info">
    <appender-ref ref="Console"/>
</root>

这时可以看到Test.class的日志出输出了：

还有一个，在自定义日志器test.go中，有个additivity属性 设置成false，这个属性代码是否继承日志输出器，比如root，可以认为是否同时输出对继承日志器的Appender中，默认为true，这里可以试下  把false改成true：

可以看到test.go日志器输出了两次，也就是有一次输出是 继承的日志输出器Root，会输出到Console中

实用配置：

这里介绍RollingFile的使用，输出sql日志到文件中，并且配置文件回滚等

<?xml version="1.0" encoding="UTF-8"?>

<configuration status="OFF" monitorInterval="30">
    <properties>
        <property name="PATTERN">%d{yyyy-MM-dd HH:mm:ss.SSS} |-%-5level [%thread] %c [%L] -| %msg%n</property>
        <property name="LOGDIR">d:/logs</property>
    </properties>

    <appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} {%t} %-5level %logger[36] -%msg%n"/>
        </Console>
        <RollingFile name="SQLLogFile" fileName="${LOGDIR}/sql.log"
                     filePattern="${LOGDIR}/sql-%d{yyyy-MM-dd HH-mm}-%i.log" append="true">
            <PatternLayout pattern="${PATTERN}"/>
            <DefaultRolloverStrategy max="10"/>
            <Policies>
                <TimeBasedTriggeringPolicy interval="1" />
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
        </RollingFile>
    </appenders>

    <loggers>
        <logger name="test.go" level="info" additivity="true">
            <appender-ref ref="Console"/>
        </logger>
        <!-- sql打印到日志文件 -->
        <logger name="com.test.log.dao" level="DEBUG" additivity="false">
            <appender-ref ref="SQLLogFile"/>
            <appender-ref ref="Console"/>
        </logger>

        <root level="info">
            <appender-ref ref="Console"/>
        </root>
    </loggers>

</configuration>

测试文件：

package com.test.log.controller;

import com.test.log.dao.AdminMapper;
import com.test.log.entity.AdminEntity;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
public class AdminController {
    @Autowired
    private AdminMapper adminMapper;

    @GetMapping("admin")
    public List<AdminEntity> getAllAdmins(){
        return adminMapper.getAllAdmins();
    }
}

输出：
可以看到在控制台中输出如下日志：

同时在d:/logs/log.log中也有日志记录：

基本说明：

<properties>: 定义了两个常量方便后面使用

<RollingFile>属性：

fileName: 指定当前日志文件的位置和文件名称

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

DefaultRolloverStrategy: 指定最多保存的文件个数

SizeBasedTriggeringPolicy: 指定当文件体积大于size指定的值时，触发Rolling

TimeBasedTriggeringPolicy: 这个配置需要和filePattern结合使用，注意filePattern中配置的文件重命名规则是

${LOGDIR}/sql-%d{yyyy-MM-dd HH-mm}-%i.log，最小的时间粒度是mm，即分钟，TimeBasedTriggeringPolicy指定的size是1，

结合起来就是每1分钟生成一个新文件。如果改成%d{yyyy-MM-dd HH}，最小粒度为小时，最每1小时生成一个文件。

 

配置说明：

日志级别：

共有8个级别，按照从低到高为 All < Trace < Debug < Info < Warn < Error < Fatal < Off

All: 最低等级的，用于打开所有日志记录

Trace: 追踪，程序执行就会输出trace日志，所以trace会特别多，一般会设置最低日志级别不让他输出

Debug: 指出细粒度信息事件对调试应用程序是非常有帮助的

Info: 消息在粗粒度级别上突出强调应用程序的运行过程

Warn: 输出警告及warn以下级别的日志

Error: 输出错误信息日志

Fatal: 输出每个严重的错误事件将会导致应用程序的退出的日志

Off: 最高等级的，用于关闭所有日志记录

log4j2.xml总体文件结构如下：

Configuration

             Appenders

                      Console

                               PatternLayout

                      File

                      RollingFile

                      ...

           Loggers

                     Logger

                            AppenderRef(可不写)

                    Root

                            AppenderRef

Configuration为根节点，配置log4j2基础属性，如status，monitorInterval等

        status: 用于控制log4j2日志框架本身的日志级别，有“trace”, "debug", "info"...."fatal" 和"off"属性，如果将status设置为较低的级别就会看到很多关于log4j2本身的日志，如加载log4j2配置文件的路径等信息

       monitorInterval: 含义是每隔多少秒重新读取配置文件，可以不重启应用的情况下修改配置

Configuration分为Appeners和Loggers两大模块

      Appenders 输出源：用于定义日志输出的地方，包含各种子Appender，比如ConsoleAppender, FileAppender, NoSql等

              Console: 控制台输出源是将日志打印到控制台上，开发的时候一般都会配置，以便调试

              File: 文件输出源，用于将日志写入到指定的文件，需要配置输入到哪个位置（例如：D:/logs/sql.log）    

              RollingRandomAccessFile: 该输出源也是写入到文件，不同的是比File更加强大，可以指定当文件达到一定大小（如20MB）时，另起一个文件继续写入日志，另起一个文件就涉及到新文件的名字命名规则，因此需要配置文件命名规则，这种方式更加实用，因为你不可能一直往一个文件中写，如果一直写，文件过大，打开就会卡死，以不便于查找日志

                    fileName: 指定当前日志文件的位置和文件名称

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

                    SizeBasedTriggeringPolicy: 指定当文件体积大于size指定的值时，触发Rolling

                    DefaultRolloverStrategy: 指定最多保存的文件个数

                    TimeBasedTriggeringPolicy: 这个配置需要和filePattern结合使用，注意filePattern中配置的文件重命名规则是log-%d{yyyy-MM-dd HH-mm-%} -%i，最小的时间粒度是mm，即分钟，如果指定的size是1，结合起来就是每1分钟生成一个新的文件。如果改成%d{yyyy-MM-dd HH}，最小粒度为小时，即每一个小时生成一个文件

                    NoSql: MongoDb，输出到MongDb数据库中

                    Flume: 输出到Apache Flume(Flume是Cloudera提供的一个高可用的，高可靠的，分布式的海量日志采集、聚合和传输的系统，Flume支持在日志系统中定制各类数据发送方，用于收集数据；同时，Flume提供对数据进行简单处理，并写到各种数据接受方（可定制）的能力)

                   Async: 异步，需要通过AppenderRef来指定要对哪种输出源进行异步（一般用于配置RollingRandomAccessFile）

          PatternLayout: 控制台或文件输出源（Console、File、RollingRandomAccessFile）都必须包含一个PatternLayout节点，用于指定输出文件的格式（如 日志输出的时间 文件 方法 行数 等格式），例如 pattern=”%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n”

%d{HH:mm:ss.SSS} 表示输出到毫秒的时间
%t 输出当前线程名称
%-5level 输出日志级别，-5表示左对齐并且固定输出5个字符，如果不足在右边补0
%logger 输出logger名称，因为Root Logger没有名称，所以没有输出
%msg 日志文本
%n 换行

其他常用的占位符有：
%F 输出所在的类文件名，如Log4j2Test.java
%L 输出行号
%M 输出所在方法名
%l 输出语句所在的行数, 包括类名、方法名、文件名、行数

 Loggers 日志器：包含各种自定义Logger，以及根日志器Root

      日志器分根日志器Root和自定义日志器，当根据日志名字获取不到指定的日志器时就使用Root作为默认的日志器，自定义时需要指定每个Logger的名称name（对于命名可以以包名作为日志的名字，不同的包配置不同的级别等），日志级别level，相加性additivity（是否继承下面配置的日志器）， 对于一般的日志器（如Console、File、RollingRandomAccessFile）一般需要配置一个或多个输出源AppenderRef；

每个logger可以指定一个level（TRACE, DEBUG, INFO, WARN, ERROR, ALL or OFF），不指定时level默认为ERROR

additivity指定是否同时输出log到父类的appender，缺省为true。

<Logger name="rollingRandomAccessFileLogger" level="trace" additivity="true">  
    <AppenderRef ref="RollingRandomAccessFile" />  
</Logger>

Properties属性：

   使用来定义常量，以便在其他配置的时候引用，该配置是可选的，例如定义日志的存放位置 D:/logs