自拍偷在线精品自拍偷,亚洲欧美中文日韩v在线观看不卡

從Slf4j源碼角度分析阿里開發(fā)手冊日志規(guī)約

作者：IT徐胖子
開發(fā) 前端
《阿里巴巴開發(fā)手冊》日志規(guī)約章節(jié)有一條強制規(guī)定：應用中不可直接使用日志系統(tǒng)(Log4j、Logback)API，而應依賴使用日志框架SLF4J中的API。

[[387472]]

本文轉載自微信公眾號「JAVA前線」，作者IT徐胖子 。轉載本文請聯系JAVA前線公眾號。

 1 日志規(guī)約

《阿里巴巴開發(fā)手冊》日志規(guī)約章節(jié)有一條強制規(guī)定：應用中不可直接使用日志系統(tǒng)(Log4j、Logback)API，而應依賴使用日志框架SLF4J中的API。使用門面模式的日志框架，有利于維護和各個類的日志處理方式統(tǒng)一：

  1. import org.slf4j.Logger; 
  2. import org.slf4j.LoggerFactory; 
  3. private static final Logger logger = LoggerFactory.getLogger(Abc.class); 

我們在使用日志框架過程中會發(fā)現，日志框架種類很多如slf4j、log4j、logback等等，在引入依賴時很容易混淆。那么這些框架是什么關系、應該如何使用就是本文需要回答的問題。

2 實例分析

在編寫代碼之前我們首先了解slf4j全稱，我認為這會對理解這個框架有所幫助：

  1. Simple Logging Facade for Java 

全稱的含義就是Java簡單日志門面，我們知道有一種設計模式被稱為門面模式，其本質是化零為整，通過一個對象將散落在各處的功能整合在一起，這樣外部只要通過與這個對象交互，由該對象選擇具體實現細節(jié)。slf4j就是這樣一個門面，應用程序只需要和slf4j進行交互，slf4j選擇使用哪一個日志框架的具體實現。

2.1 slf4j-jdk14

(1) 引入依賴

  1. <dependencies> 
  2.   <!-- slf4j --> 
  3.   <dependency> 
  4.     <groupId>org.slf4j</groupId> 
  5.     <artifactId>slf4j-api</artifactId> 
  6.     <version>1.7.30</version> 
  7.   </dependency> 
  8.    
  9.   <!-- jdk14 --> 
  10.   <dependency> 
  11.     <groupId>org.slf4j</groupId> 
  12.     <artifactId>slf4j-jdk14</artifactId> 
  13.     <version>1.7.30</version> 
  14.   </dependency> 
  15. </dependencies> 

 

 

(2) 代碼實例

  1. import org.slf4j.Logger; 
  2. import org.slf4j.LoggerFactory; 
  3.  
  4. public class LogTest { 
  5.     private final static Logger logger = LoggerFactory.getLogger(LogTest.class); 
  6.     public static void main(String[] args) { 
  7.         logger.info("info message"); 
  8.         System.out.println("LogTest"); 
  9.         logger.error("error message"); 
  10.     } 
  11. } 

(3) 輸出日志

  1. LogTest 
  2. 三月 14, 2021 11:39:14 上午 com.my.log.test.jdk14.LogTest main 
  3. 信息: info message 
  4. 三月 14, 2021 11:39:14 上午 com.my.log.test.jdk14.LogTest main 
  5. 嚴重: error message 

2.2 slf4j-simple

(1) 引入依賴

  1. <dependencies> 
  2.   <!-- slf4j --> 
  3.   <dependency> 
  4.     <groupId>org.slf4j</groupId> 
  5.     <artifactId>slf4j-api</artifactId> 
  6.     <version>1.7.30</version> 
  7.   </dependency> 
  8.    
  9.   <!-- simple --> 
  10.   <dependency> 
  11.     <groupId>org.slf4j</groupId> 
  12.     <artifactId>slf4j-simple</artifactId> 
  13.     <version>1.7.30</version> 
  14.   </dependency> 
  15. </dependencies> 

 

 

(2) 代碼實例

  1. import org.slf4j.Logger; 
  2. import org.slf4j.LoggerFactory; 
  3.  
  4. public class LogTest { 
  5.     private final static Logger logger = LoggerFactory.getLogger(LogTest.class); 
  6.     public static void main(String[] args) { 
  7.         logger.info("info message"); 
  8.         System.out.println("LogTest"); 
  9.         logger.error("error message"); 
  10.     } 
  11. } 

(3) 輸出日志

  1. [main] INFO com.my.log.test.simple.LogTest - info message 
  2. LogTest 
  3. [main] ERROR com.my.log.test.simple.LogTest - error message 

2.3 logback

(1) 引入依賴

  1. <dependencies> 
  2.   <!-- slf4j --> 
  3.   <dependency> 
  4.     <groupId>org.slf4j</groupId> 
  5.     <artifactId>slf4j-api</artifactId> 
  6.     <version>1.7.30</version> 
  7.   </dependency> 
  8.    
  9.   <!-- logback --> 
  10.   <dependency> 
  11.     <groupId>ch.qos.logback</groupId> 
  12.     <artifactId>logback-core</artifactId> 
  13.     <version>1.2.3</version> 
  14.   </dependency> 
  15.   <dependency> 
  16.     <groupId>ch.qos.logback</groupId> 
  17.     <artifactId>logback-classic</artifactId> 
  18.     <version>1.2.3</version> 
  19.   </dependency> 
  20. </dependencies> 

 

 

(2) 代碼實例

  1. import org.slf4j.Logger; 
  2. import org.slf4j.LoggerFactory; 
  3.  
  4. public class LogTest { 
  5.     private final static Logger logger = LoggerFactory.getLogger(LogTest.class); 
  6.     public static void main(String[] args) { 
  7.         logger.info("info message"); 
  8.         System.out.println("LogTest"); 
  9.         logger.error("error message"); 
  10.     } 
  11. } 

(3) 輸出日志

  1. 11:40:53.406 [main] INFO com.my.log.test.logbck.LogTest - info message 
  2. LogTest 
  3. 11:40:53.410 [main] ERROR com.my.log.test.logbck.LogTest - error message 

2.4 slf4j-log4j12

(1) 引入依賴

  1. <dependencies> 
  2.   <!-- slf4j --> 
  3.   <dependency> 
  4.     <groupId>org.slf4j</groupId> 
  5.     <artifactId>slf4j-api</artifactId> 
  6.     <version>1.7.30</version> 
  7.   </dependency> 
  8.    
  9.   <!-- log4j12 --> 
  10.   <dependency> 
  11.     <groupId>org.slf4j</groupId> 
  12.     <artifactId>slf4j-log4j12</artifactId> 
  13.     <version>1.7.30</version> 
  14.   </dependency> 
  15. </dependencies> 

 

 

(2) 代碼實例

  1. import org.slf4j.Logger; 
  2. import org.slf4j.LoggerFactory; 
  3.  
  4. public class LogTest { 
  5.     private final static Logger logger = LoggerFactory.getLogger(LogTest.class); 
  6.     public static void main(String[] args) { 
  7.         logger.info("info message"); 
  8.         System.out.println("LogTest"); 
  9.         logger.error("error message"); 
  10.     } 
  11. } 

(3) 日志配置

  1. <log4j:configuration xmlns:log4j='http://jakarta.apache.org/log4j/'> 
  2.   <appender name="myConsoleAppender" class="org.apache.log4j.ConsoleAppender"> 
  3.     <layout class="org.apache.log4j.PatternLayout"> 
  4.       <param name="ConversionPattern" value="[%d{dd HH:mm:ss,SSS\} %-5p] [%t] %c{2\} - %m%n" /> 
  5.     </layout> 
  6.     <!--過濾器設置輸出級別 --> 
  7.     <filter class="org.apache.log4j.varia.LevelRangeFilter"> 
  8.       <param name="levelMin" value="debug" /> 
  9.       <param name="levelMax" value="error" /> 
  10.       <param name="AcceptOnMatch" value="true" /> 
  11.     </filter> 
  12.   </appender> 
  13.   <root> 
  14.     <priority value="debug" /> 
  15.     <appender-ref ref="myConsoleAppender" /> 
  16.   </root> 
  17. </log4j:configuration> 

 

 

 

 

 

(4) 輸出日志

  1. [14 11:41:39,198 INFO ] [main] log4j.LogTest - info message 
  2. LogTest 
  3. [14 11:41:39,201 ERROR] [main] log4j.LogTest - error message 

3 源碼分析

我們發(fā)現上述實例中Java代碼并沒有變化，只是將引用具體日志框架實現進行了替換，例如依賴從simple替換為log4j，具體日志服務實現就替換成了log4j，這到底是怎么實現的?我們通過閱讀源碼回答這個問題。

3.1 閱讀準備

(1) 源碼地址

目前最新版本2.0.0-alpha2-SNAPSHOT

  1. https://github.com/qos-ch/slf4j 

(2) 項目結構

我們從項目結構可以看出一些信息：門面是api模塊，具體實現包括jdk14、log4j12、simple模塊，需要注意logback是同一個作者的另一個項目不在本項目。

(3) 閱讀入口

  1. package org.slf4j; 
  2.  
  3. public class NoBindingTest { 
  4.     public void testLogger() { 
  5.         Logger logger = LoggerFactory.getLogger(NoBindingTest.class); 
  6.         logger.debug("hello" + diff); 
  7.         assertTrue(logger instanceof NOPLogger); 
  8.     } 
  9. } 

3.2 源碼分析

LoggerFactory.getLogger

  1. public final class LoggerFactory { 
  2.     public static Logger getLogger(Class<?> clazz) { 
  3.         Logger logger = getLogger(clazz.getName()); 
  4.         if (DETECT_LOGGER_NAME_MISMATCH) { 
  5.             Class<?> autoComputedCallingClass = Util.getCallingClass(); 
  6.             if (autoComputedCallingClass != null && nonMatchingClasses(clazz, autoComputedCallingClass)) { 
  7.                 Util.report(String.format("Detected logger name mismatch. Given name: \"%s\"; computed name: \"%s\".", logger.getName(), 
  8.                                           autoComputedCallingClass.getName())); 
  9.                 Util.report("See " + LOGGER_NAME_MISMATCH_URL + " for an explanation"); 
  10.             } 
  11.         } 
  12.         return logger; 
  13.     } 
  14. } 

getLogger(clazz.getName())

  1. public final class LoggerFactory { 
  2.     public static Logger getLogger(String name) { 
  3.         ILoggerFactory iLoggerFactory = getILoggerFactory(); 
  4.         return iLoggerFactory.getLogger(name); 
  5.     } 
  6. } 

getILoggerFactory()

  1. public final class LoggerFactory { 
  2.     public static ILoggerFactory getILoggerFactory() { 
  3.         return getProvider().getLoggerFactory(); 
  4.     } 
  5. } 

getProvider()

  1. public final class LoggerFactory { 
  2.     static SLF4JServiceProvider getProvider() { 
  3.         if (INITIALIZATION_STATE == UNINITIALIZED) { 
  4.             synchronized (LoggerFactory.class) { 
  5.                 if (INITIALIZATION_STATE == UNINITIALIZED) { 
  6.                     INITIALIZATION_STATE = ONGOING_INITIALIZATION; 
  7.                     performInitialization(); 
  8.                 } 
  9.             } 
  10.         } 
  11.         switch (INITIALIZATION_STATE) { 
  12.         case SUCCESSFUL_INITIALIZATION: 
  13.             return PROVIDER; 
  14.         case NOP_FALLBACK_INITIALIZATION: 
  15.             return NOP_FALLBACK_FACTORY; 
  16.         case FAILED_INITIALIZATION: 
  17.             throw new IllegalStateException(UNSUCCESSFUL_INIT_MSG); 
  18.         case ONGOING_INITIALIZATION: 
  19.             return SUBST_PROVIDER; 
  20.         } 
  21.         throw new IllegalStateException("Unreachable code"); 
  22.     } 
  23. } 

performInitialization()

  1. public final class LoggerFactory { 
  2.     private final static void performInitialization() { 
  3.         bind(); 
  4.         if (INITIALIZATION_STATE == SUCCESSFUL_INITIALIZATION) { 
  5.             versionSanityCheck(); 
  6.         } 
  7.     } 
  8. } 

bind()

  1. public final class LoggerFactory { 
  2.     private final static void bind() { 
  3.         try { 
  4.             // 核心代碼 
  5.             List<SLF4JServiceProvider> providersList = findServiceProviders(); 
  6.             reportMultipleBindingAmbiguity(providersList); 
  7.             if (providersList != null && !providersList.isEmpty()) { 
  8.              PROVIDER = providersList.get(0); 
  9.              PROVIDER.initialize(); 
  10.              INITIALIZATION_STATE = SUCCESSFUL_INITIALIZATION; 
  11.                 reportActualBinding(providersList); 
  12.             } 
  13.             // 省略代碼 
  14.         } catch (Exception e) { 
  15.             failedBinding(e); 
  16.             throw new IllegalStateException("Unexpected initialization failure", e); 
  17.         } 
  18.     } 
  19. } 

findServiceProviders()

這是加載具體日志實現的核心方法，使用SPI機制加載所有SLF4JServiceProvider實現類：

  1. public final class LoggerFactory { 
  2.     private static List<SLF4JServiceProvider> findServiceProviders() { 
  3.         ServiceLoader<SLF4JServiceProvider> serviceLoader = ServiceLoader.load(SLF4JServiceProvider.class); 
  4.         List<SLF4JServiceProvider> providerList = new ArrayList<SLF4JServiceProvider>(); 
  5.         for (SLF4JServiceProvider provider : serviceLoader) { 
  6.             providerList.add(provider); 
  7.         } 
  8.         return providerList; 
  9.     } 
  10. } 

SPI(Service Provider Interface)是一種服務發(fā)現機制，本質是將接口實現類的全限定名配置在文件中，并由服務加載器讀取配置文件加載實現類，這樣可以在運行時動態(tài)為接口替換實現類，通過SPI機制可以為程序提供拓展功能。本文以log4j為例說明使用SPI功能的三個步驟：

(a) 實現接口

  1. public class Log4j12ServiceProvider implements SLF4JServiceProvider 

(b) 配置文件

  1. 文件位置：src/main/resources/META-INF/services/ 
  2. 文件名稱：org.slf4j.spi.SLF4JServiceProvider 
  3. 文件內容：org.slf4j.log4j12.Log4j12ServiceProvider 

(c) 服務加載

  1. public final class LoggerFactory { 
  2.     private static List<SLF4JServiceProvider> findServiceProviders() { 
  3.         ServiceLoader<SLF4JServiceProvider> serviceLoader = ServiceLoader.load(SLF4JServiceProvider.class); 
  4.         List<SLF4JServiceProvider> providerList = new ArrayList<SLF4JServiceProvider>(); 
  5.         for (SLF4JServiceProvider provider : serviceLoader) { 
  6.             providerList.add(provider); 
  7.         } 
  8.         return providerList; 
  9.     } 
  10. } 

只要各種日志實現框架按照SPI約定進行代碼編寫和配置文件聲明，即可以被LoggerFactory加載，slf4j會獲取第一個作為實現。

  1. public final class LoggerFactory { 
  2.     private final static void bind() { 
  3.         try { 
  4.             // 使用SPI機制加載具體日志實現 
  5.             List<SLF4JServiceProvider> providersList = findServiceProviders(); 
  6.             reportMultipleBindingAmbiguity(providersList); 
  7.             if (providersList != null && !providersList.isEmpty()) { 
  8.                 // 獲取第一個實現 
  9.                 PROVIDER = providersList.get(0); 
  10.                 PROVIDER.initialize(); 
  11.                 INITIALIZATION_STATE = SUCCESSFUL_INITIALIZATION; 
  12.                 reportActualBinding(providersList); 
  13.             } 
  14.             // 省略代碼 
  15.         } catch (Exception e) { 
  16.             failedBinding(e); 
  17.             throw new IllegalStateException("Unexpected initialization failure", e); 
  18.         } 
  19.     } 
  20. } 

分析到這里我們的問題應該可以得到解答：假設我們項目只引入了slf4j和log4j，相當于只有l(wèi)og4j這一個具體實現，那么本項目就會使用log4j框架。如果將log4j依賴換為logback，那么項目在不改動代碼的情況下會使用logback框架。

4 文章總結

本文我們從阿里開發(fā)手冊日志規(guī)約出發(fā)，首先分析了如何使用不同的日志框架，然后我們從問題出發(fā)(不修改代碼即可替換具體日志框架)進行slf4j源碼閱讀，從源碼中我們知道實現核心是SPI機制，這個機制可以動態(tài)加載具體日志實現。關于SPI源碼分析請參看筆者文章JDK SPI機制，希望本文對大家有所幫助。

 

責任編輯：武曉燕 來源： JAVA前線
日志開發(fā)源碼
相關推薦

2023-01-11 21:22:32

Java服務器

2024-03-01 16:52:02

SLF4J日志框架

2013-02-20 09:42:34

JavaLogbackSLF4J

2023-10-28 16:19:18

Android日志

2020-01-07 10:06:26

Slf4jLog4JLogback

2020-10-27 08:24:45

阿里巴巴SLF4J

2024-03-01 08:17:28

SLF4J日志框架

2016-10-21 13:10:18

javalog4jslf4j

2023-10-07 10:08:54

2017-05-02 21:14:20

阿里巴巴Java開發(fā)

2025-01-20 08:10:00

微服務架構SLF4J

2020-12-17 08:03:57

LinkedList面試源碼

2020-12-14 08:03:52

ArrayList面試源碼

2020-11-04 12:33:08

Log4j 2日志Logback

2023-05-06 07:51:22

JavaFacade設計模式

2022-12-30 08:31:27

MDC查詢日志

2021-08-02 15:40:20

Java日志工具

2021-12-30 08:55:41

Log4j2FastJson漏洞

2018-08-28 15:30:54

編程語言Python日志系統(tǒng)

2022-05-12 11:38:26

Java日志Slf4j
點贊
收藏

51CTO技術棧公眾號