SpringBoot 教程 & 笔记 |Demo09- 整合 Log4j2

一.背景

spring boot 支持的日志框架有 Logback、Log4j2、Log4j、Java Util Logging，默认使用的是 logback 日志框架，由于一直使用 log4j2，所以本文主要介绍 spring boot 集成 log4j2 日志框架。

二.集成 Log4j2

2.1 添加依赖

引入 Log4j2 依赖：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <groupId>com.heardfate</groupId>
    <artifactId>springboot-demo09</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>11</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                <!-- 去掉默认配置 -->
                <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>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

2.2 Log4J2 配置

在 src/main/resources 添加 log4j2.xml 文件
添加如下内容：

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

<!--设置log4j2的自身log级别为OFF-->
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，
    当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration status="off" monitorInterval="1800">
    <properties>
        <property name="LOG_HOME">/Volumes/MacDisk/logs/springbootdemo</property>
        <property name="BACKUP_HOME">${LOG_HOME}/backup</property>
        <property name="SERVER_NAME">demo09</property>
        <Property name="LOG_PATTERN">%date{yyyy-MM-dd HH:mm:ss.SSS} %-7level [%thread][%class{36}:%line] - %msg%n
        </Property>
        <Property name="FILE_PATTERN">${BACKUP_HOME}/${SERVER_NAME}.%d{yyyy-MM-dd}.log</Property>

    </properties>
    <appenders>
        <!-- 定义控制台输出 -->
        <Console name="Console" target="SYSTEM_OUT" follow="true">
            <!--输出日志的格式-->
            <PatternLayout pattern="${LOG_PATTERN}"/>
        </Console>
        <!-- 程序员调试日志,按天分日志,一天一个日 -->
        <RollingRandomAccessFile name="DevLog" fileName="${LOG_HOME}/dev/${SERVER_NAME}.log" filePattern="${FILE_PATTERN}">
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
            </Policies>
        </RollingRandomAccessFile>
        <!-- 生产环境日志,按天分日志,一天一个日志 -->
        <RollingRandomAccessFile name="Daily" fileName="${LOG_HOME}/${SERVER_NAME}.log" filePattern="${FILE_PATTERN}">
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <TimeBasedTriggeringPolicy interval="1" modulate="true"/>
            </Policies>
        </RollingRandomAccessFile>
    </appenders>
    <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->
    <Loggers>
        <!--过滤掉spring、hibernate、apache的一些DEBUG信息,只输出INFO以上的信息-->
        <Logger name="org.springframework" level="INFO" />
        <Logger name="org.hibernate" level="INFO" />
        <Logger name="org.apache" level="INFO" />

        <Root level="DEBUG">
            <AppenderRef ref="Console"/>
            <AppenderRef ref="DevLog"/>
            <AppenderRef ref="Daily"/>
        </Root>
    </Loggers>
</configuration>

2.3 打印 Log

在需要打印日志的类添加如下代码 private static final Logger logger = LoggerFactory.getLogger(类名称.class);

2.4 启动项目

启动项目查看日志打印情况

三.多环境 Log4j2 配置

为多个环境添加多个 xml,如 log4j2_dev.xml、log4j2_pro.xml、log4j2_test.xml
创建 application-dev.yml、application-test.yml、application-pro.yml，内容分别如下

application-dev.yml

logging:
  config: classpath:log4j2_dev.xml

application-test.yml

logging:
  config: classpath:log4j2_test.xml

application-pro.yml

logging:
  config: classpath:log4j2_pro.xml

application.yml 配置如下，修改 active 为 pro、test、dev

spring:
  profiles:
	active: pro

接着移除原来的 log4j2.xml，启动项目即可
GitHub 地址

四、配置全解

4.1 关于配置文件的名称以及优先级

　　　　log4j 2.x 版本不再支持像 1.x 中的.properties 后缀的文件配置方式，2.x 版本配置文件后缀名只能为".xml",".json"或者".jsn".
　　　　系统选择配置文件的优先级(从先到后)如下：
　　　　　　(1).classpath 下的名为 log4j2-test.json 或者 log4j2-test.jsn 的文件.
　　　　　　(2).classpath 下的名为 log4j2-test.xml 的文件.
　　　　　　(3).classpath 下名为 log4j2.json 或者 log4j2.jsn 的文件.
　　　　　　(4).classpath 下名为 log4j2.xml 的文件.

4.2 配置文件节点解析　　　　

　　　　(1).根节点 Configuration 有两个属性:status 和 monitorinterval,有两个子节点:Appenders 和 Loggers(表明可以定义多个 Appender 和 Logger).
　　　　　　　status 用来指定 log4j 本身的打印日志的级别.
　　　　　　　monitorinterval 用于指定 log4j 自动重新配置的监测间隔时间，单位是 s,最小是 5s.
　　　　(2).Appenders 节点，常见的有三种子节点:Console、RollingFile、File.
　　　　　　　Console 节点用来定义输出到控制台的 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:指定新建日志文件的名称格式.
　　　　　　　　Policies:指定滚动日志的策略，就是什么时候进行新建日志文件输出日志.
　　　　　　　 TimeBasedTriggeringPolicy:Policies 子节点，基于时间的滚动策略，interval 属性用来指定多久滚动一次，默认是 1 hour。modulate=true 用来调整时间：比如现在是早上 3am，interval 是 4，那么第一次滚动是在 4am，接着是 8am，12am...而不是 7am.
　　　　　　　　SizeBasedTriggeringPolicy:Policies 子节点，基于指定文件大小的滚动策略，size 属性用来定义每个日志文件的大小.
　　　　　　　　DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的，创建新的(通过 max 属性)。
　　　　(3).Loggers 节点，常见的有两种:Root 和 Logger.
　　　　　　　Root 节点用来指定项目的根日志，如果没有单独指定 Logger，那么就会默认使用该 Root 日志输出
　　　　　　　　　level:日志输出级别，共有 8 个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
　　　　　　　　　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).关于日志 level.
　　　　　　共有 8 个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
　　　　　　All:最低等级的，用于打开所有日志记录.
　　　　　　Trace:是追踪，就是程序推进以下，你就可以写个 trace 输出，所以 trace 应该会特别多，不过没关系，我们可以设置最低日志级别不让他输出.
　　　　　　Debug:指出细粒度信息事件对调试应用程序是非常有帮助的.
　　　　　　Info:消息在粗粒度级别上突出强调应用程序的运行过程.
　　　　　　Warn:输出警告及 warn 以下级别的日志.
　　　　　　Error:输出错误信息日志.
　　　　　　Fatal:输出每个严重的错误事件将会导致应用程序的退出的日志.
　　　　　　OFF:最高等级的，用于关闭所有日志记录.
　　　　　　**程序会打印高于或等于所设置级别的日志，设置的日志等级越高，打印出来的日志就越少**。