(四)SpringBoot2.0基础之日志

知其然 知其所以然

创作不易 求点赞👍 求关注❤️ 求分享👥

絮叨

上一篇我们讲了SpringBoot的配置文件，了解了配置文件的加载顺序和配置的原理，这章呢我们呢来看下日志的相关内容，对于一个应用程序来说日志记录是必不可少的一部分。
开发和生产环境中的问题追踪，基于日志的业务逻辑统计分析等都离不日志。目前常用的日志框架包括Log4j 1，Log4j 2，Commons logging，Logback，Jul，Jcl，Slf4j等等一大堆。

正文

日志介绍

要介绍日志啊，我们首先要知道日志的分类：日志门面和日志实现。
日志门面是为日志系统中的一组接口提供一个统一的高层接口，使得子系统更容易使用。简单来说就是我统一一组API，其他日志只要实现我的接口就好。因为各个日志框架的API不是统一的，如果我们更换了日志框架，相应的API也要跟着改变。而有了日志门面好处是API固定，即使换了别的日志框架，只要这个日志框架实现了这个接口，我们就不用修改之前的API。
日志实现是日志门面接口的实现。

日志门面	日志实现
JCL（Jakarta Commons Logging） Jboss-Logging SLF4j（Simple Logging Facade for Java）	Log4j JUL（java.util.logging） Log4j2 Logback

所以入门在使用日志的时候我们最好呢是从左面选一个日志门面。从右面选一个日志实现。比如：SLF4j+log4j，JCL+Logback。
接下来呢，我们介绍下日志的选择。

• JCL：全称为"Jakarta Commons Logging"，也可称为"Apache Commons Logging"。最后一次更新是2014年。Spring框架默认使用此日志门面。
• Slf4j：slf4j只是一个日志标准，并不是日志系统的具体实现。slf4j只做两件事情：提供日志接口和提供获取具体日志对象的方法。
• Jboss-Logging：jboss-logging是一款类似于slf4j的日志门面，他的使用有点复杂，不是给我们普通人用的。

综上原因，日志门面我们选择slf4j。

• Log4j：Log4j是Apache的一个开源项目。log4j写出来的时间比较早，所以当遇到高并发或者日志输出过多情况，可能导致线程阻塞，消耗时间过大。且官方停止更新，并建议从log4j升级到log4j2。
• JUL：JUL是JDK自带的一个日志实现，怕市场被log4j独占，也开发一个日志框架，由于在使用便利性和性能上都欠佳，所以存在感一直不高。
• Logback：和log4j、slf4j是同一个人写的(Ceki Gülcü，俄罗斯程序员。真乃大神啊)，是log4j的升级版。LogBack改进了很多Log4J的缺点，在性能上有了很大的提升，同时使用方式几乎和Log4J一样。因为日志门面我们选了slf4j，而这两个框架是同一个人写的，适配应该会更好，建议选择Logback。SpringBoot默认选用slf4j和logback的组合，可以导入starter-log4j的场景启动器去使用log4j2+slf4j的组合。
• Log4j 2：apache公司借Log4j之名重新写的日志框架。改进了很多Log4J的缺点，同时也借鉴了LogBack，号称在性能上也是完胜LogBack。，但是因为太好了，有很多框架还不支持。

综上原因，日志实现我们选择Logback。（Log4j2也不错，这里只是拿logback举例）

SLF4J+LogBack使用

1. 首先我们要导入slf4j和logback的jar包。logback-classic会帮我们导入logback-core的jar，所以知道入职一个就可以了。scope标签要写compile,如果是test只有在测试环境下才可以使用，而我们是main方法启动不属于测试环境，所以这个包相当于就没有加入依赖。

      <dependency>
          <groupId>ch.qos.logback</groupId>
          <artifactId>logback-classic</artifactId>
          <version>1.2.3</version>
          <scope>compile</scope>
      </dependency>
      <dependency>
          <groupId>org.slf4j</groupId>
          <artifactId>slf4j-api</artifactId>
          <version>1.7.30</version>
      </dependency>
      ```
   

2. 编写测试类。

   import org.slf4j.Logger;
   import org.slf4j.LoggerFactory;
   
   public class LogbackTest {
       private static final Logger logger = LoggerFactory.getLogger(LogbackTest.class);
       public static void main(String[] args) {
           logger.info("hello world");
       }
   }
   

3. 运行查看测试结果。
   
   注意：在我们实际开发使用的时候，调用日志方法的时候，不要使用日志实现去调用，这样就失去了日志门面的意义。而是使用日志门面里面的方法去调用。
   正例：

   import org.slf4j.Logger;
   import org.slf4j.LoggerFactory;
   
   public class LogbackTest {
       private static final Logger logger = LoggerFactory.getLogger(LogbackTest.class);
   }
   

SLF4J搭配其他日志实现

从上面我们知道slf4j是日志门面，可以和日志实现搭配使用。那么它是怎么去适配其他的日志实现的呢。跟着我，我们一探究竟。

我们根据上图去讲解slf4j和各个日志实现的使用。竖着看，每一红框是一类，并且标上了数字。

• ①：如果在我们的程序中我们只导入了slf4j的jar，它会输出到一个空的路径，因为我们没有日志实现。（只有slf4j的jar）
• ②：如果在我们的程序中导入了slf4j的jar，并且导入了logback的日志实现。虽然我们在调用的时候使用的是slf4j，但是因为我们有logback作日志实现。所以日志会记录到控制台或者文件中。（有slf4j和logback的jar）
• ③：如果在我们的程序中导入了slf4j的jar，并且想使用log4j作日志实现，我们要导入一个适配层，也就是slf4j-log4j12.jar。这个jar相当于承上启下，上要去实现slf4j的接口，下日志实现要调用log4j的方法。（有slf4j和log4j和slf4j-log4j12的jar）
• ④：如果在我们的程序中导入了slf4j的jar，并且想使用HUL作日志实现，同log4j一样，我们要导入一个适配层，slf4j-jdk14.jar。作用同③。（有slf4j和log4j和slf4j-jdk14的jar）
• ⑤：如果在我们的程序中导入了slf4j的jar，我们也可以导入slf4j-simple的jar，它是slf4j的简单实现。（有slf4j和slf4j-simple的jar）

总结：如果我们要使用slf4j做日志门面，那么选择不同的日志实现就按照上图所说的去导入相应的jar去实现就好。每一个日志的实现框架都有自己的配置文件。使用slf4j以后，配置文件还是做成日志实现自己本身的配置文件。

统一日志框架

在我们的程序中可能会存在多个日志门面和日志实现，比如，如果我们依赖spring，spring用的日志框架是JUL，如果我们依赖springboot，springboot使用slf4j+logback的组合，如果我们依赖Hibernate，它使用的是jboss-logging等等。
这样我们系统中的日志框架就很杂，不易于管理和日志分析。所以我们可以统一日志框架，其他依赖中的框架也和我们一起统一使用同一个日志框架。那么我们要怎么统一日志框架呢？

• ①：我们首先竖着看，我们的应用程序使用slf4j+logback作为日志的统一框架。之后横着看，我们的应用程序会有很多依赖，而这些依赖可能是用的是commons-logging，log4j，JUL等等。那么我们要怎么统一呢？答案是我们使用替换包，比如commons-logging，我们导入jcl-over-slf4j.jar去替换原来的jar，log4j我们使用log4j-over-slf4j.jar去替换原来的jar等等。（首先要在原依赖中排除掉日志依赖）
  这个替换包为什么能做到呢？因为它包装了原来的commons-logging包，原来的包中有什么类，这个替换包就有相同的类，这样再调用这个包的时候就不会报错（API是一样的）。但是方法中真正的实现是去调用slf4j的API，而slf4j又去调用我们真正的日志框架，这就达到了统一日志框架的目的。
• ②：和①一样，首先竖着看，这次我们使用slf4j作为日志门面，但是日志实现使用的是log4j，但是因为slf4j和log4j不适配，我们还要导入一个适配jar，也就是slf4j-log4j12.jar。之后再横着看，如果我们程序中的依赖使用了commons-logging，我们也是要导入jcl-over-slf4j.jar去替换原来的jar，log4j我们使用log4j-over-slf4j.jar去替换原来的jar等等。（首先要在原依赖中排除掉日志依赖）
• ③：和②一样，不做过多解释了。可以结合之前的SLF4J搭配其他日志实现和②去看。

总结一下想要统一日志框架的步骤：

1. 再pom中排除其他日志依赖
2. 使用替换包去替换原来依赖的日志包
3. 导入我们想要统一后的日志依赖（slf4j+logback）

SpringBoot日志

上面我们介绍了日志的基本概念和基本使用以及日志之间的搭配。接下来我们回归正传，说一下SpringBoot中的日志。
我们首先使用springboot initializr新建一个springboot项目，这里我们只选择一个web模块就好。（如果不会的话，请看我的第三篇文章）

创建好项目后，我们打开pom文件，右键->diagrams->Show dependencies…打开我们的maven依赖。

在这里我们可以看到spring-boot-starter-web依赖了spring-boot-starter，而spring-boot-starter依赖了spring-boot-starter-logging。这个spring-boot-starter-logging就是springboot的日志功能的模块。有了以上的基础再看SpringBoot的日志依赖就很明白了。


根据上图可以知道①SpringBoot默认使用slf4j+logback或log4j2实现日志功能。②因为有转换包，所以SpringBoot把其他的日志都替换成了slf4j的实现。③想统一日志框架的话，就要把其他框架依赖的日志框架排除掉。

日志级别

我们在上面的项目中写以下代码，运行测试类。

package com.springbootlog.springbootlog;

@SpringBootTest
@RunWith(SpringRunner.class)
class SpringbootLog02ApplicationTests {
    Logger logger = LoggerFactory.getLogger(getClass());
    @Test
    void contextLoads() {
        logger.trace("trace");
        logger.debug("debug");
        logger.info("info");
        logger.warn("warn");
        logger.error("error");
    }
}

由上图我们可以知道，当我们不指定日志级别时，SpringBoot默认给我们使用的是info级别。日志的级别由低到高：trace<debug<info<warn<error。
我们可以在application.properties文件中指定日志级别。也可以指定某个包的日志级别。

logging.level.root=trace // 指定日志级别
logging.level.com.springbootlog.springbootlog=error // 指定指定包的日志级别

日志输出格式

# 在控制台输出的日志的格式
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

日志输出格式：
%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.path：在当前磁盘的根路径下创建相应的文件夹；使用 spring.log 作为默认文件。

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

• logging.file：不指定路径在当前项目下生成springboot.log日志，可以指定完整的路径。

  # 不指定路径在当前项目下生成springboot.log日志
  #logging.path=
  # 可以指定完整的路径；
  logging.file=D:/springboot.log
  

• 区别：
  如果我们既不指定logging.file也不指定logging.path，则日志只在控制台输出。
  如果我们指定logging.file它会把日志输出到指定的路径名和文件名中。
  如果我们指定logging.path它会把日志输出到指定的路径的spring.log文件中。

  logging.file	logging.path	Example	Description
  NA	NA		只在控制台输出
  指定文件名	NA	spring.log	输出日志到spring.log文件
  NA	指定目录	/var/log	输出到指定目录的 spring.log 文件中

日志配置

如果我们在类路径下放每个日志框架的自己的配置文件，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

SpringBoot启动的时候会在类路径下扫描这些文件，如果没有找到就使用SpringBoot自己默认的日志配置，如果存在，就是用指定的日志配置。如果文件名字不带-spring的，会被日志框架识别。如果文件名带-spring的，日志框架就不直接加载日志的配置项，而是由SpringBoot解析日志配置，可以使用SpringBoot的高级Profile功能。

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

下面是logback的一些常用配置和解释。

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
    <!-- 定义日志的根目录 -->
    <property name="LOG_HOME" value="/app/log" />
    <!-- 定义日志文件名称 -->
    <property name="appName" value="atguigu-springboot"></property>
    <!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
    <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>

    <!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->  
    <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 指定日志文件的名称 -->
        <file>${LOG_HOME}/${appName}.log</file>
        <!--
        当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名
        TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。
        -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--
            滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}：按天进行日志滚动 
            %i：当文件大小超过maxFileSize时，按照i进行文件滚动
            -->
            <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 
            可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每天滚动，
            且maxHistory是365，则只保存最近365天的文件，删除之前的旧文件。注意，删除旧文件是，
            那些为了归档而创建的目录也会被删除。
            -->
            <MaxHistory>365</MaxHistory>
            <!-- 
            当日志文件超过maxFileSize指定的大小是，根据上面提到的%i进行日志文件滚动 注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的，必须配置timeBasedFileNamingAndTriggeringPolicy
            -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 日志输出格式： -->     
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
        </layout>
    </appender>

    <!-- 
		logger主要用于存放日志对象，也可以定义日志类型、级别
		name：表示匹配的logger类型前缀，也就是包的前半部分
		level：要记录的日志级别，包括 TRACE < DEBUG < INFO < WARN < ERROR
		additivity：作用在于children-logger是否使用 rootLogger配置的appender进行输出，
		false：表示只用当前logger的appender-ref，true：
		表示当前logger的appender-ref和rootLogger的appender-ref都有效
    -->
    <!-- hibernate logger -->
    <logger name="com.atguigu" level="debug" />
    <!-- Spring framework logger -->
    <logger name="org.springframework" level="debug" additivity="false"></logger>
    
    <!-- 
    root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应，
    要么是定义的logger，要么是root，判断的关键在于找到这个logger，然后判断这个logger的appender和level。 
    -->
    <root level="info">
        <appender-ref ref="stdout" />
        <appender-ref ref="appLogAppender" />
    </root>
</configuration> 

总结

本文介绍了各个日志框架以及分类，以及日志的选择，在此基础上介绍了怎么统一日志框架。最后我们有了这些基础，又介绍了SpringBoot中对日志框架的支持。看完这篇，希望能让大家对日志框架有一个大概的理解，以及SpringBoot中的日志支持。

如果本篇博客有任何错误，请批评指教，不胜感激 ！