前言

Spring Boot在所有内部日志中使用Commons Logging，同时也提供了对常用日志的支持，如：Logging，Log4J, Log4J2和Logback。可以通过配置使用控制台或者文件输出日志内容。

Logback

SLF4J——Simple Logging Facade For Java，它是一个针对于各类Java日志框架的统一Facade抽象。Java日志框架众多——常用的有java.util.logging, log4j, logback，commons-logging, Spring框架使用的是Jakarta Commons Logging API (JCL)。而SLF4J定义了统一的日志抽象接口，真正的日志实现则是在运行时决定的——它提供了各类日志框架的binding。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class HelloWorld {
  public static void main(String[] args) {
    Logger logger = LoggerFactory.getLogger(HelloWorld.class);
    logger.info("Hello World");
  }
}
image

Logback是log4j框架的作者开发的新一代日志框架，它效率更高、能够适应诸多的运行环境，同时天然支持SLF4J。

默认情况下，Spring Boot会用Logback来记录日志，并用INFO级别输出到控制台。在启动Spring Boot时我们看到的日志便是。

image

日志格式解析如下：

  • 时间日期：精确到毫秒，如2017-04-01 17:19:38.780
  • 日志级别：ERROR, WARN, INFO, DEBUG or TRACE
  • 进程ID，如13692。
  • 分隔符：— 标识后面为日志内容。
  • 线程名：方括号括起来（可能会截断控制台输出），如[main]。
  • Logger名：通常使用源代码的类名日志内容，类名+冒号+日志内容。

日志starter-pom依赖

假如maven依赖中添加了spring-boot-starter-logging：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-logging</artifactId>
    <!--<version>2.1.5.RELEASE</version>-->
</dependency>

其中version默认情况下与springboot的parent一致，可省略。

当引入此依赖，Spring Boot应用将自动使用logback作为应用日志框架，Spring Boot启动的时候，由org.springframework.boot.logging.Logging-Application-Listener根据情况初始化并使用。

实际开发中不需要直接添加该依赖，在其他starter中会间接引入。比如spring-boot-starter便依赖该starter。

控制台输出

日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL。比如，如果设置为WARN，则低于WARN的信息都不会输出。

Spring Boot中默认配置ERROR、WARN和INFO级别的日志输出到控制台。可以通过启动–debug标志来启用“调试”模式。

方式一：

$ java -jar springTest.jar --debug

方式二：
在application.properties中配置debug=true，该属性置为true的时候，核心Logger（包含嵌入式容器、hibernate、spring）会输出更多内容，但是你自己应用的日志并不会输出为DEBUG级别。

文件输出

默认情况下，Spring Boot将日志输出到控制台。可通过在application.properties中设置logging.file或logging.path属性写入到指定日志文件。

  • logging.file：设置文件。绝对路径和相对路径均可。如：logging.file=my.log。默认当前路径下生成日志文件。
  • logging.path：设置目录，默认目录下创建spring.log文件，如：logging.path=/var/log。

二者不能同时使用，如若同时使用，则只有logging.file生效。默认情况下，日志文件的大小达到10MB时会切分一次，产生新的日志文件，默认级别为：ERROR、WARN、INFO

级别控制

所有支持的日志记录系统都可以在Spring环境中设置记录级别（例如在application.properties中）。

格式为：

logging.level.* = LEVEL

其中，logging.level，日志级别控制前缀，*为包名或Logger名。LEVEL：选项TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF。

例如：

logging.level.com.dudu=DEBUG
logging.level.root=WARN

com.dudu包下所有class以DEBUG级别输出，root日志以WARN级别输出。

自定义日志配置

由于日志服务一般都在ApplicationContext创建前就初始化了，它并不是必须通过Spring的配置文件控制。因此通过系统属性和传统的Spring Boot外部配置文件依然可以很好的支持日志控制和管理。

根据不同的日志系统，你可以按如下规则组织配置文件名，就能被正确加载：

  • Logback：logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
  • Log4j：log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
  • Log4j2：log4j2-spring.xml, log4j2.xml
  • JDK (Java Util Logging)：logging.properties

Spring Boot官方推荐优先使用带有-spring的文件名作为你的日志配置（如使用logback-spring.xml，而不是logback.xml），命名为logback-spring.xml的日志配置文件，spring boot可以为它添加一些spring boot特有的配置项。默认的命名规则，并且放在src/main/resources下面即可。

如果你即想完全掌控日志配置，但又不想用logback.xml作为Logback配置的名字，可以通过logging.config属性指定自定义的名字：

logging.config=classpath:logging-config.xml

虽然一般并不需要改变配置文件的名字，但是如果你想针对不同运行时Profile使用不同的日志配置，这个功能会很有用。

下面我们来看看一个普通的logback-spring.xml例子

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

    <!--定义日志文件的存储地址 勿在 LogBack的配置中使用相对路径 -->
    <property name="LOG_HOME" value="/tmp/log" />

    <!-- 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{30} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 按照每天生成日志文件 -->
    <appender name="FILE"
        class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${LOG_HOME}/logs/smsismp.log.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天数 -->
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符 -->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{30} - %msg%n</pattern>
        </encoder>
        <!--日志文件最大的大小 -->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10MB</MaxFileSize>
        </triggeringPolicy>
    </appender>

    <!-- 日志输出级别 -->
    <root level="INFO">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </root>

    <!-- 定义各个包的详细路径，继承root宝的值 -->
    <logger name="com.hry.spring.log" level="INFO" />
    <logger name="com.hry.spring" level="TRACE" />

     <!-- 此值由 application.properties的spring.profiles.active=dev指定-->
    <springProfile name="dev">
        <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径 -->
        <property name="LOG_HOME" value="/tmp/log" />
        <logger name="org.springboot.sample" level="DEBUG" />
    </springProfile>

    <springProfile name="pro">
        <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径 -->
        <property name="LOG_HOME" value="/home" />
        <logger name="org.springboot.sample2" level="INFO" />
    </springProfile>

</configuration>

根节configuration

根节configuration可设置如下属性：

  • scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
  • scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。
  • debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。

contextName上下文名称

每个logger都关联到logger上下文，默认上下文名称为“default”。但可以使用设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改,可以通过%contextName来打印日志上下文名称。

<contextName>logback</contextName>

property设置变量

用来定义变量值的标签，有两个属性，name和value；其中name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。

<!--定义日志文件的存储地址 勿在 LogBack的配置中使用相对路径 -->
<property name="LOG_HOME" value="/tmp/log" />

appender子节点

appender用来格式化日志输出节点，有俩个属性name和class，class用来指定哪种输出策略，常用就是控制台输出策略和文件输出策略。

<!-- 控制台输出 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{30} - %msg%n</pattern>
    </encoder>
</appender>

表示对日志进行编码：

  • %d{HH: mm:ss.SSS}——日志输出时间
  • %thread——输出日志的进程名字，这在Web应用以及异步任务处理中很有用
  • %-5level——日志级别，并且使用5个字符靠左对齐
  • %logger{36}——日志输出者的名字
  • %msg——日志消息
  • %n——平台的换行符

输出到文件RollingFileAppender

另一种日志输出到文件，随着应用的运行时间越来越长，日志也会增长的越来越多，将他们输出到同一个文件并非一个好办法。RollingFileAppender用于切分文件日志。

其中重要的是rollingPolicy的定义，上例中logback.%d{yyyy-MM-dd}.log定义了日志的切分方式——把每一天的日志归档到一个文件中，30表示只保留最近30天的日志，以防止日志填满整个磁盘空间。同理，可以使用%d{yyyy-MM-dd_HH-mm}来定义精确到分的日志切分方式。1GB用来指定日志文件的上限大小，例如设置为1GB的话，那么到了这个值，就会删除旧的日志。

子节点root

root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性。用来设置打印级别，大小写无关：TRACE，DEBUG，INFO，WARN，ERROR，ALL和OFF，不能设置为INHERITED或者同义词NULL，默认是DEBUG。

可以包含零个或多个元素，标识这个appender将会添加到这个loger。

子节点loger

用来设置某一个包或者具体的某一个类的日志打印级别、以及指定。仅有一个name属性，一个可选的level和一个可选的addtivity属性。

  • name:用来指定受此loger约束的某一个包或者具体的某一个类。
  • level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。如果未设置此属性，那么当前loger将会继承上级的级别。
  • addtivity:是否向上级loger传递打印信息。默认是true。

代码中使用logger:

//记录器
Logger logger = LoggerFactory.getLogger(getClass());
@Test
public void contextLoads() {
    //System.out.println();

    //日志的级别；
    //由低到高   trace<debug<info<warn<error
    //可以调整输出的日志级别；日志就只会在这个级别以以后的高级别生效
    logger.trace("这是trace日志...");
    logger.debug("这是debug日志...");
    //SpringBoot默认给我们使用的是info级别的，没有指定级别的就用SpringBoot默认规定的级别；root级别
    logger.info("这是info日志...");
    logger.warn("这是warn日志...");
    logger.error("这是error日志...");
}

中如果没有设置打印级别则继承上级的级别。没有设置addtivity，默认为true。没有设置appender，此loger本身不打印任何信息。

多环境日志输出

据不同环境（prod:生产环境，test:测试环境，dev:开发环境）来定义不同的日志输出，在 logback-spring.xml中使用 springProfile 节点来定义，方法如下：

<!-- 此值由 application.properties的spring.profiles.active=dev指定-->
<springProfile name="dev">
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径 -->
    <property name="LOG_HOME" value="/tmp/log" />
    <logger name="org.springboot.sample" level="DEBUG" />
</springProfile>

<springProfile name="prod">
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径 -->
    <property name="LOG_HOME" value="/home" />
    <logger name="org.springboot.sample2" level="INFO" />
</springProfile>

可以启动服务的时候指定profile（如不指定使用默认），如指定prod的方式为：

java -jar xxx.jar --spring.profiles.active=prod

原文链接：《Spring Boot日志框架系统及配置详解》

关于Spring Boot日志系统源码分析可参看文章：《Spring Boot log日志源码解析》

Spring Boot日志框架系统及配置详解插图2

Spring Boot日志框架系统及配置详解插图3

关注公众号：程序新视界，一个让你软实力、硬技术同步提升的平台

除非注明，否则均为程序新视界原创文章，转载必须以链接形式标明本文链接

本文链接：https://choupangxia.com/2019/10/27/spring-boot-logs/