SpringBoot学习篇2[日志配置]

一 SpringBoot默认日志配置

SpringBoot为Java Util Logging，Log4J2和Logback提供了默认配置。SpringBoot默认配置日志输出到控制台，同时还提供可选文件输出。
SpringBoot默认采用SLF4j（日志抽象层）+ Logback（日志实现）的组合。

1.1 日志输出实战

1. 新创建SpringBoot工程，起名为spring-boot-logging
   
   先直接运行程序，看控制台的输出
   
   可以看到，在不做任何配置的情况下，控制台已经有日志输出了。这也印证了我们前面所说的。

接下来在测试类中使用一下SpringBoot的日志：

package com.yky.springboot;

import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class SpringBootLoggingApplicationTests {

    private Logger logger = LoggerFactory.getLogger(getClass());
    @Test
    void contextLoads() {
        logger.info("这是info级别的日志");
    }

}

注：这里使用的Logger的全类名是org.slf4j.Logger

输出结果

1.2 控制台输出

通过上面的验证，可以得出结论：
SpringBoot的日志记录器，默认情况下在控制台输出以下项目：

• 日期和时间：毫秒精度，易于排序。
• 日志级别：ERROR，WARN，INFO，DEBUG，或TRACE。
• 进程ID。
• 一个—分隔符来区分实际日志消息的开始。
• 线程名称：用方括号括起来（对于控制台输出可能会被截断）。
• 记录器名称：这通常是源类名称（通常缩写）。
• 日志消息。

1.3 文件输出

SpringBoot默认情况下只在控制台输出日志。要想让它输出日志到文件，需要更改其默认配置，此时需要设置logging.file.name或logging.file.path的属性值。

logging.file.name	logging.file.path	示例	描述
null	null		只在控制台输出
给定值	null	my.log	写入指定的日志文件。名称可以是确切位置，也可以是相对于当前目录的位置。
null	给定值	/var/log	写入日志到指定目录，名称可以是确切位置，也可以是相对于当前目录的位置，文件名为springboot.log
给定值	给定值		同时赋值，优先采用logging.file.name

• SpringBoot默认配置单个日志文件大小限定为10M，当单个文件达到所设定的最大大小时，将会产生一个备份文件，并创建一个新的日志文件重新记录当前日志。可以通过更改logging.file.max-size属性更改大小限制。

注意：

• 与控制台输出一样，默认情况下会记录ERROR-level，WARN-level和INFO-level的日志消息。

• 除非logging.file.max-history已设置属性，否则将会无限期存档。

• 日志档案的总大小可以通过设置logging.file.total-size-cap的值来限定。当日志归档的总大小超过该阈值时，将删除备份。要在应用程序启动时强制清除日志存档，请使用logging.file.clean-history-on-start属性。

上面全是在讲理论，接下来实践一下，在resources目录新创建application.yml文件并写入以下内容：

logging:
  file:
    name: /Users/yky/springboot/log/my.log

运行测试程序看一下：

二 常用日志配置的修改

2.1 输出级别

日志记录器包含以下级别（级别由低到高）：

级别	示例	说明
trace	logger.trace(“消息内容”)	跟踪运行信息
debug	logger.debug(“消息内容”)	调试信息
info	logger.info(“消息内容”)	自定义信息
warn	logger.warn(“消息内容”)	警告信息
error	logger.error(“消息内容”)	错误信息

验证一下：

		logger.trace("这是trace级别的日志");
        logger.debug("这是debug级别的日志");
        logger.info("这是info级别的日志");
        logger.warn("这是warn级别的日志");
        logger.error("这是error级别的日志");

控制台输出结果：

日志文件输出结果：

可以看到，无论是控制台还是文件，都只输出了高于等于INFO级别的日志，这是因为SpringBoot默认配置的日志输出级别是INFO级别。若想修改日志输出级别可以通过设置“logging.level.root”属性设置全局日志输出级别，还可以通过设置“logging.level.包名”设置某个包下的日志输出级别。

logging:
  file:
    name: /Users/yky/springboot/log/my.log
  level:
    root: debug

在设置了全局日志输出级别为DEBUG后，可以看到高于等于DEBUG级别的日志被打印了出来：

还可以针对某个包，设置其日志级别，比如设定com.yky.springboot包下的日志记录器的日志输出级别为trace：

logging:
  file:
    name: /Users/yky/springboot/log/my.log
  level:
    root: info
    com.yky.springboot: trace

控制台输出结果：

文件输出结果：

从这里可以看出，当logging.level.root和logging.level.包名 属性同时被设置时，前者不会覆盖掉后者。

2.2 修改日志输出格式

可以通过设置logging.pattern.console和logging.pattern.file分别配置日志输出到控制台以及输出到文件的格式。

logging:
  file:
    name: /Users/yky/springboot/log/my.log
  level:
    com.yky.springboot: trace
    root: info
  pattern:
    console: "%d{yyyy-MM-dd HH:mm:ss.SSS} >>> [%thread] >>> %-5level >>> %logger{50} >>> %msg%n"
    file: "%d{yyyy-MM-dd HH:mm:ss.SSS} --- [%thread] --- %-5level --- %logger{50} --- %msg%n"

• %d{yyyy-MM-dd HH:mm:ss.SSS}——日志输出时间
• %thread——输出日志的进程名字
• %-5level——日志级别，并且使用5个字符靠左对齐
• %logger——日志全类名长度限定为50
• %msg——日志消息
• %n——平台的换行符

控制台输出效果：

文件输出效果 ：

2.3 日志滚动输出

和日志滚动输出有关的属性有下面这几个：

• logging.file.max-size:单个日志文件的最大大小(大于此大小时，保留日志存档，并创建一个新的日志文件)，默认10M
• logging.file.max-history:设置最大存档数，如果不设置此项，则会无限存档(SpringBoot 2.1+默认为7)。
• logging.file.total-size-cap:配置日志的总大小，超过此大小将删除备份

上面的属性介绍完了，接下来实战一下。为了方便看到效果，设置logging.file.max-size为10KB，设置logging.file.max-history为3，并清空之前的日志文件：

logging:
  file:
    name: /Users/yky/springboot/log/my.log
    max-history: 3
    max-size: 10KB
  level:
    com.yky.springboot: trace
    root: info
  pattern:
    console: "%d{yyyy-MM-dd HH:mm:ss.SSS} >>> [%thread] >>> %-5level >>> %logger{50} >>> %msg%n"
    file: "%d{yyyy-MM-dd HH:mm:ss.SSS} --- [%thread] --- %-5level --- %logger{50} --- %msg%n"

运行几次程序后看一下效果:

可以看到，在日志大小达到特定大小时，SpringBoot会将当前存档压缩备份，并新创建一个log文件，重新存储当前日志。

解压一下压缩文件，看一看压缩前的大小，正是我们所期望的(当存储完某一条日志后发现文件大小超出了10KB，此时才触发滚动输出操作，所以在这里看到的大小比10KB大一点点):

2.4 总结

SpringBoot官方文档对日志配置这一块儿给出了很详细的说明：

文档链接：SpringBoot日志配置

三 自定义日志配置

3.1 为什么要自定义日志配置

为什么要用到SpringBoot的自定义日志配置？在开始之前肯定要先搞清楚这一点。
原因很简单：当SpringBoot提供的日志功能满足不了我们的需求时，就需要用到自定义日志配置了（比如高并发环境下，为了尽可能的不让日志拖慢程序运行速度，需要将Logback配置成异步日志记录器）。

3.2 自定义日志配置

SpringBoot支持自定义日志配置，正如官方文档里所说：

如果想要使用自动义配置文件（当使用Logback作为日志实现时），只需要在配置文件目录下给出logback-spring.xml, logback-spring.groovy, logback.xml, or logback.groovy这几个文件中的某一个配置文件即可。

在这里推荐使用logback-spring.xml文件作为自定义配置文件的文件名：因为在使用logback-spring.xxxx时，会先将配置送由SpringBoot进行解析（比如要想支持Profile特殊配置，必须命名为logback-spring.xxxx这种形式），而在使用logback.xml时，配置文件将直接被日志框架加载。使用logback-spring.xxxx将使SpringBoot得到完全控制权。
在resources目录下创建logback-spring.xml并写入以下内容：

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
    <!-- 定义日志的根目录 -->
    <property name="LOG_HOME" value="/Users/yky/springboot/log" />
    <!-- 定义日志文件名称 -->
    <property name="appName" value="my-log"></property>
    <!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <!--
			日志输出格式说明：
				    %d 		输出日期时间
				    %thread 输出当前线程名
				    %-5level  	输出日志级别，左对齐5个字符宽度
				    %logger{50} 输出全类名最长50个字符，超过按照句点分割
				    %msg  	日志信息
				    %n    	换行符
        -->
        <layout class="ch.qos.logback.classic.PatternLayout">
<!--            支持根据不同的环境做选择-->
            <springProfile name="dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
            </springProfile>
            <springProfile name="!dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] >>> [ %-5level ] [ %logger{50} : %line ] >>> %msg%n</pattern>
            </springProfile>
        </layout>
    </appender>

    <!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->  
    <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 指定日志文件的名称 -->
        <file>${LOG_HOME}/${appName}.log</file>
        <!--
        当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名
        TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。
        -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--
				滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}：按天进行日志滚动 
				%i：当文件大小超过maxFileSize时，按照i进行文件滚动
            -->
            <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 
            可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。
			假设设置每天滚动，且maxHistory是365，则只保存最近365天的文件，删除之前的旧文件。
			注意，删除旧文件是，那些为了归档而创建的目录也会被删除。
            -->
            <MaxHistory>365</MaxHistory>
            <!-- 
            当日志文件超过maxFileSize指定的大小是，根据上面提到的%i进行日志文件滚动 注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的，必须配置timeBasedFileNamingAndTriggeringPolicy
            -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 日志输出格式： -->     
        <layout class="ch.qos.logback.classic.PatternLayout">
            <springProfile name="dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
            </springProfile>
            <springProfile name="!dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] >>> [ %-5level ] [ %logger{50} : %line ] >>> %msg%n</pattern>
            </springProfile>
        </layout>
    </appender>

    <!-- 
		logger主要用于存放日志对象，也可以定义日志类型、级别
		name：表示匹配的logger类型前缀，也就是包的前半部分
		level：要记录的日志级别，包括 TRACE < DEBUG < INFO < WARN < ERROR
		additivity：作用在于children-logger是否使用 rootLogger配置的appender进行输出，
		false：表示只用当前logger的appender-ref，true：
		表示当前logger的appender-ref和rootLogger的appender-ref都有效
    -->
    <!-- hibernate logger -->
    <logger name="com.yky" level="debug"/>
    <!-- Spring framework logger -->
    <logger name="org.springframework" level="debug" additivity="false"></logger>


    <!-- 
    root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应，
    要么是定义的logger，要么是root，判断的关键在于找到这个logger，然后判断这个logger的appender和level。 
    -->
    <root level="info">
        <appender-ref ref="stdout" />
        <appender-ref ref="appLogAppender" />
    </root>
</configuration> 

在上面的配置中，还用到了Profile特殊配置。使用Profile特殊配置，可根据不同的环境激活不同的日志配置：

生产环境下的日志输出：

开发环境下的日志输出：

关于SpringBoot的日志配置就写到这里，如果有什么纰漏，欢迎在评论区指出。