SpringBoot入门到精通：（五）SpringBoot整合日志框架

在这里插入图片描述

文章目录

前言
正文

日志框架

框架
SLF4j的使用
其他日志框架转换为slf4j

SpringBoot日志关系
SpringBoot日志配置

默认配置
日志级别
日志格式
SpringBoot修改日志的默认配置
指定配置
切换日志框架

前言

日志在应用开发正是一个非常关键的部分，有经验的工程师能够凭借以往的经验判断出哪里该打印日志，该以何种级别打印日志，这样就能够在线上发生问题的时候快速定位并解决问题，极大的降低应用的运维成本

正文

日志框架

框架

Java中已经有很多成熟的日志的框架，比如

JUL (java.util.logging)
Log4j
Log4j2
Logback

此外还有两个实现日志统一的框架，

JCL (Jakarta Commons Logging)
SLF4j (Simple Logging Facade for Java )

与上述日志框架不同的是，这两个框架只是一个门面，并没有日志框架的具体实现，可以认为是日志接口框架

Spring框架默认使用的是JCL，而SpringBoot对其进行了封装，使用的日志框架是SLF4j

SLF4j的使用

在开发过程中，使用日志我们不应该直接调用日志的直接实现，而是应该使用日志的抽象层的方法，这样当我们想切换日志框架的时候，会更加灵活
SLF4j的使用方式，我们可以在LSLF4j官网查看，官网中给我们提供了一张图片来说明使用方式
在这里插入图片描述
从图中我们可以看出，SLF4j整合logback非常方便，直接将logback的jar包导入即可，但是因为log4j出现的时间还在SLF4j之前，所以并不能适配LOG4j，所以就需要一个适配层，适配层实现SLF4j的方法，调用的是log4j方法；使用JCL同理也需要一个适配器

每一个日志的实现框架都有自己的配置文件。使用slf4j以后，配置文件还是做成日志实现框架自己本身的配置文件；

其他日志框架转换为slf4j

各个框架整合的时候，因为各框架使用的日志框架不同，比如Spring使用commons-logging、Hibernate使用jboss-logging，那么该如何统一日志记录呢？
统一日志记录，即使别的框架和我一起统一使用slf4j进行输出？

slf4j官网也给提供了方法,如下图片
在这里插入图片描述

如何让系统中所有的日志都统一到slf4j

将系统中其他日志框架先排除出去；
用中间包来替换原有的日志框架（中间包替代排除掉的日志框架，和日志框架使用同样的包）；
我们导入slf4j其他的实现

SpringBoot日志关系

新建一个SpringBoot项目，来看一下SpringBoot如何配置日志文件
在这里插入图片描述
我们可以看出，我们引入的spring-boot-starter-web引用了spring-boot-starter，而spring-boot-starter又引用了spring-boot-starter-logging
SpringBoot使用spring-boot-starter-logging来做日志功能；

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

底层依赖关系
在这里插入图片描述

总结：

1. SpringBoot底层也是使用slf4j+logback的方式进行日志记录

2. SpringBoot也把其他的日志都替换成了slf4j；

3. 中间替换包？
在这里插入图片描述
中间替换包和被替换的包从包名到类名完全一样，唯一的是实现不同，是使用slf4j来实现
比如jcl-over-slf4j包是commons.logging，但是在实现的时候确实用的SLF4JLogFactory

@SuppressWarnings("rawtypes")
public abstract class LogFactory {

    static String UNSUPPORTED_OPERATION_IN_JCL_OVER_SLF4J = "http://www.slf4j.org/codes.html#unsupported_operation_in_jcl_over_slf4j";

    static LogFactory logFactory = new SLF4JLogFactory();

4. 如果我们要引入其他框架？一定要把这个框架的默认日志依赖移除掉？

比如Spring框架用的是commons-logging，SpringBoot中进行了排除

		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-core</artifactId>
			<exclusions>
				<exclusion>
					<groupId>commons-logging</groupId>
					<artifactId>commons-logging</artifactId>
				</exclusion>
			</exclusions>
		</dependency>

SpringBoot日志配置

SpringBoot默认帮我们配置好了日志；使用方式如下：

默认配置

SpringBoot的默认日志配置都在defaults.xml中
在这里插入图片描述

日志级别

	//记录器
	Logger logger = LoggerFactory.getLogger(getClass());
	@Test
	public void contextLoads() {	
		logger.trace("这是trace日志...");
		logger.debug("这是debug日志...");
		logger.info("这是info日志...");
		logger.warn("这是warn日志...");
		logger.error("这是error日志...");
	}

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

日志格式

    日志输出格式：
		%d表示日期时间，
		%thread表示线程名，
		%-5level：级别从左显示5个字符宽度
		%logger{50} 表示logger名字最长50个字符，否则按照句点分割。 
		%msg：日志消息，
		%n是换行符

    %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n

SpringBoot修改日志的默认配置

logging.level.com.atguigu=trace


#logging.path=
# 不指定路径在当前项目下生成springboot.log日志
# 可以指定完整的路径；
#logging.file=G:/springboot.log

# 在当前磁盘的根路径下创建spring文件夹和里面的log文件夹；使用 spring.log 作为默认文件
logging.path=/spring/log

#  在控制台输出的日志的格式
logging.pattern.console=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n
# 指定文件中日志输出的格式
logging.pattern.file=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n

logging.file	logging.path	Example	Description
(none)	(none)		只在控制台输出
指定文件名	(none)	my.log	输出日志到my.log文件
(none)	指定目录	/var/log	输出到指定目录的 spring.log 文件中

指定配置

给类路径下放上每个日志框架自己的配置文件即可；SpringBoot就不使用他默认配置的了

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`

logback.xml：直接就被日志框架识别了；

logback-spring.xml：日志框架就不直接加载日志的配置项，由SpringBoot解析日志配置，可以使用SpringBoot的高级Profile功能

<springProfile name="staging">
    <!-- configuration to be enabled when the "staging" profile is active -->
  	可以指定某段配置只在某个环境下生效
</springProfile>

如：

<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <!--
        日志输出格式：
			%d表示日期时间，
			%thread表示线程名，
			%-5level：级别从左显示5个字符宽度
			%logger{50} 表示logger名字最长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} - %msg%n</pattern>
            </springProfile>
            <springProfile name="!dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern>
            </springProfile>
        </layout>
    </appender>

如果使用logback.xml作为日志配置文件，还要使用profile功能，会有以下错误

no applicable action for [springProfile]

切换日志框架

可以按照slf4j的日志适配图，进行相关的切换；

slf4j+log4j的方式；

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
  <exclusions>
    <exclusion>
      <artifactId>logback-classic</artifactId>
      <groupId>ch.qos.logback</groupId>
    </exclusion>
    <exclusion>
      <artifactId>log4j-over-slf4j</artifactId>
      <groupId>org.slf4j</groupId>
    </exclusion>
  </exclusions>
</dependency>

<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-log4j12</artifactId>
</dependency>

切换为log4j2

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

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

一条有梦想的咸鱼$

发布了40 篇原创文章 · 获赞 9 · 访问量 2万+

私信关注