当前位置：首页 > news >正文

Spring Boot 日志

news 2025/7/5 7:50:07

1.概述

2.切换日志实现

3.使用

3.1.日志级别

3.3.日志离线

3.4.详细定制

1.概述

由一些历史原因，JAVA领域存在有很多日志框架，如Log4j、Logback、log4j2。

log4j是Java日志框架的元老，在log4j被Apache Foundation收入门下之后，由于理念不合，log4j的作者Ceki离开并开发了slf4j和logback。这几个框架都很热门，这就造成了不同系统、不同开源框架使用的日志框架都不同。

因为不同日志框架的日志输出格式、API均不同，所以当系统中存在多种日志框架被混用就会出现冲突，最直接的现象就是——日志格式不统一，这对项目的日志排查来说是极不方便的，甚至有时候还会因为日志框架的冲突而报错。因此同一个项目中统一日志框架是十分有必要的，但是如果只是单纯的保留一个日志框架，移除其余日志框架，由于各日志系统API的不同很可能系统根本就起不来，所以需要一个中间层来进行适配，从而解决这个问题。

这个中间层就是——日志门面。日志门面使用门面模式屏蔽掉了不同日志实现之间的不同，对外暴露统一的API。

2.切换日志实现

SpringBoot默认使用SLF4J作为日志门面，LogBack作为日志实现来记录日志。

这里我们不去细究SLF4J是怎么去完成适配的，只需要知道SpringBoot自带了日志门面，使用日志门面来输出日志，当想要切换日志实现的时候，排掉LogBack，引入新的实现即可。

以切换为log4j2为例：

<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>

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

3.使用

3.1.日志级别

配置：

可以指定全局日志等级，也可以以方法为粒度指定日志等级，支持*作为通配符

#全局日志等级
logging.level.root=trace
#单都指定日志等级
logging.level.com.eryi.controller.MyRunner.*=trace

代码：

package com.eryi.controller;import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;@Component
public class MyRunner implements CommandLineRunner {//特别注意，要使用slf4j的Logger和LoggerFactoryLogger logger= LoggerFactory.getLogger(MyRunner.class);@Overridepublic void run(String... args) throws Exception {//日志级别：error<warn<info<debug<tracelogger.trace("trace......");logger.debug("debug......");//Spring Boot默认使用info级别logger.info("info......");logger.warn("warn......");logger.error("error......");}
}

3.3.日志离线

不指定路径，日志文件只会在控制台输出，不会离线为本地文件。

使用path可以指定路径，文件名默认使用springlog.log

使用file可以指定路径+文件名，不指定路径会默认离现在工程目录下。

file和path是两个冲突设置，如果同时配置，只有file会生效。

3.4.详细定制

spring boot的配置文件中的日志配置项只能进行粗粒度的配置，想对日志进行细粒度的定制需要在类路径下（一般是在resources下）编写xml配置文件。命名规则为XXX-spring.xml，XXX是日志框架的名称。

以下为一个logback-spring.xml的模板：

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



<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">

<encoder>
<pattern>%d{yyyy-MM-dd-HH:mm:ss.SSS}------->%level--------->[%thread]-%class:%line----->%msg%n</pattern>

<charset>UTF-8</charset>
</encoder>
</appender>


<appender name="file" class="ch.qos.logback.core.FileAppender">


<file>log/file.log</file>

<append>true</append>
<encoder>

<pattern>%d{yyyy-MM-dd-HH:mm:ss.SSS} %level [%thread]-%class:%line>>%msg%n</pattern>
<charset>UTF-8</charset>
</encoder>

<prudent>false</prudent>
</appender>


<appender name="timeFile" class="ch.qos.logback.core.rolling.RollingFileAppender">

<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

<fileNamePattern>log/logFile%d{yyyy-MM-dd}.log</fileNamePattern>

<maxHistory>30</maxHistory>
</rollingPolicy>

<encoder>
<pattern>%d{yyyy-MM-dd-HH:mm:ss.SSS} %level [%thread]-%class:%line>>%msg%n</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>


<appender name="fixedFile" class="ch.qos.logback.core.rolling.RollingFileAppender">

<file>log/fixedFile.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
<fileNamePattern>log/fixedFile%i.log.zip</fileNamePattern>

<minIndex>1</minIndex>

<maxIndex>3</maxIndex>
</rollingPolicy>


<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">

<maxFileSize>5MB</maxFileSize>
</triggeringPolicy>

<encoder>
<pattern>%d{yyyy-MM-dd-HH:mm:ss.SSS} %level [%thread]-%class:%line>>%msg%n
</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>


<appender name="filter" class="ch.qos.logback.core.FileAppender">
<file>log/filter.log</file>
<append>true</append>

<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>INFO</level>

<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>

<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>INFO</level>
</filter>

<encoder>
<pattern>%d{yyyy-MM-dd-HH:mm:ss.SSS} %level [%thread]-%class:%line>>%msg%n
</pattern>
<charset>UTF-8</charset>
</encoder>
<prudent>false</prudent>
</appender>







<root level="error">

<appender-ref ref="stdout" />

<appender-ref ref="file" />
<appender-ref ref="timeFile" />


</root>

</configuration>