Spring Boot與日志

1、日志框架

故事：有一個開發人員，開發一個大型系統；

遇到重要數據，喜歡System.out.println("")，將關鍵數據打印在控制台

去掉？寫在一個文件？方便？

框架來記錄系統的一些運行時信息，日志框架：first.jar

高大上的幾個功能？異步模式？自動規定？等等？：second.jar

將以前的框架卸下來？換上新的框架，更新修改之前相關API：third.jar

JDBC---數據庫驅動：

• 寫了一個統一的接口層：暫時叫做日志門面（日志的一個抽象層）：fourth.jar
• 給項目中導入具體的日志實現就行了，我們之前的日志框架都是實現的抽象層

2、市面上的日志框架

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

2.1 下表行間無任何對應關系

日志門面	日志實現
JCL( Jakarta Commons Logging)	Log4j
SLF4j( Simple Logging Facade for Java)	JUL( java. util.logging)
jboss-logging	Log4j2
	Logback

左邊選一個門面（抽象層）、右邊選一個實現

選哪個呢？排除法

2.2 日志門面：slf4j

Jboss-logging：普通程序員用不了

JCL：最后一次更新是在2014年，廉頗老矣，尚能飯否？

剩下slf4j理所應當

2.3 日志實現：logback

log4j、logback和slf4j都是一個人寫的，適配性好，log4j不錯但有性能問題，但升級消耗太大，就重寫了logback

所有log4j沒有logback先進，JUL是Java自帶的，怕日志市場被占，比較簡略

log4j2是借log4j之名，由Apache公司重新做的框架，設計地非常好，由於太好還沒適配

2.4 Spring Boot怎么做的呢？

Spring框架默認是用JCL日志框架

Spring Boot選用slf4j和logback

3、slf4j的使用

如何在系統中使用slf4j？官方文檔

• 以后開發的時候，日志記錄方法得調用，不應該來直接調用日志的實現類，而是調用日志抽象層里面的方法

• 參見用戶手冊SLF4J user manual給系統中導入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");
  }
}

雖然默認用的是logback的實現，如果想要其他實現也可以，畢竟slf4j是抽象層，實現用什么都行

圖解

• 如果系統中只導入了slf4j，我們要進行日志記錄，就會返回空值，因為沒有任何實現

• 正確用法：我的應用程序面向slf4j編程，調用它的方法進行日志記錄，在程序中也導入日志實現，雖然調用slf4j接口，但logback會實現，記錄到文件或控制台

• 如果slf4j要綁定log4j，log4j出現比較早，沒想到要適配slf4j，所以兩者綁定要有一個適配層（slf4j實現的），適配層相當於上面實現了slf4j的具體方法，而在方法里面要進行真正日志記錄的時候，又調了log4j的API，要用log4j還要導入適配層即可
  JUL同理

• slf4j也有簡單日志實現也能用，或者slf4j沒有什么操作的實現包，也是輸出空值

• 每一個日志的實現框架都有自己的配置文件，使用slf4j以后，配置文件還是做成日志實現框架自己本身的配置文件

• slf4j只提供抽象層，用哪個實現就寫那個的配置文件

4、遺留問題

開發某個系統時：使用{slf4j+logback}，依賴Spring框架（commons-logging），依賴Hibernate框架（Jboss-logging），依賴MyBatis框架等等可能一大堆

出現什么問題，系統中日志雜交？

現在就要做同一日志記錄，即使是別的框架和我一起使用slf4j進行輸出？

進入slf4j官方文檔的legacy APIs

統一slf4j，使用其他包替換原有日志框架，替換的意思就是，例如要把原框架里面對Commons-logging的依賴排除掉

但如果我現在用的Spring框架缺少Commons-logging就運行不起來了，Spring底層記錄日志就需要Commons-logging，那怎么辦呢？就用jcl-over-slf4j.jar替換這個包，Spring要用的類這個替換包例還是有的，就不會報錯了

但新的包實現怎么辦呢？新的包調入slf4j，二slf4j又調到真正的實現中，其他框架不同日志框架同理替換

其他組合方式也是如此

如何讓系統中所有的日志都同一到slf4j：

• 將系統中其他日志框架先排除去；
• 用中間包來替換原有的日志框架
• 我們導入slf4j其他的實現

5、Spring Boot日志關系

每個啟動器（場景）都要依賴的

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

Spring Boot使用它來做日志功能

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

依賴圖示：

總結：

• Spring Boot底層也是使用slf4j+logback的方式進行日志記錄

• Spring Boot也是把其他的日志都替換成了slf4j

• 中間替換包，以jcl-over-slf4j.jar為例：

  在項目的依賴包中找到其對應jar包：（中間轉換包）

  

• 從圖中看出，雖然包名用的Apache的，但實現卻是使用的SLF4JLogFactory()的日志工廠

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

Spring Boot能自動適配所有的日志，而且底層使用slf4j+logback的方式記錄日志，我們唯一需要做的是，引入其他框架的時候，只需要把這個框架依賴的日志框架排除掉。

6、日志使用

6.1 默認配置

當我們初始化項目運行后，自己沒有配置日志，但控制台是由輸出信息的

Spring Boot默認幫我們配置好了日志，直接使用就可以了

// LoggerFactory是記錄器工廠，記錄器
Logger logger = LoggerFactory.getLogger(getClass());

@Test
public void testLog() {
  /**
    * 日志的級別
    * 由低到高：trace<debug<info<waring<error
    * 可以調整輸出的日志級別
    * 只打印高級別即以后（更高級別）的信息
    */
  logger.trace("這是跟蹤軌跡日志...trace...");
  logger.debug("這是調試日志...debug");
  /**
    * Spring Boot默認使用的是info級別的，輸出info級別即以后的內容
    * 沒有指定級別的就用Spring Boot默認規定的級別（root級別）
    */
  logger.info("這是信息日志...info...");
  logger.warn("這是警告信息...warning...");
  logger.error("這是錯誤信息日志，異常捕獲...error...");
  // 也可以通過配置文件修改級別
}

日志的輸出格式

• %d：表示時間
• %thread：表示線程名
• %-5level：級別從左顯示5個字符寬度
• %logger{50}：表示logger名字最長50個字符，否則按照句點分割
• %msg：日志消息
• %n：換行

# trace及以后的級別生效
logging.level.com.initializr=trace

# 生成springboot日志文件
# 可以用決定路徑
# 如果不指定路徑，就在當前項目下生成
logging.file=springboot.log

# 使用logging.path可以不使用logging.file，使用spring.log默認文件
# 在當前磁盤的根路徑下創建文件夾，並生成日志文件
#logging.path=/spring/log

# 在控制台輸出的日志的格式
logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
# 指定文件中輸出的日志的格式
logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss} === [%thread] === %-5level %logger{50} === %msg%n

6.2 自定義日志、指定配置

可從官方文檔-日志參見第26.5條Custom log configuration

給類路徑下放上每個日志框架自己的配置文件即可，Spring Boot就不使用默認配置了

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：日志框架就不直接加載日志的配置項，由Spring Boot解析日志配置，可以使用Spring Boot的高級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>

可以指定某段配置只在某個環境下生效

否則就會報錯

java.lang.IllegalStateException: Logback configuration error detected: 
ERROR in ch.qos.logback.core.joran.spi.Interpreter@23:39 - 
	no applicable action for [springProfile]...

使用logback-spring.xml配置文件時：

<!-- 控制台打印 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
  <encoder charset="utf-8">
    <springProfile name="dev">
      <pattern>${CONSOLE_LOG_PATTERN}</pattern>
    </springProfile>
    <springProfile name="!dev">
      <pattern>${FILE_LOG_PATTERN}</pattern>
    </springProfile>
  </encoder>
</appender>

7、切換日志框架

7.1 現在我們想用log4j實現

根據之前的原理，就要除去有關log4j的轉換包，用原始包；還要導出logback的jar包

IDEA->在pom.xml文件中鼠標右鍵->Diagrams->Show Dependencies->選擇要除去的jar包->鼠標右鍵->Exclude

其他的JCL和JCL有的框架還要用，所有轉換包要留着

但log4j-over-slf4j.jar要去掉，這是個替換包，里面的log4j都用處slf4j了，但現在我們要用log4j了，而不是替換，所以也將其排除

最終：

面向slf4j編程，用log4j實現

導入一個適配層的包

<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-log4j12</artifactId>
</dependency>

查看其源碼，自動導入了log4j的框架

...
<dependency>
  <groupId>log4j</groupId>
  <artifactId>log4j</artifactId>
</dependency>
...

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

得到最終的pom.xml文件配置為：

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

7.2 切換至log4j2

參閱官方文檔表13.3. Spring Boot technical starters

按照之前的操作將spring-boot-start-logging.jar除去

在pom.xml文件中導入：

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