springboot专题系列九:springboot日志框架篇

989 阅读3分钟

「这是我参与2022首次更文挑战的第25天,活动详情查看:2022首次更文挑战

一、前言

在项目的开发中,日志是必不可少的一个记录事件的组件,所以也会相应的在项目中实现和构建我们所需要的日志框架。而市面上常见的日志框架有很多,比如:JCL、SLF4J、Jboss-logging、jUL、log4j、log4j2、logback等等,我们该如何选择呢?通常情况下,日志是由一个抽象层+实现层的组合来搭建的。

日志-抽象层日志实现层
JCL(Jakarta Commons Logging ) SLF4j(Simple LoggingFacade for Java) jboss-loggingLog4j JUL(java.util.logging)Log4j2 Logback

二、分析

我们先从日志实现分析下手,

  1. JUL(java.util.logger) 直接放弃使用,设计简单,不足以支撑开发应用系统。
  2. Log4j 是非常流行的日志实现,但是目前作者进行了日志升级就是LogBack,作者在官网声明了logback的很多优点比log4j更强大,可参考官网。logback.qos.ch/index.html。
  3. Log4j2 性能强悍,设计过于复杂,很多开源框架不支持,很容易踩坑。不推荐使用,而且logback的性能足以支撑使用。所以我们采用的日志实现是logback。
  4. logback 和log4j的作者是同一个人,属于log4j的升级版,性能更好! ==springboot采用的同样也是SLF4j+logback的日志框架==

三、历史遗留问题

开发框架对应使用的日志框架
springbootslf4j+logback
Springcommons-logging
Hibernatejboss-logging
由于java的开发框架众多,每个框架使用时日志框架又不同,那么我们如何统一日志记录,即使是别的框架和我一起统一使用slf4j进行输出?
在这里插入图片描述

让系统中所有的日志都统一到slf4j的步骤如下:

  1. 将系统中其他日志框架先排除出去;
  2. 用中间包来替换原有的日志框架;
  3. 我们导入slf4j其他的实现

springboot的日志关系

SpringBoot使用它来做日志功能;    
<dependency>    
<groupId>org.springframework.boot</groupId>            
<artifactId>spring‐boot‐starter‐logging</artifactId>            
</dependency> 

底层关系依赖图: 在这里插入图片描述 由关系依赖图可以看出 1)、SpringBoot底层也是使用slf4j+logback的方式进行日志记录 2)、SpringBoot也把其他的日志都替换成了slf4j(使用中间替换包);

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

Spring框架用的是commons-logging:

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

==SpringBoot能自动适配所有的日志,而且底层使用slf4j+logback的方式记录日志,引入其他框架的时候,只需要 把这个框架依赖的日志框架排除掉即可==

四、日志的使用

SpringBoot默认帮我们配置好了日志,我可以直接在src/test包的测试类中写下如下的代码进行测试:

package com.ratel.springboot;

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

@SpringBootTest
class SpringbootLoggerApplicationTests {

	//记录器
	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日志...");


	}
}

在这里插入图片描述 日志输出格式:

			%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修改日志的默认配置:

方法一:在application.yml或者application.properties配置文件直接修改

以application.properties文件修改如下:

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

在这里插入图片描述

方法二:指定配置

给类路径下放上每个日志框架自己的配置文件即可;SpringBoot就不使用他默认配置的了 在这里插入图片描述 比如在如图所示的地方放置: logback.xml:直接就被日志框架识别了; 或 logback-spring.xml:日志框架就不直接加载日志的配置项,由SpringBoot解析日志配置,可以使用SpringBoot 的高级Profile功能(推荐使用)

<springProfile name="staging">
    <!‐‐ configuration to be enabled when the "staging" profile is active ‐‐>
   可以指定某段配置只在某个环境下生效 (dev,test,prod等环境) 
</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>

本文示例代码地址: github.com/Dr-Water/sp…