阿里Java开发手册思考(三)

题图:by pixel2013 From pixabay

上期我们分享了Java中if/else复杂逻辑的处理

本期我们将分享Java中日志的处理(上)

想必大家都用过日志,虽然日志看起来可有可无,但是等到出问题的时候,日志就派上了大用场,所以说日志打得好不好,规范不规范,直接影响了解决生产环境故障的效率,日志打的不好,有可能影响环境的性能,也有可能影响排查问题的难易程度,有可能排查问题的时间比写代码的时间还有多。

那么我们就来分析下阿里Java开发手册--日志规约第一条:
【强制】应用中不可直接使用日志系统(Log4j、Logback)中的 API,而应依赖使用日志框架 SLF4J 中的 API,使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一。

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

日志框架

Java中的日志框架分如下几种:

  • 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的文件,只要实现了这个文件的日志实现系统,都可以作为一种实现方式。
    • 如果找到很多种方式,那么就寻找一种默认的方式。
    • 这就是日志接口的工作方式,简单高效,关键是完全解耦,不需要日志实现部分提供任何的修改配置,只需要符合接口的标准就可以加载进来,有利于维护和各个类的日志处理方式统一
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,686评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,668评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,160评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,736评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,847评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,043评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,129评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,872评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,318评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,645评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,777评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,470评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,126评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,861评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,095评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,589评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,687评论 2 351

推荐阅读更多精彩内容