SpringBoot（三）——日志

SpringBoot系列文章

• Spring 注解开发
• SpringBoot（一）——入门
• SpringBoot（二）——配置

1. 日志框架

日志在开发中是必不可少的，目前，项目中使用日志的方式是给项目导入一个日志门面（日志的一个抽象接口），再给项目中导入具体的日志实现就行了，这样，只需要面向接口编程，如果需要改变日志框架的话，只需要改变日志实现，不需要改其他代码。

1.1 市面上的日志框架

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

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

日志门面中最常用的就是SLF4j，JCL和jboss-logging 目前很少使用，SLF4J和Log4j、Logback都是出自同一个人，适配性很好
使用的时候左边选一个日志门面，右边选一个实现，通常选用的是

• 日志门面：SEL4J
• 日志实现：Logback

SpringBoot选用的就是SELF4J和Logback

1.2 SLF4j的使用

开发的时候，日志记录方法的调用，不应该来直接调用日志的实现类中的方法，而是调用日志抽象层里面的方法。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的话，会输出到一个空的位置，因为没有任何实现（左边第一列）
• 左边第二列是正确的用法，slf4j和logback一起使用
• 如果门面使用slf4j，实现使用log4j的话，中间需要加一个适配层，这个适配层上面实现了slf4j，调用的是log4j中的方法。如果使用JUL实现的话，也需要加一个适配层（左边第三列、第四列）。

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

1.3 遗留问题

项目中依赖的框架可能使用不同的日志：
Spring（commons-logging）、Hibernate（jboss-logging）、MyBatis、xxxx
当一个项目使用多种日志框架时，可以统一适配到slf4，中间使用SLF4J或者第三方提供的日志适配器适配到SLF4J，SLF4J在底层用开发者想用的一个日志实现框架来进行日志系统的实现，从而达到了多种日志的统一实现。

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

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

比如一个项目中想要用slf4+logback的方式实现日志系统，但是其他的框架用的是Commons logging、log4j、java.util.logging，可以不导入这两个jar包，而是导入jcl-over-slf4j.jar、log4j-over-slf4j.jar、jul-to-slf4j.jar来替换，这样，其他框架也是使用slf4j+logback的实现方式了。

2. SpringBoot日志关系

每一个启动器中都有一个spring-boot-starter依赖

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

spring-boot-starter中使用spring-boot-starter-logging来做日志功能

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

底层依赖关系

总结：

• SpringBoot底层也是使用slf4j+logback的方式进行日志记录
• SpringBoot也把其他的日志都替换成了slf4j’
• 中间替换包，名字还是和被替换的一样，只不过用的是slf4j的LogFactory
• 如果我们要引入其他框架，一定要把这个框架的默认日志依赖移除掉

1.5.10版本中排除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的方式记录日志，引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉即可；

2.1 日志的使用

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

//创建记录器
Logger logger = LoggerFactory.getLogger(getClass());
/*日志的级别
由低到高：trace<debug<info<warn<error
可以调整输出的日志级别，日志就只会在这个级别以及以后的高级级别生效（输出）
 */
@Test
public void contextLoads() {
   logger.trace("这是trace日志");
   logger.debug("这是debug日志");
   //SpringBoot默认使用的是info级别，也可以自己指定级别，没有指定级别的话就使
    // 用springboot默认使用的级别，也叫root级别
   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

3.3 修改默认配置

#指定日志的级别,也可以指定一个包路径 logging.level.com.xxx=error
logging.level.root=error
#使用logging.file.name不指定路径的话，会在项目下生成指定的日志文件
#指定路径的话，会在指定的路径下生成对应的日志文件
#logging.file.name=G://log//springBoot.log

#会在当前磁盘的根路径下创建spring文件夹和里面的log文件夹，使用spring.log作为默认文件
logging.file.path=/spring/log

#指定在控制台输出的格式
logging.pattern.console=%d{yyy-MM-dd} {%thread} %-5level  %logger{50}  %msg%n

#指定在文件中的输出格式
logging.pattern.file=%d{yyy-MM-dd}==={%thread}===%-5level===%logger{50}===%msg%n

3.4 指定配置

当使用日志的高级功能时，可能需要自己来写日志的配置文件。给类路径下放上每个日志框架自己的配置文件，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">
</springProfile>

<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
  
        <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.5 切换日志实现框架

可以按照1.2中的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，可以将spring-boot-starter-logging依赖换成spring-boot-starter-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>