SpringBoot 与日志框架

最新推荐文章于 2024-02-06 10:40:28 发布

张漂亮’s Blog

最新推荐文章于 2024-02-06 10:40:28 发布

阅读量196

点赞数

分类专栏： Dubbo + Spring Boot 文章标签： spring boot

本文链接：https://blog.csdn.net/zxjdC/article/details/107186118

版权

Dubbo + Spring Boot 专栏收录该内容

19 篇文章 0 订阅

订阅专栏

1、日志框架

类似于JDBC驱动，日志框架也有接口和具体实现，我们通过调用接口API实现功能，按照实际需要给项目中导入具体的日志实现框架的jar包就行了。

市面上的日志框架很多

日志门面（日志的抽象层）	日志实现
~~JCL（Jakarta Commons Logging）~~ SLF4j（Simple Logging Facade for Java） ~~jboss-logging~~	Log4j JUL（java.util.logging） Log4j2 Logback

从左边选一个抽象层、从右边来选一个实现；
SpringBoot：底层是Spring框架，Spring框架默认是用JCL；‘

SpringBoot选用 SLF4j和logback；

2、SLF4j使用

2.1、slf4j用法（slf4j官网链接）：

开发的时候，调用抽象层的方法记录日志（如：调用slf4j 包的接口方法）

1）给系统里面导入slf4j的jar和 logback的实现jar；
2）在系统中 Logger logger = LoggerFactory.getLogge（getClass( ) ）获取对象并记录日志；

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class HelloWorld {
  public static void main(String[] args) {
    Logger logger = LoggerFactory.getLogger(HelloWorld.class);
    logger.info("Hello World");
  }
}

各种日志实现框架到 SLF4j 的jar包的中间转换

有的实现类框架不能直接对接slf4j的jar包，需要导入中间转换包，具体使用情况如下图所示：在这里插入图片描述

每一个日志的实现框架都有自己的配置文件。使用slf4j 抽象层框架后，项目中日志配置文件还是根据日志实现框架自己本身的配置文件来配置；

2.2、遗留问题

当 SpringBoot 整合一些框架时，被整合的框架自身就有自己的日志框架，这些日志框架可能会与 SpringBoot 用的日志框架发生冲突。
如：springBoot（slf4j+logback）、Spring（commons-logging）、Hibernate（jboss-logging）等。
如何让系统中所有的日志都统一到slf4j ？
1）、将系统中其他日志框架先排除出去；

2）、用中间包来替换原有的日志框架；

3）、我们导入slf4j其他的实现
在这里插入图片描述

3、SpringBoot日志关系

在这里插入图片描述
总结：

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

2）、SpringBoot 依赖了中间替换包，也把其他的日志都替换成了slf4j；

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

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的方式记录日志，能自动适配所有的日志，引入其他框架的时候，只需把被引入框架所依赖的日志框架排除掉即可；

4、日志使用；

4.1、默认配置

日志级别

SpringBoot默认帮我们配置好了日志，日志级别从低到高为：trace<debug<info<warn<error。
SpringBoot默认给我们使用的是info级别的，日志会在设置的级别及更高级别生效。

	//记录器
	Logger logger = LoggerFactory.getLogger(getClass());
	@Test
	public void contextLoads() {
		//日志的级别由低到高   trace<debug<info<warn<error
		//可以调整输出的日志级别；日志就只会在这个级别及更高级别生效
		logger.trace("这是trace日志...");
		logger.debug("这是debug日志...");
		//SpringBoot默认给我们使用的是info级别的，没有指定级别的就用SpringBoot默认级别
		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修改日志的默认配置

a. 对指定目录的代码设置日志级别，没有指定的目录日志级别仍然采用默认的值。

#可以对项目中的某个目录设置日志级别（对demo包下的内容设置日志级别为trace）
logging.level.com.example.demo=trace

在这里插入图片描述
b.设置日志文件路径
如果同时指定了logging.path 和 logging.file , logging.file 生效。

# logging.file.name不指定具体路径，只指定日志文件名，则在当前项目下生成springboot.log日志,如果指定了完整的路径，则在指定路径下生成日志文件；
logging.file.name=springboot.log
#logging.file.name=G:/springboot.log

# 在当前磁盘的根路径下创建spring文件夹和里面的log文件夹；使用 spring.log 作为默认文件（注意是根路径，当前项目在 C:/myProject/idea/workspace 目录下，那日志文件会在 C:/spring/log 目录下生成。）
logging.path=/spring/log

在这里插入图片描述

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

如果同时指定了logging.path 和 logging.file , logging.file 生效。

c. 日志格式

#  在控制台输出的日志的格式
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

4.2、指定配置

给类路径下放上每个日志框架自己的配置文件即可；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`

4.2.1 、logback.xml：

可直接被日志框架识别；

4.2.2、logback-spring.xml：

日志框架不直接加载日志的配置项，由SpringBoot解析日志配置，可以使用SpringBoot的高级Profile功能

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

【举例】：
logback-spring.xml 文件配置如下：

<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
		<encoder>
			<charset>UTF-8</charset>
			<springProfile name="dev">
				<pattern>%date{yyyy-MM-dd HH:mm:ss.SSS} === %-5level === [%thread] === [%X{smy.requestFlowNo}|%X{smy.consumerIp}] %logger{56}.%method\(\):%L - %msg%n</pattern>
			</springProfile>
			<springProfile name="prod">
				<pattern>%date{yyyy-MM-dd HH:mm:ss.SSS} >>> %-5level >>> [%thread] >>> [%X{smy.requestFlowNo}|%X{smy.consumerIp}] %logger{56}.%method\(\):%L - %msg%n</pattern>
			</springProfile>
		</encoder>
	</appender>

（1）application.properties 配置如下

logging.level.com=trace
spring.profiles.active=prod

【执行结果日志格式】：
在这里插入图片描述
（2）application.properties 配置如下

logging.level.com=trace
spring.profiles.active=dev

【执行结果日志格式】：
在这里插入图片描述
【注意】：如果使用logback.xml作为日志配置文件，还要使用profile功能，会有以下错误
no applicable action for [springProfile]

5、切换日志框架

可以按照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>