全套SpringBoot2.x入门到项目实战课程系列（第4章 Spring Boot 日志配置）

最新推荐文章于 2020-08-26 22:18:28 发布

Dragon*Wen

最新推荐文章于 2020-08-26 22:18:28 发布

阅读量315

点赞数

分类专栏：全套SpringBoot入门到项目实战课程

本文链接：https://blog.csdn.net/baidu_33267079/article/details/100066136

版权

全套SpringBoot入门到项目实战课程专栏收录该内容

4 篇文章 2 订阅

订阅专栏

全套SpringBoot2.x入门到项目实战课程系列

第4章 Spring Boot 日志配置

第4章 Spring Boot 日志配置

在市场上存在非常多的日志框架:
Spring Boot 采用了 slf4j+logback 的组合形式，Spring Boot也提供对JUL、log4j2、Logback提供了默认配置
Spring官网参考文档:
https://docs.spring.io/spring-boot/docs/2.0.6.RELEASE/reference/htmlsingle/#boot-features-logging

4.1 默认日志配置

SpringBoot默认配置好了日志, 只要启动 Spring Boot 项目就会在控制台输出日志信息。

package com.mengxuegu.springboot;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBoot03LoggingApplicationTests {
	//日志记录器
	Logger logger = LoggerFactory.getLogger(getClass());
	@Test
	public void contextLoads() {
	//1. 以下日志级别，由低到高：trace < debug < info < warn < error
	//2. Spring Boot默认设定的是 info 级别日志，(日志默认级别也称为root级别)。
	// 可修改默认级别日志：logging.level.level=级别名
	//3. 可以进行调整日志级别，设定某个级别后，就只打印设定的这个级别及后面高级别的日志信息
	// 没有指定级别的就用SpringBoot默认规定的级别：root级别
	//4. 可修改指定包的日志级别：
	// 指定某个包下面的所有日志级别：logging.level.包名=级别名
	//跟踪运行信息
	logger.trace("这是 trace 日志信息！");
	//调试信息
	logger.debug("这是 debug 日志信息！");
	//自定义信息
	logger.info("这是 info 日志信息");
	//警告信息：如果运行结果是不预期的值，则可以进行警告
	logger.warn("这是 warn 日志信息");
	//错误信息：出现异常捕获时
	logger.error("这是 error 日志信息");
	}
}

修改日志默认级别

# 调整日志级别： trace < debug < info < warn < error
# com.mengxuegu包下的级别
logging.level.com.mengxuegu=trace
# 设置root级别
logging.level.root=debug

4.2 修改日志默认配置

application.properties 中修改日志默认配置

4.2.1 修改日志文件生成路径

在这里插入图片描述

#输出到当前项目根路径下的 springboot.log 文件中
#logging.file=springboot.log
#输出到当前项目所在磁盘根路径下的 /springboot/log目录中的 spring.log 文件中,
logging.path=springboot/log

4.2.2 修改日志输出的格式

# 日志输出格式说明：
# %d 输出日期时间，
# %thread 输出当前线程名，
# %-5level 输出日志级别，左对齐5个字符宽度
# %logger{50} 输出全类名最长50个字符，超过按照句点分割
# %msg 日志信息
# %n 换行符
# 修改控制台输出的日志格式
logging.pattern.console=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n
# 修改文件中输出的日志格式
logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss.SSS} >>> [%thread] >>> %-5level >>>
%logger{50} >>> %msg%n

4.3 分析日志底层实现

在web项目当中引用了 spring-boot-starter-web 依赖

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

// spring-boot-starter-web 中引入了 spring-boot-starter 启动器
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter</artifactId>
	<version>2.0.6.RELEASE</version>
	<scope>compile</scope>
</dependency>

// spring-boot-starter 中引入了 spring-boot-starter-logging 日志启动器
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-logging</artifactId>
</dependency>

// spring-boot-starter-logging 日志启动器 采用的是 logback 日志框架
<dependency>
	<groupId>ch.qos.logback</groupId>
	<artifactId>logback-classic</artifactId>
	<version>1.2.3</version>
	<scope>compile</scope>
</dependency>

总结：SpringBoot中默认日志启动器为 spring-boot-starter-logging ，默认采用的是 logback
日志框架

在 spring-boot-2.0.6.RELEASE.jar! \org\springframework\boot\logging\logback\base.xml 做了日志的默认配置

<included>
	<!--日志格式默认规定-->
	<include resource="org/springframework/boot/logging/logback/defaults.xml" />
	<!--日志文件默认生成路径-->
	<property name="LOG_FILE"
	value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/spring.log}"/>
	<!--控制台日志信息默认配置-->
	<include resource="org/springframework/boot/logging/logback/consoleappender.
	xml" />
	<!--文件中日志信息默认配置-->
	<include resource="org/springframework/boot/logging/logback/file-appender.xml" />
	<!--日志级别默认为： info -->
	<root level="INFO">
		<appender-ref ref="CONSOLE" />
		<appender-ref ref="FILE" />
	</root>
</included>

日志文件采用方式为：滚动文件追加器
在下面类中会读取上面xml中配置的信息
spring-boot-2.0.6.RELEASE.jar!org.springframework.boot.logging.LoggingSystemProperties
如果spring boot的日志功能无法满足我们的需求(比如异步日志记录等)，我们可以自已定义的日志配置文件。

4.4 自定义日志配置

4.4.1 自定义Logback日志配置

在类路径下，存放对应日志框架的自定义配置文件即可；SpringBoot就不会使用它默认的日志配置文件了。
在 resources 目录下创建 logback.xml ，文件内容如下，SpringBoot就会采用以下日志配置：

<?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="/logs/log" />
	<!-- 定义日志文件名称 -->
	<property name="appName" value="mengxuegu-spring-boot"></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">
			<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} - [%thread] - %-5level - %logger{50} - %msg%n</pattern>
		</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">
			<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
		</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.mengxuegu" 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>

logback.xml ：是直接就被日志框架加载了。
logback-spring.xml：配置项不会被日志框架直接加载，而是由 SpringBoot 解析日志配置文件，进而可以使用SpringBoot 的 Profile 特殊配置

4.4.2 使用 Profile 特殊配置

使用日志 Profille 特殊配置, 可根据不同的环境激活不同的日志配置

将自定义日志配置文件名 logback.xml 改为 logback-spring.xml

修改日志配置文件中第25行，如下：

<springProfile name="dev">
	<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} === [%thread] === %-5level ====%logger{50} - %msg%n</pattern>
</springProfile>
<springProfile name="!dev">
	<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} >>> [%thread] >>> %-5level >>>%logger{50} - %msg%n</pattern>
</springProfile>

指定运行环境： --spring.profiles.active=dev
如果使用 logback.xml 作为日志配置文件，还指定 Profile 特殊配置，则会有以下错误

ERROR in ch.qos.logback.core.joran.spi.Interpreter@28:40 - no applicable action
for [springProfile], current ElementPath is [[configuration][appender][layout]
[springProfile]]
at
org.springframework.boot.logging.logback.LogbackLoggingSystem.loadConfiguration(L
ogbackLoggingSystem.java:169)
…………

4.5 切换日志框架

将SpringBoot默认的 logback 切换为 log4j2 日志框架，参考文档
在项目的 pom.xml 切换log4j2

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-web</artifactId>
	// 先排除 spring-boot-starter-logging 日志启动器
	<exclusions>
		<exclusion>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-logging</artifactId>
		</exclusion>
	</exclusions>
</dependency>
// 再使用 log4j2 日志启动器
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

My GitHub

https://github.com/wenMN1994/SpringBoot

Dragon*Wen

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
1
评论
全套SpringBoot2.x入门到项目实战课程系列（第4章 Spring Boot 日志配置）

全套SpringBoot2.x入门到项目实战课程系列第4章 Spring Boot 日志配置4.1 默认日志配置4.2 修改日志默认配置4.2.1 修改日志文件生成路径4.2.2 修改日志输出的格式4.3 分析日志底层实现4.4 自定义日志配置4.4.1 自定义Logback日志配置4.4.2 使用 Profile 特殊配置4.5 切换日志框架第4章 Spring Boot 日志配置在市场上...
复制链接

扫一扫

专栏目录