编码中日志使用规范

阅读更多

1. 编码中请统一使用commons-logging包
2. 日志声明：

    

   private static final Log LOG = LogFactory.getLog(ClassName.class);

    注意：ClassName是当前类的名称；最好不要从其他类copy过来这段声明，如果忘记了更改ClassName，这样会出问题的（张冠李戴）

3. 使用之前，先做判断

   if (LOG.isInfoEnabled()) {
       LOG.info("Some infomation to print out in english");
   }
   

    

   注意：不要使用中文打印日志信息，中文日志在Linux服务器上不能很好识别

4. 异常处理： 
   

   try {
       doSomeThing();
   } catch (SomeRuntimeException e) {// 不要捕捉UnCheckedException，如空指针，数组越界等异常
        if (LOG.isErrorEnabled())  {
           LOG.error(e.getMessage, e);
           // LOG.error("Some information to print out in english", e);
       }
   }

   注意：打印错误信息时，一定带上第二个参数e，否则日志中原始异常堆栈会丢失

5. 参考好文：Commons-logging + Log4j 入门指南