Springboot日志篇

一、概述

1.1简介

市场上存在非常多的日志框架。

JUL(java.util.logging),JCL(ApacheCommons Logging),Log4j,Log4j2,Logback、SLF4j、jboss-logging等。

Spring Booti在框架内容部使用JCL,spring-boot-starter--logging采用了slf4j+logback的形式，Spring Boot也能自动适配(jul、log4j2、logback)并简化配置

 虽然日志框架很多，但是我们不用担心，使用SpringBoot的默认配置就能工作的很好。

 1.2SLF4j使用

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

问题

a（slf4j+logback）: Spring（commons-logging）、Hibernate（jboss-logging）、MyBatis、xxxx

统一日志记录，即使是别的框架和我一起统一使用slf4j进行输出？

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

1、将系统中其他日志框架先排除出去；

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

3、我们导入slf4j其他的实现

1.3SpringBoot日志关系

 <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
      <version>2.7.4</version>
      <scope>compile</scope>
    </dependency>
SpringBoot使用它来做日志功能；

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

Spring Boot,怎么把日志默认配置好的
1、每个starter场景，都会导入一个核心场景spring-boot-starter
2、核心场景引入了日志的所用功能spring-boot-starter-logging
3、默认使用了logback+s1f4j组合作为默认底层日志
4、日志是系统一启动就要用，xxxAutoConfiguration是系统启动好了以后放好的组件，后来用的。
5、日志是利用监听器机制配置好的。ApplicationListener。
6、日志所有的配置都可以通过修改配置文件实现

总结：

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

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

3）、中间替换包

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

Spring框架用的是commons-logging；

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

1.4日志的使用

1、默认配置

package com.yanyu.config;

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

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

@SpringBootTest
class SpringbootDataJdbcApplicationTests {    // DI注入数据源
    // 日志记录器
    Logger logger = LoggerFactory.getLogger(getClass());

    @Test
    void contextLoads() {
        // System.out.println();

        // 日志的级别 由低到高
        // 可以调整日志级别，日志就会在该级别以及之后的高级别生效，在application.properties中进行调整
        logger.trace("这是trace日志。。。");
        logger.debug("这是debug日志。。。");
        // Spring Boot 默认使用info级别的日志
        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

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 文件中

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

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>

3.切换日志框架

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

slf4j+log4j的方式；

<!-- 引入Spring Boot的Web启动器依赖 -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
  <!-- 排除logback-classic和log4j-over-slf4j两个依赖项，避免冲突 -->
  <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>

<!-- 引入SLF4J的Log4j12实现依赖 -->
<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-log4j12</artifactId>
</dependency>

切换为log4j2

<!-- 引入Spring Boot的Web启动器依赖 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <!-- 排除spring-boot-starter-logging依赖，避免冲突 -->
    <exclusions>
        <exclusion>
            <artifactId>spring-boot-starter-logging</artifactId>
            <groupId>org.springframework.boot</groupId>
        </exclusion>
    </exclusions>
</dependency>

<!-- 引入Spring Boot的Log4j2启动器依赖 -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

二、日志进阶

2.1日志格式

默认输出格式：

• 时间和日期：毫秒级精度
• 日志级别：ERROR,WARN,INFO,DEBUG,or TRACE
• 进程ID
• ---:消息分割符
• 线程名：使用[]包含
• Logger名：通常是产生日志的类名
• 消息：日志记录的内容

注意：logback没有FATAL级别，对应的是ERROR

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
​​​​​​​​​​@slf4j  
public class HelloController {
    private static final Logger log = LoggerFactory.getLogger(getClass());

    @GetMapping("/h")
    public String hello() {
        log.info("哈哈哈，方法进来了");
        return "hello";
    }
}

2.2日志级别

 相关配置

2.3日志分组 

#精确调整某个包下的日志级别  
#logging.level.com.atguigu.logging.controller=debug  
#logging.level.com.atguigu.logging.service=debug  
#logging.level.com.aaa=debug  
#logging.level.com.bbb=debug  


logging.group.abc=com.atguigu.logging.controller, com.atguigu.logging.service,com.aaa, com. bbb  

logging.level.abc=debug

2.4文件输出

 

2.5归档与切割

• 归档：每天的日志单独存到一个文档中。
• 切割：每个文件10MB,超过大小切割成另外一个文件。

1.每天的日志应该独立分割出来存档。如果使用logback(SpringBoot默认整合)，可以通过
application.properties/yaml文件指定日志滚动规则。
2.如果是其他日志系统，需要自行配置（添加log4j2.Xml或log4j2-spring.xml)
3.支持的滚动规则设置如下

 2.6自定义配置