SLF4J 源碼分析

SLF4J堕担,即簡單日志門面(Simple Logging Facade for Java)欢伏,不是具體的日志解決方案匿垄,它只服務(wù)于各種各樣的日志系統(tǒng)。按照官方的說法虎忌,SLF4J是一個用于日志系統(tǒng)的簡單Facade泡徙,允許最終用戶在部署其應(yīng)用時使用其所希望的日志System,

Paste_Image.png
Logger log = LoggerFactory.getLogger(getClass());

LoggerFactory 是一個final 類 也是一個日志工廠類 生產(chǎn) Logger 對象,看看getLogger 方法

  public static Logger getLogger(Class clazz) {
    return getLogger(clazz.getName());
  }

 public static Logger getLogger(String name) {
    ILoggerFactory iLoggerFactory = getILoggerFactory();
    return iLoggerFactory.getLogger(name);
  }

public static ILoggerFactory getILoggerFactory() {

      //假如是未初始化狀態(tài)
    if (INITIALIZATION_STATE == UNINITIALIZED) {

      //初始化狀態(tài)為 正在進(jìn)行中
      INITIALIZATION_STATE = ONGOING_INITIALIZATION;

       //進(jìn)入performIntialization 方法初始化膜蠢!
      performInitialization();
    }
    switch (INITIALIZATION_STATE) {
      //假如初始化成功
      case SUCCESSFUL_INITIALIZATION:
  
         //獲取具體的日志工廠對象
        return StaticLoggerBinder.getSingleton().getLoggerFactory();
      case NOP_FALLBACK_INITIALIZATION:
          
        // 返回NOPLoggerFactory 日志工廠
        return NOP_FALLBACK_FACTORY;
      case FAILED_INITIALIZATION:
        
        //初始化失敗 拋出異常
        throw new IllegalStateException(UNSUCCESSFUL_INIT_MSG);
      case ONGOING_INITIALIZATION:

       // 返回 SubstituteLoggerFactory 日志工廠
        return TEMP_FACTORY;
    }
    throw new IllegalStateException("Unreachable code");
  }

private final static void performInitialization() {
    
    //綁定一個具體的日志實現(xiàn)
    bind();

    if (INITIALIZATION_STATE == SUCCESSFUL_INITIALIZATION) {

       //檢查日志的版本
      versionSanityCheck();
    }
  }

  private final static void bind() {
    try {
      //尋找日志綁定實現(xiàn)類堪藐,如果找不到或者指定的方法不存在,都會報錯提示,實現(xiàn)類可能有多個挑围,
      //因此用Set集合
      Set staticLoggerBinderPathSet = findPossibleStaticLoggerBinderPathSet();

       //報告打印
      reportMultipleBindingAmbiguity(staticLoggerBinderPathSet);

       // 測試是否存在 getSingleton 方法
      StaticLoggerBinder.getSingleton();

      // 設(shè)置初始化狀態(tài)礁竞,初始化成功
      INITIALIZATION_STATE = SUCCESSFUL_INITIALIZATION;
      
      //報告打印實際的綁定類型
      reportActualBinding(staticLoggerBinderPathSet);

      emitSubstituteLoggerWarning();

      //如果找不到指定的類
    } catch (NoClassDefFoundError ncde) {

      //獲取異常信息
      String msg = ncde.getMessage();
  
        //報告異常信息
      if (messageContainsOrgSlf4jImplStaticLoggerBinder(msg)) {
        INITIALIZATION_STATE = NOP_FALLBACK_INITIALIZATION;
        Util.report("Failed to load class \"org.slf4j.impl.StaticLoggerBinder\".");
        Util.report("Defaulting to no-operation (NOP) logger implementation");
        Util.report("See " + NO_STATICLOGGERBINDER_URL
                + " for further details.");
      } else {
        failedBinding(ncde);
        throw ncde;
      }

      //如果找不到指定的方法 也就是 getSingleton 方法
    } catch (java.lang.NoSuchMethodError nsme) {
      String msg = nsme.getMessage();
      if (msg != null && msg.indexOf("org.slf4j.impl.StaticLoggerBinder.getSingleton()") != -1) {
        INITIALIZATION_STATE = FAILED_INITIALIZATION;
        Util.report("slf4j-api 1.6.x (or later) is incompatible with this binding.");
        Util.report("Your binding is version 1.5.5 or earlier.");
        Util.report("Upgrade your binding to version 1.6.x.");
      }
      throw nsme;
    } catch (Exception e) {
      failedBinding(e);
      throw new IllegalStateException("Unexpected initialization failure", e);
    }
  }

尋找綁定實現(xiàn)類

  private static Set findPossibleStaticLoggerBinderPathSet() {

    Set staticLoggerBinderPathSet = new LinkedHashSet();
    try {
    
      //獲取LoggerFactory的類加載器
      ClassLoader loggerFactoryClassLoader = LoggerFactory.class.getClassLoader();
      Enumeration paths;

        //假如LoggerFactory的類加載器為空
      if (loggerFactoryClassLoader == null) {
        
        //如果獲取不到類加載器則說明是系統(tǒng)加載器,那么在系統(tǒng)路徑下獲取該資源文件
        paths = ClassLoader.getSystemResources(STATIC_LOGGER_BINDER_PATH);
      } else {

        //獲取到了類加載器杉辙,則用該類加載器加載指定的資源文件
        paths = loggerFactoryClassLoader
                .getResources(STATIC_LOGGER_BINDER_PATH);
      }
      while (paths.hasMoreElements()) {
        URL path = (URL) paths.nextElement();

        //將地址加入到集合中去
        staticLoggerBinderPathSet.add(path);
      }
    } catch (IOException ioe) {
      Util.report("Error getting resources from path", ioe);
    }
    return staticLoggerBinderPathSet;
  }

通過以上代碼 找到了默認(rèn)的 日志綁定實現(xiàn)類 StaticLoggerBinder模捂,在通過該綁定類來獲取Log4jLoggerFactory 具體的日志工廠對象

 private static final StaticLoggerBinder SINGLETON = new StaticLoggerBinder();

//單例
public static final StaticLoggerBinder getSingleton() {
    return SINGLETON;
  }

  private StaticLoggerBinder() {
    loggerFactory = new Log4jLoggerFactory();
    try {
      Level level = Level.TRACE;
    } catch (NoSuchFieldError nsfe) {
      Util
          .report("This version of SLF4J requires log4j version 1.2.12 or later. See also http://www.slf4j.org/codes.html#log4j_version");
    }
  }

  // 獲取 Log4jLoggerFactory 類 對象
  public ILoggerFactory getLoggerFactory() {
    return loggerFactory;
  }

在看看 Log4jLoggerFactory 類的 實現(xiàn),Log4jLoggerFactory類 是對 ILoggerFactory接口的實現(xiàn)
ILoggerFactory 只定義了一個方法

public interface ILoggerFactory {
  
  public Logger getLogger(String name);

}
public class Log4jLoggerFactory implements ILoggerFactory {

  ConcurrentMap<String, Logger> loggerMap;

  public Log4jLoggerFactory() {
    loggerMap = new ConcurrentHashMap<String, Logger>();
  }

  public Logger getLogger(String name) {

    //查看是否存在key 為 name 的 Logger  對象
    Logger slf4jLogger = loggerMap.get(name);
    if (slf4jLogger != null) {
      return slf4jLogger;
    } else {
  
      //這才是具體的日志實現(xiàn) 
      org.apache.log4j.Logger log4jLogger;

      //獲取log4jLogger 類對象
      if(name.equalsIgnoreCase(Logger.ROOT_LOGGER_NAME))
        log4jLogger = LogManager.getRootLogger();
      else
        log4jLogger = LogManager.getLogger(name);

      //Log4jLoggerAdapter 是一個適配器類 用于適配Logger 接口
      //因為 Log4jLoggerAdapter 繼承自 MarkerIgnoringBase 類
      //而 MarkerIgnoringBase 類 又實現(xiàn)了 Logger 接口
      // 所有的底層都是 log4jLogger 去實現(xiàn)的
      Logger newInstance = new Log4jLoggerAdapter(log4jLogger);
      Logger oldInstance = loggerMap.putIfAbsent(name, newInstance);
      return oldInstance == null ? newInstance : oldInstance;
    }
  }
}
總結(jié)

Slf4j 主要用到了 JVM類加載機(jī)制 門面設(shè)計模式 適配器設(shè)計模式

簡單的說下它的原理蜘矢,就是通過工廠類狂男,提供一個用戶的接口!用戶可以通過這個外觀接口品腹,直接使用API實現(xiàn)日志的記錄岖食。而后面的具體實現(xiàn)由Slf4j來尋找加載.尋找的過程,就是通過類加載加載那個叫org/slf4j/impl/StaticLoggerBinder.class的文件舞吭,只要實現(xiàn)了這個文件的日志實現(xiàn)系統(tǒng)县耽,都可以作為一種實現(xiàn)方式。如果找到很多種方式镣典,那么就尋找一種默認(rèn)的方式

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市唾琼,隨后出現(xiàn)的幾起案子兄春,更是在濱河造成了極大的恐慌,老刑警劉巖锡溯,帶你破解...
    沈念sama閱讀 216,372評論 6 498
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件赶舆,死亡現(xiàn)場離奇詭異哑姚,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)芜茵,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,368評論 3 392
  • 文/潘曉璐 我一進(jìn)店門叙量,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人九串,你說我怎么就攤上這事≈砼ィ” “怎么了肘交?”我有些...
    開封第一講書人閱讀 162,415評論 0 353
  • 文/不壞的土叔 我叫張陵腻要,是天一觀的道長闯第。 經(jīng)常有香客問我填帽,道長篡腌,這世上最難降的妖魔是什么嘹悼? 我笑而不...
    開封第一講書人閱讀 58,157評論 1 292
  • 正文 為了忘掉前任萌腿,我火速辦了婚禮毁菱,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己卤材,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,171評論 6 388
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著实幕,像睡著了一般。 火紅的嫁衣襯著肌膚如雪整吆。 梳的紋絲不亂的頭發(fā)上表蝙,一...
    開封第一講書人閱讀 51,125評論 1 297
  • 那天,我揣著相機(jī)與錄音汇跨,去河邊找鬼。 笑死蚪黑,一個胖子當(dāng)著我的面吹牛祠锣,可吹牛的內(nèi)容都是我干的妆棒。 我是一名探鬼主播动分,決...
    沈念sama閱讀 40,028評論 3 417
  • 文/蒼蘭香墨 我猛地睜開眼澜公,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了喇肋?” 一聲冷哼從身側(cè)響起坟乾,我...
    開封第一講書人閱讀 38,887評論 0 274
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎蝶防,沒想到半個月后甚侣,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,310評論 1 310
  • 正文 獨居荒郊野嶺守林人離奇死亡间学,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,533評論 2 332
  • 正文 我和宋清朗相戀三年殷费,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片低葫。...
    茶點故事閱讀 39,690評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡详羡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出氮采,到底是詐尸還是另有隱情殷绍,我是刑警寧澤,帶...
    沈念sama閱讀 35,411評論 5 343
  • 正文 年R本政府宣布鹊漠,位于F島的核電站主到,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏躯概。R本人自食惡果不足惜登钥,卻給世界環(huán)境...
    茶點故事閱讀 41,004評論 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望娶靡。 院中可真熱鬧牧牢,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,659評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至轮纫,卻和暖如春腔寡,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背掌唾。 一陣腳步聲響...
    開封第一講書人閱讀 32,812評論 1 268
  • 我被黑心中介騙來泰國打工放前, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人糯彬。 一個月前我還...
    沈念sama閱讀 47,693評論 2 368
  • 正文 我出身青樓凭语,卻偏偏與公主長得像,于是被迫代替她去往敵國和親撩扒。 傳聞我的和親對象是個殘疾皇子似扔,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,577評論 2 353

推薦閱讀更多精彩內(nèi)容