SpringBoot——日志

SpringBoot——日志

一、日志框架

  有一个程序猿叫小张，他独立开发一个大型系统，每次调试，都喜欢在控制台打印关键数据System.out.println()。每次运行都会输出很多数据记录，为了避免这些数据的输出，他决定写一个框架用来记录这些数据运行时的信息。于是创建了一个日志框架：zhanglog,jar。
但随着业务的发展，小张的日志框架需要提供其他额外的功能，比如异步模式，自动归档等
  于是他模仿了JDBC——数据库驱动：写了一个统一的接口层，日志门面（日志的一个抽象层）;logging-abstract.jar给项目中导入具体的日志实现就可以了；我们之前的日志框架都是实现这个日志抽象层。

市面上的日志框架
JUL、JCL、log4j、log4j2等

日志门面（日志的抽象层）	日志实现
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使用

2.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.2 遗留问题

A系统（slf4j+logback) : Spring（common-logging）、MyBatis、Hibernate、xxxx
统一日志记录，即使是别的框架也要一起使用slf4j进行输出。

如何让系统中所有的日志都统一到slf4j:
① 将系统中其他日志框架先排除出去
② 用中间包替换原来的日志框架
③ 我们导入slf4j其他的实现

三、SpringBoot中的日志关系

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

SpringBoot使用它来做日志功能。

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

底层依赖关系

总结：
  1）SpringBoot底层也是使用slf4j+logback的方式进行日志记录
  2）SpringBoot也把其他的日志框架都替换成了slf4j
  3）如果我们引入其他框架？一定要把这个框架的默认日志依赖移除掉。Spring框架用的是commons-logging

四、日志使用

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

@Test
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("这是error日志");
}

设定日志级别为trace级别。

2019-03-05 10:57:51.112  INFO 45469 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet Engine: Apache Tomcat/7.0.52
2019-03-05 10:57:51.253  INFO 45469 --- [ost-startStop-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2019-03-05 10:57:51.253  INFO 45469 --- [ost-startStop-1] o.s.web.context.ContextLoader            : Root WebApplicationContext: initialization completed in 1358 ms
2019-03-05 10:57:51.698  INFO 45469 --- [ost-startStop-1] o.s.b.c.e.ServletRegistrationBean        : Mapping servlet: 'dispatcherServlet' to [/]
2019-03-05 10:57:51.702  INFO 45469 --- [ost-startStop-1] o.s.b.c.embedded.FilterRegistrationBean  : Mapping filter: 'hiddenHttpMethodFilter' to: [/*]

The following items are output:

• Date and Time: Millisecond precision and easily sortable.
• Log Level: ERROR, WARN, INFO, DEBUG, or TRACE.
• Process ID.
• A --- separator to distinguish the start of actual log messages.
• Thread name: Enclosed in square brackets (may be truncated for console output).
• Logger name: This is usually the source class name (often abbreviated).
• The log message.

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的高级功能。可以使用Spring 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>

五、切换日志框架

可以按照slf4j的日志适配图，进行相关的切换：
slf4j + log4j的方式

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