if (log.isDebugEnabled()) {}使用场景初析

问题：

在使用log4j,common-log这样的log框架时，发现很多代码中这样写
if   (log.isDebugEnabled ())   {
          log.debug( "xxxx ");
}

我很奇怪，为什么要与log.isDebugEnabled ()？既然log.debug()在没有指定输出级别为DEBUG时不会有输出，为什么还要在前面加一个isDebugEnabled ()的判断？

 

回答1：

Java代码

1.  1. 为了效率，如果上述那个代码那么简单是没有必要的      
2.  2.      
3.  3. 但是如果这样      
4.  4. if   (log.isDebugEnabled())   {      
5.  5.           log.debug(buildFullString());      
6.  6. }      
7.  7.      
8.  8. 如果这个buildFullString效率不太高，那么如果直接写log.debug(buildFullString());的话      
9.  9.      
10. 10. 虽然它不会打印语句，但是buildFullString还是被执行了，这样就白费了功夫      
11. 11.      
12. 12. 所以加上isDebugEnabled就可以避免执行buildFullString了      
13. 13.      
14. 14. 这个方法一般用在认为buildFullString这个函数效率不太高的情况下    

   1. 为了效率，如果上述那个代码那么简单是没有必要的   
   2.   
   3. 但是如果这样   
   4. if   (log.isDebugEnabled())   {   
   5.           log.debug(buildFullString());   
   6. }   
   7.   
   8. 如果这个buildFullString效率不太高，那么如果直接写log.debug(buildFullString());的话   
   9.   
  10. 虽然它不会打印语句，但是buildFullString还是被执行了，这样就白费了功夫   
  11.   
  12. 所以加上isDebugEnabled就可以避免执行buildFullString了   
  13.   
  14. 这个方法一般用在认为buildFullString这个函数效率不太高的情况下  

 

回答2：

Java代码

1. 1. 加不加if，效果相同，但是效率不同      
2. 2.      
3. 3. 在你的例子里，debug的参数就是一个string，所以没有太本质的差别      
4. 4.      
5. 5. 但是假如log.debug( "map= "   +   map) 的话，在调用debug之前，必然需要调用map.toString()，而这个操作可能导致更多的大量字符串操作，最后，才能得到这个辛辛苦苦拼接出来的结果，作为参数传入debug()，结果，这个参数却不需要（一般在log方法入口就判断输出level）。    

   1. 加不加if，效果相同，但是效率不同   
   2.   
   3. 在你的例子里，debug的参数就是一个string，所以没有太本质的差别   
   4.   
   5. 但是假如log.debug( "map= "   +   map) 的话，在调用debug之前，必然需要调用map.toString()，而这个操作可能导致更多的大量字符串操作，最后，才能得到这个辛辛苦苦拼接出来的结果，作为参数传入debug()，结果，这个参数却不需要（一般在log方法入口就判断输出level）。  

 

 

 

20090409说明：我下载了log4j的源代码,apache-log4j-1.2.15.zip。

 

org.apache.log4j包中的Category类，debug方法定义如下：

 

Java代码

1. public void debug(Object message) {   
2.   if(repository.isDisabled(Level.DEBUG_INT))   
3.     return;   
4.   if(Level.DEBUG.isGreaterOrEqual(this.getEffectiveLevel())) {   
5.     forcedLog(FQCN, Level.DEBUG, message, null);   
6.   }   
7. }  

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

分析：可以看出，在debug方法内部，也先进行了log级别的判断。

显然，在使用这个debug方法之前，首先要将参数message构筑好。这也是先使用isDebugEnabled 方法进行判断的目的。

 

（20090414追加）我的回答：在前面加不加这句if判断，结果是一样的，但是效率可能有所差别：

当输出级别是debug，即需要进行日志信息输出时，加不加这句if判断，在效率上几乎没有差别；

当输出级别高于debug，即不需要进行日志信息输出时：

①假如debug方法中的参数比较简单时（比如直接就是写好的字符串），加不加这句if判断，在效率上也几乎没有什么差别；

②假如debug方法中的参数比较复杂时（比如还要使用别的函数进行计算、或者还要进行字符串的拼接等等），在前面就加上这句if判断，会让效率提高（否则，开始大动干戈做了很多事情（比如字符串的拼接），后来才发现不需要进行输出日志信息）。

-》上面的这段分情况讨论的描述，可以作为回答这个问题的“标准”答案