Spring Boot 学习笔记(5)：日志配置

官方文档：

Spring Boot使用Commons Logging进行所有内部日志记录，但保留底层日志实现。为Java Util Logging，Log4J2和 Logback提供了默认配置 。在不同情况下，记录器都预先配置为使用控制台输出，并且还提供可选的文件输出。

默认情况下，如果使用“Starters”，则使用Logback进行日志记录。还包括适当的Logback路由，以确保使用Java Util Logging，Commons Logging，Log4J或SLF4J的依赖库都能正常工作。

日志格式

Spring Boot的默认日志输出类似于以下示例：

2014-03-05 10：57：51.112 INFO 45469 --- [main] org.apache.catalina.core.StandardEngine：启动Servlet引擎：Apache Tomcat / 7.0.52 
2014-03-05 10：57：51.253 INFO 45469 --- [ost-startStop-1] oaccC [Tomcat]。[localhost]。[/]：初始化Spring embedded WebApplicationContext 
2014-03-05 10：57：51.253 INFO 45469 --- [ost-startStop-1] osweb .context.ContextLoader：Root WebApplicationContext：初始化完成时间为1358 ms 
2014-03-05 10：57：51.698 INFO 45469 --- [ost-startStop-1] osbceServletRegistrationBean：映射servlet：'dispatcherServlet'到[/] 
2014-03 -05 10：57：51.702 INFO 45469 --- [ost-startStop-1] osbcembedded.FilterRegistrationBean：映射过滤器：'hiddenHttpMethodFilter'为：[/ *]

Logback是没有FATAL级别的日志，它将被映射到ERROR

• 时间日期：精确到毫秒,可以用于排序
• 日志级别：ERROR、WARN、INFO、DEBUG、TRACE
• 进程ID
• 分隔符：采用 --- 来标识日志开始部分
• 线程名：方括号括起来（可能会截断控制台输出）
• Logger名：通常使用源代码的类名
• 日志内容：我们输出的消息

控制台输出

日志级别从低到高分为：

TRACE < DEBUG < INFO < WARN < ERROR < FATAL。

如果设置为WARN ，则低于WARN的信息都不会输出。

Spring Boot中默认配置ERROR、WARN和INFO级别的日志输出到控制台。

您还可以通过启动您的应用程序 --debug 标志来启用“调试”模式（开发的时候推荐开启）,以下两种方式皆可：

在运行命令后加入--debug标志，如：$ java -jar springTest.jar --debug，这种命令会被 SpringBoot 解析，且优先级最高

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

启用调试模式时，将配置一些核心记录器(嵌入式容器、 Hibernate 和 Spring Boot)来输出更多的信息。 启用调试模式不会将应用程序配置为以 DEBUG 级别登录所有消息。

或者，你也可以通过使用 --trace标志（或application.properties中的trace=true）启用“trace”模式。这样做可以为选择的核心记录器进行跟踪日志记录（嵌入式容器，Hibernate数据库生成和整个Spring 组合）。

彩色编码输出

如果你的终端支持ANSI，颜色输出用于帮助可读性。你可以在配置 文件中设置spring.output.ansi.enabled 来改变。
比如：

spring.output.ansi.enabled=always

• ALWAYS： 启用 ANSI 颜色的输出。
• DETECT： 尝试检测 ANSI 着色功能是否可用。
• NEVER： 禁用 ANSI 颜色的输出。

颜色编码是通过使用% clr 转换字来配置的。 在最简单的形式中，转换器根据日志级别对输出进行颜色设置，如下面的示例所示:

%clr(%5p)

下表描述了将日志级别映射为颜色的情况:

Level	color
FATAL	Red
ERROR	Red
WARN	Yellow
INFO	Green
DEBUG	Green
TRACE	Green

或者，你可以指定应该使用的颜色或样式，将其作为转换的选项。例如，为了使文本黄色，使用下
面的设置:

%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){yellow}

支持以下颜色和风格:

• blue
• cyan
• faint
• green
• magenta
• red
• yellow

文件输出

默认情况下，Spring Boot 只会将日志记录到控制台上，而不会写日志文件。 如果你希望除了控制台输出之外编写日志文件，你需要设置一个logging.file件或 logging.path 属性(例如在你的application.properties)。

logging.file	logging.path	Example	Description
none	none		控制台只记录日志
特定文件	none	my.log	写入指定的日志文件。名字可以是工作目录的确切位置或相对位置
noen	特定目录	/var/log	写入spring.log到指定的目录。名字可以是工作目录的确切位置或相对位置

日志文件在达到 10MB 时进行切割，与控制台输出一样，产生一个新的日志文件（如：spring.1.log、spring.2.log），新的日志依旧输出到 spring.log 中去，默认情况下会记录 ERROR、WARN、INFO 级别消息。

你可以通过设置logging.file.max大小的属性来改变日志文件的大小限制。以前切割的文件会被无限期存档，除非已经设置了logging.file.max历史属性

注：logging.file和logging.path二者不能同时使用，如若同时使用，则只有logging.file生效

日志系统是在应用程序生命周期的早期初始化的。 因此，在通过@propertysource 注释加载的属性文件中找不到日志属性。

日志记录属性独立于实际的日志基础结构。 因此，spring Boot 不管理特定的配置键(如 Logback.configurationFile for Logback)。

日志输出级别

所有支持的日志记录系统可以通过使用logging.level.<包名或Logger名>=<日志级别>在Spring环境中设置日志记录器级别（例如，在application.properties中），其级别可以是TRACE、DEBUG、INFO、WARN、ERROR、FATAL或OFF任意一个。root记录器可以通过使用logging.level.root进行配置。

下面的示例显示了在application.properties中配置。

logging.level.root=WARN
logging.level.org.springframework.web=DEBUG
logging.level.org.hibernate=ERROR

自定义日志配置

你可以使用org.springframework.boot.logging.LoggingSystem系统属性强制Spring Boot使用特定的日志记录系统。 该值应该是LoggingSystem实现的完全限定类名。 您还可以使用none值完全禁用Spring Boot的日志记录配置。

因为日志记录是在创建ApplicationContext之前初始化的，所以无法控制Spring@Configuration文件中的@PropertySources的日志记录。更改日志记录系统或完全禁用日志记录的唯一方法是通过系统属性。

根据你的日志记录系统，将加载以下文件：

Logging System	Customization
Logback	logback-spring.xml, logback-spring.groovy, logback.xml, or logback.groovy
Log4j2	log4j2-spring.xml or log4j2.xml
JDK (Java Util Logging)	logging.properties

在可能的情况下，我们建议你使用 -spring来进行日志配置(例如：logback-spring.xml而不是logback.xml)。如果使用logback.xml，Spring无法完全控制日志初始化。

为了帮助进行自定义，Spring环境将一些其他属性转移到System属性，如下表所述：

Spring Environment	System Property	Comments
logging.exception-conversion-word	LOG_EXCEPTION_CONVERSION_WORD	记录异常时使用的转换词。
logging.file	LOG_FILE	将日志写入到指定的文件中，默认为相对路径，可以设置成绝对路径
logging.file.max-size	LOG_FILE_MAX_SIZE	最大日志文件大小(如果启用了日志文件)。 (只支持默认的 Logback 设置。)
logging.file.max-history	LOG_FILE_MAX_HISTORY	需要保存的存档日志文件的最大数量(如果启用了日志文件)。 (只支持默认的 Logback 设置。)
logging.path	LOG_PATH	将名为 spring.log 写入到指定的 文件夹 中，如（/var/log）
logging.pattern.console	CONSOLE_LOG_PATTERN	在控制台上使用的日志模式(stdout)。 (只支持默认的 Logback 设置。)
logging.pattern.dateformat	LOG_DATEFORMAT_PATTERN	设置日志输出日期格式(只支持默认的 Logback 设置。)
logging.pattern.file	FILE_LOG_PATTERN	定义输出到日志文件的日志格式
logging.pattern.level	LOG_LEVEL_PATTERN	绘制日志级别时使用的格式
PID	PID	当前的进程ID

如果你想在日志属性中使用占位符，则应使用 Spring Boot 的语法，而不是基础框架的语法。 值得注意的是，如果使用Logback，你应该使用 : 作为属性名和其默认值之间的分隔符，而不是使用 :-。

Logback扩展配置

Spring Boot 包含了一些 Logback 扩展，这些扩展可以帮助提高配置。 您可以在 logback-spring.xml 配置文件中使用这些扩展。
由于标准logback.xml配置文件过早加载，所以不能在其中使用扩展。您需要使用logback- spring.xml，或者定义一个loggingconfig属性。

扩展配置不能与Logback的配置扫描一起使用。 如果尝试这样做，对配置文件进行更改会导致类似以下记录之一的错误：

ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:71 - no applicable action for [springProperty], current ElementPath is [[configuration][springProperty]]
ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:71 - no applicable action for [springProfile], current ElementPath is [[configuration][springProfile]]

springProperty

<springProfile> 标签使我们让配置文件更加灵活，它可以选择性的包含或排除部分配置。

<springProfile name="dev">
    <!-- 开发环境时激活 -->
</springProfile>

<springProfile name="dev,test">
    <!-- 开发，测试的时候激活，多个环境用逗号隔开-->
</springProfile>

<springProfile name="!prod">
    <!-- 当 "生产" 环境时，该配置不激活-->
</springProfile>

例子：

    <!-- 测试环境+开发环境. 多个使用逗号隔开. -->
    <springProfile name="test,dev">
        <logger name="com.example.demo.controller" level="DEBUG" additivity="false">
            <appender-ref ref="consoleLog"/>
        </logger>
    </springProfile>

    <!-- 生产环境. -->
    <springProfile name="prod">
        <logger name="com.example.demo.controller" level="INFO" additivity="false">
            <appender-ref ref="consoleLog"/>
        </logger>
    </springProfile>

后端一枚，默默搬砖撸代码，如果觉得不错欢迎关注我的公众号

image