日志那些事儿——谈谈需要日志输出的client jar应该如何设计

前言

上篇文章提到了应该如何设计需要输出日志的client jar,大概有三个比较重要的点。

  • 缩小jar包依赖范围,如果是基于maven,可以把client工程中依赖的日志相关jar scope设置为provided.
  • “感知”应用系统所使用的日志框架,匹配相应的日志框架
  • 不使用配置文件,改用编码配置logger

其中第一点非常好实现。本文着重分析第二点与第三点的思路和关键代码。

如何“感知”日志框架

记得很早之前第一次和彭老师喝咖啡的时候,彭老师问我最近在干啥,我说在做公司的权限平台。彭老师问我要设计的时候最开始想到的方案是啥,我说看了看网上的设计好像能满足项目的需求。彭老师说道你一开始其实应该想到像windows操作是怎么考虑权限问题的,看看它的设计说不定能找到灵感有更好地设计方案。
当然彭老师只是提供了一种思路,当面对问题的时候可以想想看有没有人已经很好得解决了这个问题。所以当我要在client jar中“感知”日志框架时,我会先想想在哪些场景下别人和我会有同样的需求。很明显,在一些中间件或者一些框架中会有这种需要,很多中间件会需要输出日志供调试和排错等。
所以,关于如何“感知”日志框架,我在某中间件中找到了答案,该中间件和我有同样的需求场景。对于我们平常使用来说,最重要的两种日志框架是log4j、logback,最重要的日志门面是slf4j、common-logging等,在本文场景中,暂不考虑log4j2。
“感知”日志框架,某中间件中是这么做的。

static {
        try {
            setLoggerFactory(new Slf4jLoggerFactory());
        } catch (Throwable var3) {
            try {
                setLoggerFactory(new Log4jLoggerFactory());              
            } catch (Throwable var2) {
                setLoggerFactory(new NopLoggerFactory());
            }
        } 
    }

public Slf4jLoggerFactory() throws ClassNotFoundException {    Class.forName("org.slf4j.impl.StaticLoggerBinder");
}

看见没,就是如此的简单粗暴,要判断系统中是否使用了slf4j,只需要判断“org.slf4j.impl.StaticLoggerBinder”是否存在。这种做法勉强可以算是对的吧,因为如果不使用slf4j,那引入slf4j的相关jar干嘛。这种做法简单粗暴,但是确实可行。

不使用配置文件,改用编码配置logger

前文提到了,如果要适配多种日志框架,那么就需要在client jar的classpath下准备多种不同的日志配置文件。使用配置文件不灵活,那么是否存在不使用配置文件的方式对Logger进行相关设置呢。答案肯定是有,那就是使用代码进行动态配置。
在对logback和log4j的源码进行分析的过程中提到,在logger.info过程中,会调用logger中所有的appender,那么我们要配置日志输出的路径,pattern等,只需要设置相应的appender就行,下文就将分别介绍如何使用代码设置logger的Appender

普通log4j appender设置

    public void configureAppender(org.apache.log4j.Logger logger, String name, String pattern,String fileName){
            DailyRollingFileAppender appender = new DailyRollingFileAppender();
        appender.setName(name);
        appender.setLayout(new PatternLayout(pattern)));
        appender.setAppend(true);
        appender.setFile(fileName);
        appender.setEncoding(encoding);
        appender.activateOptions();
        logger.removeAllAppenders();
        logger.addAppender(appender);
    }

以上代码为logger设置了一个DailyRollingFileAppender

slf4j+logback appender设置

public void configureAppender(ch.qos.logback.classic.Logger logger, String name, String pattern,String fileName){ 

        RollingFileAppender appender = new RollingFileAppender();
        appender.setContext(LogbackLoggerContextUtil.getLoggerContext());
        appender.setName(name);
        appender.setAppend(true);
        appender.setFile(fileName);
        TimeBasedRollingPolicy rolling = new TimeBasedRollingPolicy();
        rolling.setParent(appender);
        rolling.setFileNamePattern(fileName + ".%d{yyyy-MM-dd}");
        rolling.setContext(LogbackLoggerContextUtil.getLoggerContext());
        rolling.start();
        appender.setRollingPolicy(rolling);
        PatternLayout layout = new PatternLayout();
        layout.setPattern(pattern);
        layout.setContext(LogbackLoggerContextUtil.getLoggerContext());
        layout.start();
        appender.setLayout(layout);
        appender.start();
        this.logger.detachAndStopAllAppenders();
        this.logger.addAppender(appender);
        }

以上代码为logback设置了RollingFileAppender

需要注意的是,当使用slf4j的日志门面时,通过LoggerFactory.getLogger得到的logger实例实际类型不尽相同,当使用slf4j+log4j时为org.slf4j.impl.Log4jLoggerAdapter,当使用slf4j+logback时为ch.qos.logback.classic.Logger,前者需要通过反射的手段取得org.apache.log4j.Logger对其设置Appender。

关键代码已经列在上面了,很多代码其实出自官网,官方有提供使用代码进行logger的配置。最后上一张类图来说明整个设计,该类图完整地展示了如何设计一个能自适应多种日志类型的日志工具。

适配logback/log4j的日志类结构图.jpg

总结

大体的步骤就是识别日志框架,使用相应日志框架得到对应的logger,例如org.apache.log4j.Logger等,根据logger的实际类型将其包装成统一的logger类型并且配置相应的Appender。类图完整地展示了整个设计。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,324评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,303评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,192评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,555评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,569评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,566评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,927评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,583评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,827评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,365评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,941评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2 342

推荐阅读更多精彩内容