输出debug日志前需要isDebugEnabled吗

最近在看一些代码时,发现经常在输出debug级别日志前做if判断,如下面的这段代码:

if(LOGGER.isDebugEnabled()){
    LOGGER.debug("name {}",name);
}

目的应该是作者想尽量的提高性能,减少不必要的输出。但是个人觉的这些应该是日志框架应该处理好的,因此对这个做了一些简单的调研

这样做的原因

网上查了下,以前某些日志框架是不支持的"{}"占位符的,日志是这样输出的

LOGGER.debug("name "+ name);

也就是用拼接字符串的方式。这样在程序执行到LOGGER.debug()时进行字符串拼接,会带来很多无意义的性能损耗。因此,以前的程序都会在外面包一层if判断

if(LOGGER.isDebugEnabled()){
    LOGGER.debug("name "+name);
}

由于运行过程中JIT会进行语句优化,发现LOGGER.isDebugEnabled()为false后,会将整个语句块去除掉。这样,就避免了日志级别大于debug时会进行无意义的字符串拼接了。

目前主流的一些日志框架都已经支持用占位符的形式输出日志,因此,if判断带来的性能优化效果并不会太大。

直接输出和加if判断的对比

logback框架会在输出debug日志时进行一些判断做优化,避免无意义的输出。我们可以对比下两种方式的源码实现:

下面的logback关于LOGGER.debug的实现源码

    //ch.qos.logback.classic.Logger类
    public void debug(Marker marker, String msg, Throwable t) {
        this.filterAndLog_0_Or3Plus(FQCN, marker, Level.DEBUG, msg, (Object[])null, t);
    }

    private void filterAndLog_0_Or3Plus(String localFQCN, Marker marker, Level level, String msg, Object[] params, Throwable t) {
        FilterReply decision = this.loggerContext.getTurboFilterChainDecision_0_3OrMore(marker, this, level, msg, params, t);
        
        if (decision == FilterReply.NEUTRAL) {
            //如果实际日志级别比所用的日志级别大,就直接return,不用输出了
            if (this.effectiveLevelInt > level.levelInt) {
                return;
            }
        } else if (decision == FilterReply.DENY) {
            return;
        }

        this.buildLoggingEventAndAppend(localFQCN, marker, level, msg, params, t);
    }

//LoggerContext.java
    final FilterReply getTurboFilterChainDecision_0_3OrMore(Marker marker, Logger logger, Level level, String format, Object[] params, Throwable t) {
        return this.turboFilterList.size() == 0 ? FilterReply.NEUTRAL : this.turboFilterList.getTurboFilterChainDecision(marker, logger, level, format, params, t);
    }

从代码可以看到,如果设置的日志级别是比DEBUG大的级别,那么在执行LOGGER.debug()时,几乎就走了2、3步就返回了,下面我们再看一下LOGGER.isDebugEnabled()的相关源码

public boolean isDebugEnabled() {
        return this.isDebugEnabled((Marker)null);
}
public boolean isDebugEnabled(Marker marker) {
        FilterReply decision = this.callTurboFilters(marker, Level.DEBUG);
        if (decision == FilterReply.NEUTRAL) {
            return this.effectiveLevelInt <= 10000;
        } else if (decision == FilterReply.DENY) {
            return false;
        } else if (decision == FilterReply.ACCEPT) {
            return true;
        } else {
            throw new IllegalStateException("Unknown FilterReply value: " + decision);
        }
}
//这里的getTurboFilterChainDecision_0_3OrMore和上面执行LOGGER.DEBUG()的一样
private FilterReply callTurboFilters(Marker marker, Level level) {
        return this.loggerContext.getTurboFilterChainDecision_0_3OrMore(marker, this, level, (String)null, (Object[])null, (Throwable)null);
}

所以,要判断isDebugEnabled(),做的逻辑其实和上面LOGGER.debug()做的差不多,底层都是调用getTurboFilterChainDecision_0_3OrMore()方法然后进行一些逻辑判断。

因此,从这个角度出发,完全没必要再输出debug日志前加一层if判断。

结论

排除字符串拼接造成的性能损耗外(如果使用占用符就可以忽略这个损耗),个人觉的完全没必要在输出debug日志前加if(LOGGER.isDebugEnabled())。加了性能没得到提高,还增加了代码量,多此一举。

PS:在spring的源码中,输出日志前基本都会加一个if判断日志级别。不过这应该是spring输出日志都用字符串拼接而不是占位符的原因。

另外,本人的结论也不一定完全正确,欢迎有不一致意见的人在下方留言探讨。

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

推荐阅读更多精彩内容

  • From:Python之日志处理(logging模块) - 云游道士 - 博客园 https://www.cnbl...
    vigny的先生阅读 2,679评论 3 5
  • 说在之前的话 本次交流所有的信息都是个人感受,有其他意见大家可以一起交流。正所谓文无第一,武无第二。在没有严格的规...
    丁逸阅读 1,389评论 3 2
  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 4,975评论 0 6
  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 4,997评论 1 13
  • 读完《摆渡人》后有一点点感动,也许是那份纯洁的感情,也许是份奋不顾身的勇气,也许是故事其中深藏的含义…… 随后我在...
    魏薇天赋解读阅读 335评论 1 2