关于打印debug日志是否加判断日志级别的分析

一、问题由来

在代码中,我们经常会看到打印debug日志的时候,会判断下当前的日志级别:

if (LOGGER.isDebugEnabled()) {
    LOGGER.debug(... ...);
}

到底有没有必要呢?到底有没有必要呢?到底有没有必要呢

二、答案

为了节省大家的时间,先上答案。

1、如果打印的实参不含计算的,【完全没有必要】

String demo = "demo";
LOGGER.debug("i am a {}", demo); // 实参为: i am a {} 和demo两个

2、如果打印的实参含有计算的,【完全有必要】

Demo demo = new Demo();
LOGGER.debug("i am a " + "demo"); // 实参为: i am a demo,需要先进行实参计算
LOGGER.debug("i am a {}", demo.toString()); // 实参为:i am a {} 和demo.toString(),后者需要计算

三、实验探究

1、Log4j 源码

debug()方法中,一开始就做了和isDebugEnabled()一样的事情,那是不是就不需要判断了?

public boolean isDebugEnabled() {  
    if(repository.isDisabled( Level.DEBUG_INT))  
        return false;  
    return Level.DEBUG.isGreaterOrEqual(this.getEffectiveLevel());  
} 
​
public void debug(Object message) {  
    if(repository.isDisabled(Level.DEBUG_INT))  
        return;  
    if(Level.DEBUG.isGreaterOrEqual(this.getEffectiveLevel())) {  
        forcedLog(FQCN, Level.DEBUG, message, null);  
    }  
} 

2、Log4j的占位符

网上的博客存在大量的分析,说开启了占位符{},完全不用判断。真的是这样吗?

// 虽然不会输出日志,但是demo.toString()确实是执行了
LOGGER.debug("{} {}", "a", demo.toString());

3、Java编译器的实参执行顺序:实参从左到右,最后是执行方法

这问题其实和log4j的关系不大,真正的原因是实参的执行顺序以及计算。😅

public class Test {
    public static String fun1() { System.out.println("fun1"); return "fun1 "; }
    public static String fun2() { System.out.println("fun2"); return "fun2"; }
    public static void test(String s1, String s2) { System.out.println(s1 + s2); }
​
    public static void main(String[] args) {
        test(fun1(), fun2()); 
    }
}
// console: 
fun1
fun2
fun1 fun2

结论:打印debug日志,如果需要打印的数据需要计算实参的,必须加判断。这是因为不管debug()里面具体执不执行,实参的方法调用确实是执行了。

不好的例子:

LOGGER.debug("a" + "b");
LOGGER.debug("" + JSON.toJSONString(demo));
LOGGER.debug("{}", JSON.toJSONString(demo));

好的例子:

LOGGER.debug("{} {}","a","b");
LOGGER.debug("{}", demo);

4、结论

如果debug()里面的含有实参计算的,必须加判断。

推荐一种JSON序列化对象的方式:

public class Log {
    @Override
    public String toString() {
        System.out.println("toString");
        return JSON.toJSONString(this);
    }
}
​
public class Test {
    private static final Logger LOGGER = LoggerFactory.getLogger(Test.class);
  
    public static void main(String[] args) {
        Log log = new Log();
        LOGGER.debug("{}", log); // 实际运行时才会调用其toString()方法 - JSON方法
    }
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,233评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,013评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,030评论 0 241
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,827评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,221评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,542评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,814评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,513评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,225评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,497评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,998评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,342评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,986评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,055评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,812评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,560评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,461评论 2 266

推荐阅读更多精彩内容

  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 4,817评论 1 13
  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 4,907评论 0 6
  • idea 添加注释/** 然后回车 选中代码块 Ctrl+Shift+/ 重点推荐阅读:https://www....
    Helen_Cat阅读 19,403评论 0 37
  • 在项目开发过程中,我们可以通过 debug 查找问题。而在线上环境我们查找问题只能通过打印日志的方式查找问题。因此...
    Java架构阅读 3,407评论 2 41
  • 【原文】路遇长, 疾趋揖, 长无言 ,退恭立 【翻译】路上遇见长辈,应快步向前问好。长辈没有事时,即恭敬退后站立一...
    人力资源管理中心阅读 696评论 0 2