SpringBoot日志功能

Posted 2020-12-16 MyDistance

三、SpringBoot日志功能

1、日志框架

市面上的日志框架：

JUL、JCL、Jboss-logging、Logback、Log4j、Log4j、SLF4J...

日志门面（日志的抽象层）	日志实现
JCL（Jakarta Commons Logging）SLF4J（Simple Logging Facader for Java）Jboss-logging	Log4j JUL (java.uti.logging) Log4j2 Logback

左边选择一个门面（抽象层），右边选择一个实现：

日志门面：SLF4J;

日志实现：Logback。

SpringBoot : 底层是Spring框架，Spring框架默认是用JCL ; SpringBoot选用SLF4J和logback。

2、SLF4J使用

2.1、如何在系统中使用SLF4J：http://www.slf4j.org/

开发的时候，日志记录方法的调用，不应该·来直接调用日志的实现类，而是调用日志抽象层里面的方法；

需要给系统里面导入SLF4J的jar和logback的实现jar

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以后，配置文件还是做成日志实现框架自己本身的配置文件。

2.2遗留问题

a ( SLF4J + logback ) : Spring ( commons-logging ) 、Hibernate ( jboss-logging ) 、Mybatis、xxx

统一日志记录，即使是别的框架，也能统一使用SLF4J进行输出？

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

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

3、SpringBoot日志关系

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <version>2.3.1.RELEASE</version>
    <scope>compile</scope>
</dependency>

SpringBoot用它来做日志功能：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-logging</artifactId>
    <version>2.3.1.RELEASE</version>
    <scope>compile</scope>
</dependency>

底层依赖关系：

总结：

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

2. SpringBoot把其他的日志都替换成了SLF4J;

3. 中间替换包：

   

4. 如果我们要引入其他框架，一定要把这个框架的默认日志依赖移除掉。（ Spring5默认的抽象层由comons-logging变成SLF4J )。

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

4、日志使用

4.1、默认配置

SpringBoot默认帮我们配好了日志：

    //记录器
    Logger logger = LoggerFactory.getLogger(getClass());

    @Test
    void contextLoads() {
        //日志的级别由低到高：trace<debug<info<warn<error
        //可以调整输出的日志级别，日志就只会在这个级别以后的高级别生效
        logger.trace("trace日志");
        logger.debug("debug日志");
        //SpringBoot默认使用的是info级别的,也成为root级别
        logger.info("info日志");
        logger.warn("warn日志");
        logger.error("error日志");
    }

SpringBoot修改日志的默认配置：

#指定日志的输出级别
logging.level.com.hello=trace

#不指定路径就在当前项目下生成springboot.log日志
#可以指定完整的路径
#logging.file.name=E:/springboot.log
#在当前磁盘的根路径下创建springHello文件夹和里面的log文件夹，使用spring.log作为默认文件
logging.file.path=/springHello/log

#在控制太输出的日志的格式
logging.pattern.console=
#指定文件中日志输出的格式
logging.pattern.file=

4.2、指定配置

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

ogging 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>

<springProfile name="dev | staging">
    <!-- configuration to be enabled when the "dev" or "staging" profiles are active -->
</springProfile>

<springProfile name="!production">
    <!-- configuration to be enabled when the "production" profile is not active -->
</springProfile>