您好,登錄后才能下訂單哦!
slf4j中橋接器運(yùn)行的原理是什么?相信很多沒(méi)有經(jīng)驗(yàn)的人對(duì)此束手無(wú)策,為此本文總結(jié)了問(wèn)題出現(xiàn)的原因和解決方法,通過(guò)這篇文章希望你能解決這個(gè)問(wèn)題。
在日志框架 slf4j 中有一組項(xiàng)目,除了核心的 slf4j-api 之外,還有 slf4j-log4j12、slf4j-jdk14 等項(xiàng)目。這一類項(xiàng)目統(tǒng)稱橋接器項(xiàng)目,針對(duì)不同的日志框架有不同的橋接器項(xiàng)目。
在使用 logback 日志框架時(shí),并沒(méi)有針對(duì)的橋接器,這是因?yàn)?logback 與 slf4j 是一個(gè)作者所寫(xiě),在 logback 中直接實(shí)現(xiàn)了 slf4j 的 SPI 機(jī)制。
但如果使用其他日志框架,那么就必須要用到橋機(jī)器相關(guān)依賴。比如,當(dāng)我們基于 log4j 使用 slf4j 時(shí),除了需要引入 log4j 的 jar 包依賴,還需要引入 slf4j 的下面兩個(gè)依賴:
<dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-log4j12</artifactId> </dependency>
slf4j-api 為核心依賴,必須引入,而 slf4j-log4j12 就是橋接器用來(lái)在 slf4j 和 log4j 之間進(jìn)行過(guò)渡和封裝。下面,我們就聊聊橋接器項(xiàng)目的核心實(shí)現(xiàn)。
slf4j-log4j12 橋接器的價(jià)值
要了解橋接器的運(yùn)作,首先需要回顧一下 slf4j 的 SPI 機(jī)制。在我們通過(guò) LoggerFactory.getLogger(Foo.class); 時(shí),slf4j 會(huì)通過(guò) SPI 機(jī)制尋找并初始化 SLF4JServiceProvider 的實(shí)現(xiàn)類。
然后,通過(guò) SLF4JServiceProvider 的實(shí)現(xiàn)類來(lái)獲取日志相關(guān)的具體工廠類對(duì)象,進(jìn)而進(jìn)行日志功能的處理。先來(lái)看一下 SLF4JServiceProvider 的接口定義:
public interface SLF4JServiceProvider { /** * 返回ILoggerFactory的實(shí)現(xiàn)類,用于LoggerFactory類的綁定 */ ILoggerFactory getLoggerFactory(); /** * 返回IMarkerFactory實(shí)例 */ IMarkerFactory getMarkerFactory(); /** * 返回MDCAdapter實(shí)例 */ MDCAdapter getMDCAdapter(); /** * 獲取請(qǐng)求版本 */ String getRequesteApiVersion(); /** * 初始化,實(shí)現(xiàn)類中一般用于初始化ILoggerFactory等 */ void initialize(); }
SLF4JServiceProvider 接口是在 slf4j-api 中定義的,具體的實(shí)現(xiàn)類由其他日志框架來(lái)完成。但是像 log4j(logback“敵對(duì)陣營(yíng)”)是不會(huì)在框架內(nèi)實(shí)現(xiàn)該接口的。那么,怎么辦?
針對(duì)此問(wèn)題,slf4j 提供了 slf4j-log4j12 這類橋接器的過(guò)渡項(xiàng)目。在其中實(shí)現(xiàn) SLF4JServiceProvider 接口,并對(duì) Log4j 日志框架接口進(jìn)行封裝,將 Logger(slf4j) 接收到的命令全部委托給 Logger(log4j) 去完成,在使用者無(wú)感知的情況下完成偷天換日。
slf4j-log4j12 的核心實(shí)現(xiàn)類
理解了橋接器的存在價(jià)值及原理,下面就來(lái)看看 slf4j-log4j12 是如何實(shí)現(xiàn)這一功能的。
首先來(lái)看看核心實(shí)現(xiàn)類之一 Log4j12ServiceProvider。它實(shí)現(xiàn)了 SLF4JServiceProvider 接口,主要功能就是完成接口中定義的相關(guān)工廠接口的實(shí)現(xiàn)。源代碼如下:
public class Log4j12ServiceProvider implements SLF4JServiceProvider { public static String REQUESTED_API_VERSION = "1.8.99"; private ILoggerFactory loggerFactory; private IMarkerFactory markerFactory; private MDCAdapter mdcAdapter; public Log4j12ServiceProvider() { try { @SuppressWarnings("unused") 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"); } } @Override public void initialize() { loggerFactory = new Log4jLoggerFactory(); markerFactory = new BasicMarkerFactory(); mdcAdapter = new Log4jMDCAdapter(); } @Override public ILoggerFactory getLoggerFactory() { return loggerFactory; } @Override public IMarkerFactory getMarkerFactory() { return markerFactory; } @Override public MDCAdapter getMDCAdapter() { return mdcAdapter; } @Override public String getRequesteApiVersion() { return REQUESTED_API_VERSION; } }
該類的實(shí)現(xiàn)看起來(lái)很簡(jiǎn)單,構(gòu)造方法中通過(guò)嘗試使用 log4j 的 Level.TRACE 調(diào)用來(lái)驗(yàn)證 log4j 的版本是否符合要求。log4j1.2.12 之前并沒(méi)有 Level.TRACE,所以會(huì)拋出異常,并打印日志信息。不得不贊嘆作者在此處檢查版本的巧妙用法。
而這里對(duì)接口中返回的實(shí)現(xiàn)類主要通過(guò) initialize() 方法來(lái)實(shí)現(xiàn)的。這里我們重點(diǎn)看 Log4jLoggerFactory 類的實(shí)現(xiàn)。
public class Log4jLoggerFactory implements ILoggerFactory { private static final String LOG4J_DELEGATION_LOOP_URL = "http://www.slf4j.org/codes.html#log4jDelegationLoop"; // check for delegation loops static { try { Class.forName("org.apache.log4j.Log4jLoggerFactory"); String part1 = "Detected both log4j-over-slf4j.jar AND bound slf4j-log4j12.jar on the class path, preempting StackOverflowError. "; String part2 = "See also " + LOG4J_DELEGATION_LOOP_URL + " for more details."; Util.report(part1); Util.report(part2); throw new IllegalStateException(part1 + part2); } catch (ClassNotFoundException e) { // this is the good case } } ConcurrentMap<String, Logger> loggerMap; public Log4jLoggerFactory() { loggerMap = new ConcurrentHashMap<>(); // force log4j to initialize org.apache.log4j.LogManager.getRootLogger(); } @Override 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; } } }
在 Log4j12ServiceProvider 中進(jìn)行了 Log4jLoggerFactory 的實(shí)例化操作,也就直接 new 出來(lái)一個(gè)對(duì)象。我們知道,在 new 對(duì)象執(zhí)行會(huì)先執(zhí)行 static 代碼塊,本類的靜態(tài)代碼塊的核心工作就是檢查依賴文件中是否同時(shí)存在反向橋接器的依賴。
其中,org.apache.log4j.Log4jLoggerFactory 是反向橋接器 log4j-over-slf4j 項(xiàng)目中的類,如果加裝到了,說(shuō)明存在,則拋出異常,打印日志信息。此處再次贊嘆作者運(yùn)用的技巧的巧妙。
在 Log4jLoggerFactory 的構(gòu)造方法中,做了兩件事:第一,初始化一個(gè) ConcurrentMap 變量,用于存儲(chǔ)實(shí)例化的 Logger;第二,強(qiáng)制初始化 log4j 的組件,其中強(qiáng)制初始化 log4j 的組件是通過(guò) getRootLogger 方法,來(lái)初始化一些靜態(tài)的變量。
構(gòu)造方法時(shí)初始化了 ConcurrentMap 變量,在 Log4jLoggerFactory 實(shí)現(xiàn)的 getLogger 方法中,先從 Map 中獲取一下是否存在對(duì)應(yīng)的 Logger,如果存在直接返回,如果不存在則進(jìn)行構(gòu)造。而構(gòu)造的 Log4jLoggerAdapter 類很顯然使用了適配器模式,它內(nèi)部持有了 log4j 的 Logger 對(duì)象,自身又實(shí)現(xiàn)了 slf4j 的 Logger 接口。
下面看一下 Log4jLoggerAdapter 的部分代碼實(shí)現(xiàn):
public final class Log4jLoggerAdapter extends LegacyAbstractLogger implements LocationAwareLogger, Serializable { final transient org.apache.log4j.Logger logger; Log4jLoggerAdapter(org.apache.log4j.Logger logger) { this.logger = logger; this.name = logger.getName(); traceCapable = isTraceCapable(); } @Override public boolean isDebugEnabled() { return logger.isDebugEnabled(); } @Override public void log(Marker marker, String callerFQCN, int level, String msg, Object[] arguments, Throwable t) { Level log4jLevel = toLog4jLevel(level); NormalizedParameters np = NormalizedParameters.normalize(msg, arguments, t); String formattedMessage = MessageFormatter.basicArrayFormat(np.getMessage(), np.getArguments()); logger.log(callerFQCN, log4jLevel, formattedMessage, np.getThrowable()); } public void log(LoggingEvent event) { Level log4jLevel = toLog4jLevel(event.getLevel().toInt()); if (!logger.isEnabledFor(log4jLevel)) return; org.apache.log4j.spi.LoggingEvent log4jevent = toLog4jEvent(event, log4jLevel); logger.callAppenders(log4jevent); } // 省略其他方法 }
源碼中,通過(guò)構(gòu)造方法傳入 log4j 的 Logger 對(duì)象,而 Log4jLoggerAdapter 對(duì)外提供的方法,都是通過(guò) log4j 的 Logger 進(jìn)行具體實(shí)現(xiàn)。
總之,slf4j 的 Logger 接口的方法通過(guò) Log4jLoggerAdapter 進(jìn)行包裝和轉(zhuǎn)換,交由 log4j 的 Logger 去執(zhí)行,這就達(dá)到了連接 slf4j-api 和 log4j 的目的。而此時(shí),slf4j-api 不并關(guān)系日志是如何實(shí)現(xiàn)記錄,對(duì)此也無(wú)感知。
看完上述內(nèi)容,你們掌握slf4j中橋接器運(yùn)行的原理是什么的方法了嗎?如果還想學(xué)到更多技能或想了解更多相關(guān)內(nèi)容,歡迎關(guān)注億速云行業(yè)資訊頻道,感謝各位的閱讀!
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。