Spring boot配置log4j2日志

原创于 2020-10-21 23:27:53 发布 · 424 阅读

2 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#java #log4j2 #log4j

Springboot 专栏收录该内容

15 篇文章

订阅专栏

本文介绍了如何在SpringBoot项目中将默认的Logback日志框架替换为Log4j2。首先，需要根据SpringBoot的版本（1.3.x及以下或1.3.x以上）排除Logback依赖并引入相应版本的Log4j或Log4j2依赖。然后，详细展示了Log4j2的配置文件log4j2.xml的结构和各个元素的作用，包括Console、RollingFile等Appender的配置以及日志级别的设定。最后提到了在SpringBoot主配置文件中指定日志配置的位置。

Spring Boot工程t默认的日志框架Logback，所以我们在引入log4j之前，需要先排除该包的依赖，再引入log4j的依赖。

需要注意的是
Spring Boot 只有1.3.x和1.3.x以下版本才支持log4j的日志配置，1.3.x以上版本只支持log4j2。

Spring Boot 1.3.x以下版本的pom.xml文件如下:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <exclusions>
        <exclusion> 
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j</artifactId>
</dependency>

Spring Boot 1.3.x以上版本的pom.xml文件如下:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <exclusions>
        <exclusion> 
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

以log4j2为例，
引入依赖后，需要对log4j进行配置：

log4j2.xml

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

    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss,SSS} %5p %c{1}:%L - %m%n"/>
        </Console>
    </Appenders>
    <Loggers>
           //logger 标签下的name属性 是需要追踪的对象的全限定类名，level是日志显示级别
        <logger name="com.example.mytest01.dao.t_tempDao" level="debug"/>
        
    </Loggers>
    
</Configuration>

还需要在spring boot主配置文件中引入：

logging.config=classpath:log4j2.xml

对于log4j2.xml中标签以及属性：

根节点Configuration有两个属性:status和monitorinterval,有两个子节点:Appenders和Loggers(表明可以定义多个Appender和Logger).
status用来指定log4j本身的打印日志的级别.
monitorinterval用于指定log4j自动重新配置的监测间隔时间，单位是s,最小是5s.
Appenders节点，常见的有四种子节点:Console、RollingFile、File、Socket.
Console节点用来定义输出到控制台的Appender.
name:指定Appender的名字.
target:SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT.
PatternLayout:输出格式，不设置默认为:%m%n.　　　　　　　
File节点用来定义输出到指定位置的文件的Appender.
name:指定Appender的名字.
fileName:指定输出日志的目的文件带全路径的文件名.
PatternLayout:日志的输出格式，不设置默认为:%m%n.
RollingFile节点用来定义超过指定大小自动归档（rolling）旧的创建新的的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属性)。
Filter: 日志过滤，如：，表示debug级别以上的log会被打印

Socket节点用来定义将日志输出至别的服务器上

loggers节点 logger表明，对某一文件，只有高于某级别，才被打印

AppenderRef：Logger的子节点，用来指定该日志输出到哪个Appender,如果没有指定，就会默认继承自Root.如果指定了，那么会在指定的这个Appender和Root的Appender中都会输出，此时我们可以设置Logger的additivity="false"只在自定义的Appender中进行输出。