title: Spring Boot日志
catalog: true
date: 2019-09-23 13:35:41
subtitle: SpringBoot日志
header-img: “/img/article_header/article_header.png”
tags: Spring Boot
catagories:

SpringBoot

一.日志框架

市面上的日志框架；

JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j…

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

左边选一个门面（抽象层）、右边来选一个实现；

日志门面： SLF4J；

日志实现：Logback；

SpringBoot：底层是Spring框架，Spring框架默认是JCL

SpringBoot选用的是SLF4J和logback

二.SLF4J使用

1.如何在系统中使用SLF4j

日志记录方法不应该直接调用日志的实现类，二十调用日志抽象层里面的方法；

给系统导入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.遗留的问题

在同一个系统中存在多个日志框架：

项目A（SLF4j+logback）:Spring（commons-logging）、Hibernate(jboss-logging)、MyBatis等等

我们可以统一日志记录，即使是别的框架，也可以使用SLF4j进行输出。

在这里插入图片描述

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

将系统中其他日志文件先排除出去
用中间包替换原有的的日志框架
我们导入SLF4j其他实现

三.SpringBoot日志关系

日志相关最基本的依赖：

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

SpringBoot使用它来做日志功能：

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

底层依赖关系：

在这里插入图片描述

总结:

SpringBoot底层也是使用了SLF4j+logback的方式进行日志记录
SpringBoot也把其他日志替换成了SLF4j
使用中间替换包替换了原有的日志框架
如果我们要引入其他框架，一定要把这个框架默认日志移除掉。

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

四.日志的使用

1.默认配置

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

// 记录器
Logger logger = LoggerFactory.getLogger(getClass());
@Test
public void contextLoads() {

// 日志的级别
// 日志由高到低 trace<debug<info<warn<error
// 可以调整输出的日志级别，日志就只会在这个级别
logger.trace("这是trace日志。。。。");
logger.debug("这是debug日志。。。");
// SpringBoot默认给我们使用的是info级别，没有指定级别的就用SpringBoot默认规定的级别，root级别
logger.info("这是info日志。。。");
logger.warn("这是warn日志。。");
logger.error("这是errorr日志");

}

日志文件输出格式：

日志输出格式：

%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.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>