阿里Java開發手冊思考（三）

時間  2019-11-16
標籤 阿里 java 開發 手冊 思考 欄目 阿里巴巴 简体版
原文   原文鏈接

上期咱們分享了Java中if/else複雜邏輯的處理html

本期咱們將分享Java中日誌的處理（上）java

想必你們都用過日誌，雖然日誌看起來無關緊要，可是等到出問題的時候，日誌就派上了大用場，因此說日誌打得好很差，規範不規範，直接影響了解決生產環境故障的效率，日誌打的很差，有可能影響環境的性能，也有可能影響排查問題的難易程度，有可能排查問題的時間比寫代碼的時間還有多。apache

那麼咱們就來分析下阿里Java開發手冊--日誌規約第一條： 【強制】應用中不可直接使用日誌系統(Log4j、Logback)中的 API，而應依賴使用日誌框架 SLF4J 中的 API，使用門面模式的日誌框架，有利於維護和各個類的日誌處理方式統一。設計模式

import org.slf4j.Logger; 
import org.slf4j.LoggerFactory; 
private static final Logger logger = LoggerFactory.getLogger(Abc.class);
複製代碼

日誌框架

Java中的日誌框架分以下幾種：api

  • Log4j Apache Log4j是一個基於Java的日誌記錄工具。它是由Ceki Gülcü獨創的，如今則是Apache軟件基金會的一個項目。微信

  • Log4j 2 Apache Log4j 2是apache開發的一款Log4j的升級產品。框架

  • Commons Logging Apache基金會所屬的項目，是一套Java日誌接口，以前叫Jakarta Commons Logging，後改名爲Commons Logging。工具

  • Slf4j 相似於Commons Logging，是一套簡易Java日誌門面，自己並沒有日誌的實現。（Simple Logging Facade for Java，縮寫Slf4j）。源碼分析

  • Logback 一套日誌組件的實現(slf4j陣營)。性能

  • Jul (Java Util Logging),自Java1.4以來的官方日誌實現。

使用示例

  • Jul
import java.util.logging.Logger;

private static final Logger logger = Logger.getLogger("name");
...
try {
...
} catch (Exception e) {
    logger.error(".....error");
}

if(logger.isDebugEnabled()) {
    logger.debug("....." + name);
}
複製代碼
  • Log4j
import org.apache.log4j.Logger;

private static final Logger logger = Logger.getLogger(Abc.class.getNeme());
...
try {
...
} catch (Exception e) {
    logger.error(".....error");
}

if(logger.isDebugEnabled()) {
    logger.debug("....." + name);
}
複製代碼
  • Commons Logging
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

private static final Log logger = LogFactory.getLogger(Abc.class);
...
try {
...
} catch (Exception e) {
    logger.error(".....error");
}

if(logger.isDebugEnabled()) {
    logger.debug("....." + name);
}
複製代碼
  • Slf4j
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

private static final Logger logger = LoggerFactory.getLogger(Abc.class);
...
try {
...
} catch (Exception e) {
    logger.error(".....error {}", e.getMessage(), e);
}

logger.debug(".....{}", name);
複製代碼
  • Jul
    • 不支持佔位符
    • 具體日誌實現
  • Log4j
    • 不支持佔位符
    • 具體日誌實現
  • Logback
    • 不支持佔位符
    • 具體日誌實現
  • Commons Logging
    • 不支持佔位符
    • 日誌門面
  • Slf4j
    • 支持佔位符
    • 日誌門面

Slf4j中有一個很重要的特性：佔位符，{}能夠拼接任意字符串，相好比其餘框架的優勢即不須要用+來拼接字符串，也就不會建立新的字符串對象，因此像log4j中須要加isDebugEnabled()的判斷就是這個道理，在slf4j中就不須要加判斷。

門面模式

門面(Facade)模式，又稱外觀模式，對外隱藏了系統的複雜性，並向客戶端提供了能夠訪問的接口，門面模式的好處是將客戶端和子系統鬆耦合，方便子系統的擴展和維護。

正是門面模式這樣的特色，使用Slf4j門面，無論日誌組件使用的是log4j仍是logback等等，對於調用者而言並不關心使用的是什麼日誌組件，並且對於日誌組件的更換或者升級，調用的地方也不要作任何修改。

源碼分析

此處應有代（zhang）碼（sheng）：

首先使用靜態工廠來獲取Logger對象，傳入的class，最終會轉化爲name，每一個類的日誌處理可能不一樣，因此根據傳入類的名字來判斷類的實現方式

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

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

真正核心的在getILoggerFactory()中，首先判斷初始化的狀態INITIALIZATION_STATE，若是沒有初始化UNINITIALIZED，那麼會更改狀態爲正在初始化ONGOING_INITIALIZATION，並執行初始化performInitialization()，初始化完成以後，判斷初始化的狀態，若是初始化成功SUCCESSFUL_INITIALIZATION，那麼會經過StaticLoggerBinder獲取日誌工廠getLoggerFactory()，這裏又涉及到了單例模式。

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("org.slf4j.LoggerFactory could not be successfully initialized. See also http://www.slf4j.org/codes.html#unsuccessfulInit");
        case ONGOING_INITIALIZATION:
            return TEMP_FACTORY;
    }
    throw new IllegalStateException("Unreachable code");
}
複製代碼

接着咱們分析performInitialization是如何初始化的，首先是執行bind()方法，而後判斷若是狀態爲初始化成功SUCCESSFUL_INITIALIZATION，執行版本檢查，主要是檢查jdk版本與slf4j的版本，看是否匹配。

private static final void performInitialization() {
    bind();
    if (INITIALIZATION_STATE == 3) {
        versionSanityCheck();
    }
}
複製代碼

bind()方法，首先獲取實現日誌的加載路徑，檢查路徑是否合法，而後初始化StaticLoggerBinder的對象，尋找合適的實現方式使用。

private static final void bind() {
    try {
        Set staticLoggerBinderPathSet = findPossibleStaticLoggerBinderPathSet();
        reportMultipleBindingAmbiguity(staticLoggerBinderPathSet);

        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 http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.");
        } else {
            failedBinding(ncde);
            throw ncde;
        }
    } catch (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);
    }
}
複製代碼

能夠看出，bind()方法中最重要的方法就是尋找實現方式findPossibleStaticLoggerBinderPathSet，具體方法實現以下：

private static Set findPossibleStaticLoggerBinderPathSet() {
    Set staticLoggerBinderPathSet = new LinkedHashSet();
    try {
        ClassLoader loggerFactoryClassLoader = LoggerFactory.class.getClassLoader();
        Enumeration paths;
        Enumeration paths;
        if (loggerFactoryClassLoader == null) {
            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;
}
複製代碼

注意！！前方高能！！

Slf4j的絕妙之處就在於此，類加載器加載類，也就是說尋找StaticLoggerBinder.class文件，而後只要實現了這個類的日誌組件，均可以做爲一種實現，若是有多個實現，那麼誰先加載就使用誰，這個地方涉及JVM的類加載機制

橋接

  • Slf4j與其餘日誌組件的橋接（Bridge）
  • slf4j-log4j12-1.7.13.jar
    • log4j1.2版本的橋接器
  • slf4j-jdk14-1.7.13.jar
    • java.util.logging的橋接器
  • slf4j-nop-1.7.13.jar
    • NOP橋接器
  • slf4j-simple-1.7.13.jar
    • 一個簡單實現的橋接器
  • slf4j-jcl-1.7.13.jar
    • Jakarta Commons Logging 的橋接器. 這個橋接器將SLF4j全部日誌委派給JCL
  • logback-classic-1.0.13.jar(requires logback-core-1.0.13.jar)
    • slf4j的原生實現，logback直接實現了slf4j的接口，所以使用slf4j與logback的結合使用也意味更小的內存與計算開銷

Slf4j Manual中有一張圖清晰的展現了接入方式，以下：

橋接

  • Bridging legacy APIs（橋接遺留的api）
  • log4j-over-slf4j-version.jar * 將log4j重定向到slf4j
  • jcl-over-slf4j-version.jar
    • 將commos logging裏的Simple Logger重定向到slf4j
  • jul-to-slf4j-version.jar
    • 將Java Util Logging重定向到slf4j

橋接遺留api

  • 橋接注意事項

在使用slf4j橋接時要注意避免造成死循環，在項目依賴的jar包中不要存在如下狀況

  • log4j-over-slf4j.jar和slf4j-log4j12.jar同時存在
  • 從名字上就能看出，前者重定向給後者，後者又委派給前者，會造成死循環
  • jul-to-slf4j.jar和slf4j-jdk14.jar同時存在
    • 從名字上就能看出，前者重定向給後者，後者又委派給前者，會造成死循環

總結

  • 爲了更好的瞭解Slf4j，你須要瞭解：

    • JVM類加載機制
    • 設計模式：門面模式、橋接模式

  • 簡單總結Slf4j的原理：

    • 經過工廠類，提供一個的接口，用戶能夠經過這個門面，直接使用API實現日誌的記錄。
    • 而具體實現由Slf4j來尋找加載，尋找的過程，就是經過類加載加載org/slf4j/impl/StaticLoggerBinder.class的文件，只要實現了這個文件的日誌實現系統，均可以做爲一種實現方式。
    • 若是找到不少種方式，那麼就尋找一種默認的方式。
    • 這就是日誌接口的工做方式，簡單高效，關鍵是徹底解耦，不須要日誌實現部分提供任何的修改配置，只須要符合接口的標準就能夠加載進來，有利於維護和各個類的日誌處理方式統一。

微信公衆號： 碼上論劍
請關注個人我的技術微信公衆號，訂閱更多內容
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程