SpringBoot 日志系統

日志框架

開發一個大型系統的簡易步驟:

1.  system.out.println("..") 將關鍵的數據在控制台輸出
2. 框架記錄系統的一些運行時的信息，---日志框架。
3. 牛逼的功能---異步模式，自動歸檔等等。。。
4. 進一步發展，卸掉舊得框架，並且修改之前的API，
5. JDBC 數據庫驅動，JDC 數據庫驅動：

　　　　　　 寫一個統一的接口層: 日志門面，(日志的一個抽象層)

　　　　　　 給項目導入具體的日志實現，之前的框架都是實現的抽象層

主流的日志框架

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

Springboot ：底層是Spring框架，Spring 默認框架是JCL，

SLF4J使用

1 ，如何在 系統中使用SLF4J  https://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 之后 ，配置文件還是做成日志實現框架自己的本身的配置文件。

 遺留問題: 

開發的時候，

A 系統: 可能會用到  （slf4j+logback）: Spring（commons-logging默認）、Hibernate（默認:jboss-logging）、MyBatis、xxxx

 如何統一 日志記錄？ 即使用別的框架，也統一使用 slf4j 進行輸出

 　　　　　　　　　　　　　　　　slf4j  日志適配圖

如何實現系統所有日志統一到slf4j ：

1. 將系統中所有的其他日志框架先排除出去
2. 用中間包來替換原有的日志框架
3. 導入slf4j 的其他實現jar 

springboot的日志關系

如果使用IDEA ，那么idea 有個很好的工具可以讓我們可視化的查看依賴關系，在pom.xml 中右鍵選擇diagrams ---show dependencies 就可以查看

啟動器:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
</dependency>

 springboot 使用的日志功能組件:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-logging</artifactId>
</dependency>

 底層依賴關系:

歸納：

1. SpringBoot底層也是使用slf4j+logback的方式進行日志記錄
2. SpringBoot也把其他的日志都替換成了slf4j；
3. 中間替換包？

@SuppressWarnings("rawtypes")
public abstract class LogFactory {

    static String UNSUPPORTED_OPERATION_IN_JCL_OVER_SLF4J = "http://www.slf4j.org/codes.html#unsupported_operation_in_jcl_over_slf4j";

    static LogFactory logFactory = new SLF4JLogFactory();

 

  如果我們要引入其他框架，一定要把這個框架的默認日志依賴移除掉。

　　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的方式記錄日志，引入其他框架的時候，只需要把這個框架依賴的日志框架排除掉即可

 SringBoot默認配置

SpringBoot默認幫我們配置好了日志；

    //記錄器
    Logger logger = LoggerFactory.getLogger(getClass());
    @Test
    public void contextLoads() {
        //System.out.println();
        //日志的級別；
        //由低到高   trace<debug<info<warn<error
        //可以調整輸出的日志級別；日志就只會在這個級別以以后的高級別生效
        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

 SpringBoot修改日志的默認配置

#設置日志的默認輸出級別
logging.level.com.atguigu=trace  
#logging.path=
# 不指定路徑在當前項目下生成springboot.log日志
# 可以指定完整的路徑；
#logging.file=G:/springboot.log

# 在當前磁盤的根路徑下創建spring文件夾和里面的log文件夾；使用 spring.log 作為默認文件
logging.path=/spring/log

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

 

logging.file	logging.path	Example	Description
(none)	(none)		只在控制台輸出
指定文件名	(none)	my.log	輸出日志到my.log文件
(none)	指定目錄	/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

 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>

 

如果使用logback.xml 作為配置文件，還要使用profile 功能會報 no applicable action for [springProfile] 的錯誤

日志框架的切換

可以按照上面的 slf4j 的日志適配圖，進行相關的切換：

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 ：

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