日志那些事兒——slf4j集成logback/log4j

前言

日志Logger漫談中提到了slf4j僅僅是作為日志門面存和,給用戶提供統(tǒng)一的API使用脖隶,而真正的日志系統(tǒng)的實現(xiàn)是由logback或者log4j這樣的日志系統(tǒng)實現(xiàn)徙赢,那究竟slf4j是怎樣集成logback或者log4j的呢奥此?

集成logback

前文中提到到腥,如果要使用slf4j+logback,需要引入slf4j-api及l(fā)ogback-classic萌业、logback-core三個jar包坷襟。

  • 我們一般這樣使用
Logger logger = LoggerFactory.getLogger("logger1");
logger.info("This is a test msg from: {}", "LNAmp");
  • LoggerFactory.getLogger的源代碼如下:
public static Logger getLogger(String name) {
    ILoggerFactory iLoggerFactory = getILoggerFactory();
    return iLoggerFactory.getLogger(name);
  }

需要注意的是,Logger生年、LoggerFactory婴程、ILoggerFactory都是slf4j-api.jar中的類或接口。
從源碼看來抱婉,獲取Logger有兩個過程档叔,現(xiàn)獲取對應(yīng)的ILoggerFactory,再通過ILoggerFactory獲取Logger

public static ILoggerFactory getILoggerFactory() {
    if (INITIALIZATION_STATE == UNINITIALIZED) {
      INITIALIZATION_STATE = ONGOING_INITIALIZATION;
      performInitialization();
    }
    switch (INITIALIZATION_STATE) {
      case SUCCESSFUL_INITIALIZATION:
        return StaticLoggerBinder.getSingleton().getLoggerFactory();
      case NOP_FALLBACK_INITIALIZATION:
        return NOP_FALLBACK_FACTORY;
      case FAILED_INITIALIZATION:
        throw new IllegalStateException(UNSUCCESSFUL_INIT_MSG);
      case ONGOING_INITIALIZATION:
        // support re-entrant behavior.
        // See also http://bugzilla.slf4j.org/show_bug.cgi?id=106
        return TEMP_FACTORY;
    }
    throw new IllegalStateException("Unreachable code");
  }

  private final static void performInitialization() {
    bind();
    if (INITIALIZATION_STATE == SUCCESSFUL_INITIALIZATION) {
      versionSanityCheck();
    }
  }

  private final static void bind() {
    try {
      Set staticLoggerBinderPathSet = findPossibleStaticLoggerBinderPathSet();
      reportMultipleBindingAmbiguity(staticLoggerBinderPathSet);
      // the next line does the binding
      StaticLoggerBinder.getSingleton();
      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;
      }
    } 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);
    }
  }

獲取ILoggerFactory的過程基本可以分為

  • performInitialization() : 完成StaticLoggerBinder的初始化
  • getLoggerFactory() :通過StaticLoggerBinder.getSingleton().getLoggerFactory()獲取對應(yīng)的ILoggerFactory

在整個獲取Logger的過程蒸绩,StaticLoggerBinder是個非常重要的類衙四,其對象以單例的形式存在。在performInitialization過程中侵贵,slf4j會首先查找"org/slf4j/impl/StaticLoggerBinder.class"資源文件届搁,目的是為了在存在多個org/slf4j/impl/StaticLoggerBinder.class時給開發(fā)者report警告信息,接著slf4j會使用StaticLoggerBinder.getSingleton()完成StaticLoggerBinder單例對象的初始化窍育。

slf4j之所以能使用StaticLoggerBinder.getSingleton()是因為logback-classic和slf4j-log4j都按照slf4j的規(guī)定實現(xiàn)了各自的org/slf4j/impl/StaticLoggerBinder.class卡睦。那么如果系統(tǒng)中同時存在logback-classic和slf4j-log4j的話,slf4j選擇哪一個呢漱抓,答案是隨機挑選(這是由類加載器決定的表锻,同包同名字節(jié)碼文件的加載先后順序不一定)。

StaticLoggerBinder初始化

logback的StaticLoggerBinder的初始化如下

  void init() {
    try {
      try {
        new ContextInitializer(defaultLoggerContext).autoConfig();
      } catch (JoranException je) {
        Util.report("Failed to auto configure default logger context", je);
      }
      StatusPrinter.printInCaseOfErrorsOrWarnings(defaultLoggerContext);
      contextSelectorBinder.init(defaultLoggerContext, KEY);
      initialized = true;
    } catch (Throwable t) {
      // we should never get here
      Util.report("Failed to instantiate [" + LoggerContext.class.getName()
          + "]", t);
    }
  }

其中ContextInitializer會完成配置文件例如logback.xml的文件解析和加載乞娄,特別要注意的是defaultLoggerContext是LoggerContext的實例瞬逊,LoggerContext是logback對于ILoggerFactory的實現(xiàn)。

獲取Logger

  public final Logger getLogger(final String name) {

    if (name == null) {
      throw new IllegalArgumentException("name argument cannot be null");
    }

    // if we are asking for the root logger, then let us return it without
    // wasting time
    if (Logger.ROOT_LOGGER_NAME.equalsIgnoreCase(name)) {
      return root;
    }

    int i = 0;
    Logger logger = root;
    Logger childLogger = (Logger) loggerCache.get(name);
  
    if (childLogger != null) {
      return childLogger;
    }
    String childName;
    while (true) {
      int h = Logger.getSeparatorIndexOf(name, i);
      if (h == -1) {
        childName = name;
      } else {
        childName = name.substring(0, h);
      }
      i = h + 1;
      synchronized (logger) {
        childLogger = logger.getChildByName(childName);
        if (childLogger == null) {
          childLogger = logger.createChildByName(childName);
          loggerCache.put(childName, childLogger);
          incSize();
        }
      }
      logger = childLogger;
      if (h == -1) {
        return childLogger;
      }
    }

在logback中仪或,ILoggerFactory的實現(xiàn)是LoggerContext确镊,調(diào)用LoggerContext.getLogger獲取的Logger實例類型為ch.qos.logback.classic.Logger,是org.slf4j.Logger的實現(xiàn)類范删。獲取Logger的過程可以分為

  • 是否是root蕾域,如果是,返回root
  • 從loggerCache緩存中獲取到旦,loggerCache中包含了配置文件中解析出來的logger信息和之前create過的logger
  • 將logger name以"."分割旨巷,獲取或者創(chuàng)建的logger,例如com.mujin.lnamp添忘,會創(chuàng)建名為com采呐、com.mujin、com.mujin.lnamp的logger搁骑,并將其放入loggerCache然后返回com.mujin.lnamp斧吐。logger是root logger的child即logger.parent=ROOT

至此獲取Logger完成又固,logback的Logger實現(xiàn)類為ch.qos.logback.classic.Logger

集成log4j

slf4j集成log4j需要引入slf4j-api、slf4j-log4j12会通、log4j三個Jar包口予,slf4j-log4j12用來起橋接作用。

獲取Logger的過程和logback的過程一樣涕侈,唯一不同的是StaticLoggerBinder的實現(xiàn)方式不一樣沪停,StaticLoggerBinder的構(gòu)造方法如下

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的實例,Log4jLoggerFactory是ILoggerFactory的實現(xiàn)類裳涛。

log4j版的StaticLoggerBinder獲取logger過程如下

public Logger getLogger(String name) {
    Logger slf4jLogger = loggerMap.get(name);
    if (slf4jLogger != null) {
      return slf4jLogger;
    } else {
      org.apache.log4j.Logger log4jLogger;
      if(name.equalsIgnoreCase(Logger.ROOT_LOGGER_NAME))
        log4jLogger = LogManager.getRootLogger();
      else
        log4jLogger = LogManager.getLogger(name);

      Logger newInstance = new Log4jLoggerAdapter(log4jLogger);
      Logger oldInstance = loggerMap.putIfAbsent(name, newInstance);
      return oldInstance == null ? newInstance : oldInstance;
    }
  }

思路很清晰

  • 從loggerMap中嘗試取出
  • 如果logger name名為root木张,返回root
  • 使用LogManager.getLogger返回Log4j的Logger實現(xiàn),其類型為 org.apache.log4j.Logger log4jLogger
  • 使用Log4jLoggerAdapter包裝 org.apache.log4j.Logger log4jLogger端三,使其適配org.slf4j.Logger接口
  • 將Log4jLoggerAdapter嘗試放入loggerMap緩存

那這樣就有個疑問了舷礼,log4j的配置文件如何加載的呢?答案在LogManager的靜態(tài)塊中


static {
        Hierarchy h = new Hierarchy(new RootLogger(Level.DEBUG));
        repositorySelector = new DefaultRepositorySelector(h);
        String override = OptionConverter.getSystemProperty("log4j.defaultInitOverride", (String)null);
        if(override == null || "false".equalsIgnoreCase(override)) {
            String configurationOptionStr = OptionConverter.getSystemProperty("log4j.configuration", (String)null);
            String configuratorClassName = OptionConverter.getSystemProperty("log4j.configuratorClass", (String)null);
            URL url = null;
            if(configurationOptionStr == null) {
                url = Loader.getResource("log4j.xml");
                if(url == null) {
                    url = Loader.getResource("log4j.properties");
                }
            } else {
                try {
                    url = new URL(configurationOptionStr);
                } catch (MalformedURLException var5) {
                    url = Loader.getResource(configurationOptionStr);
                }
            }
            if(url != null) {
                LogLog.debug("Using URL [" + url + "] for automatic log4j configuration.");
                OptionConverter.selectAndConfigure(url, configuratorClassName, getLoggerRepository());
            } else {
                LogLog.debug("Could not find resource: [" + configurationOptionStr + "].");
            }
        }

以上會去加載log4j.properties或log4j.xml等配置文件郊闯,然后進行初始化

總結(jié)

slf4j通過StaticLoggerBinder鏈接log4j/logback妻献,log4j/logback都提供了對應(yīng)的StaticLoggerBinder實現(xiàn),而對于org.slf4j.Logger接口团赁,log4j提供的默認實現(xiàn)是Log4jLoggerAdapter育拨,logback提供的實現(xiàn)是ch.qos.logback.classic.Logger。通過以上分析欢摄,我們可以回答兩個問題了

  • 如何判斷系統(tǒng)中使用了slf4j日志門面熬丧?
  • 可以通過Class.forName("org.slf4j.impl.StaticLoggerBinder"),如果沒有拋出ClassNotFoundException說明使用了slf4j
  • 如何判斷系統(tǒng)使用了slf4j+log4j還是slf4j+logback
  • 可以通過LogFactory.getLogger的返回類型判斷怀挠,log4j實現(xiàn)是Log4jLoggerAdapter析蝴,logback實現(xiàn)是ch.qos.logback.classic.Logger

基于以上手段,我們可以做出一套適配log4j或者logback的日志記錄工具類了绿淋,后續(xù)將有相關(guān)博文給出

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末闷畸,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子吞滞,更是在濱河造成了極大的恐慌佑菩,老刑警劉巖,帶你破解...
    沈念sama閱讀 212,816評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件冯吓,死亡現(xiàn)場離奇詭異倘待,居然都是意外死亡疮跑,警方通過查閱死者的電腦和手機组贺,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,729評論 3 385
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來祖娘,“玉大人失尖,你說我怎么就攤上這事啊奄。” “怎么了掀潮?”我有些...
    開封第一講書人閱讀 158,300評論 0 348
  • 文/不壞的土叔 我叫張陵菇夸,是天一觀的道長。 經(jīng)常有香客問我仪吧,道長庄新,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,780評論 1 285
  • 正文 為了忘掉前任薯鼠,我火速辦了婚禮择诈,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘出皇。我一直安慰自己羞芍,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 65,890評論 6 385
  • 文/花漫 我一把揭開白布郊艘。 她就那樣靜靜地躺著荷科,像睡著了一般。 火紅的嫁衣襯著肌膚如雪纱注。 梳的紋絲不亂的頭發(fā)上畏浆,一...
    開封第一講書人閱讀 50,084評論 1 291
  • 那天,我揣著相機與錄音奈附,去河邊找鬼全度。 笑死,一個胖子當(dāng)著我的面吹牛斥滤,可吹牛的內(nèi)容都是我干的将鸵。 我是一名探鬼主播,決...
    沈念sama閱讀 39,151評論 3 410
  • 文/蒼蘭香墨 我猛地睜開眼佑颇,長吁一口氣:“原來是場噩夢啊……” “哼顶掉!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起挑胸,我...
    開封第一講書人閱讀 37,912評論 0 268
  • 序言:老撾萬榮一對情侶失蹤痒筒,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后茬贵,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體簿透,經(jīng)...
    沈念sama閱讀 44,355評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,666評論 2 327
  • 正文 我和宋清朗相戀三年解藻,在試婚紗的時候發(fā)現(xiàn)自己被綠了老充。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,809評論 1 341
  • 序言:一個原本活蹦亂跳的男人離奇死亡螟左,死狀恐怖啡浊,靈堂內(nèi)的尸體忽然破棺而出觅够,到底是詐尸還是另有隱情,我是刑警寧澤巷嚣,帶...
    沈念sama閱讀 34,504評論 4 334
  • 正文 年R本政府宣布喘先,位于F島的核電站,受9級特大地震影響廷粒,放射性物質(zhì)發(fā)生泄漏窘拯。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 40,150評論 3 317
  • 文/蒙蒙 一坝茎、第九天 我趴在偏房一處隱蔽的房頂上張望树枫。 院中可真熱鬧,春花似錦景东、人聲如沸砂轻。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,882評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽搔涝。三九已至,卻和暖如春和措,著一層夾襖步出監(jiān)牢的瞬間庄呈,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,121評論 1 267
  • 我被黑心中介騙來泰國打工派阱, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留诬留,地道東北人。 一個月前我還...
    沈念sama閱讀 46,628評論 2 362
  • 正文 我出身青樓贫母,卻偏偏與公主長得像文兑,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子腺劣,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 43,724評論 2 351

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