2. 阿里巴巴Java开发手册主题

• 设计思路
  • 强制

    • 应用中不可直接使用日志系统（Log4j、Logback）中的API，而应依赖使用日志框架 SLF4J中的API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。

      import org.slf4j.Logger;
      import org.slf4j.LoggerFactory;
      private static final Logger logger = LoggerFactory.getLogger(Test.class);
      

      • 经验：为了方便切换不同的日志框架，避免依赖于具体的日志框架

    • 所有日志文件至少保存15天，因为有些异常具备以“周”为频次发生的特点。网络运行状态、安全相关信息、系统监测、管理后台操作、用户敏感操作需要留存相关的网络日志不少于6个月。

      • 经验：保留的日志可以按天放到不同的文件中

    • 应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：appName_logType_logName.log。logType:日志类型，如stats/monitor/access等；logName:日志描述。这种命名的好处：通过文件名就可知道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找。

      • 说明：推荐对日志进行分类，如将错误日志和业务日志分开存放，便于开发人员查看，也便于通过日志对系统进行及时监控。
      • 正例：force-web应用中单独监控时区转换异常，如：force_web_timeZoneConvert.log
      • 经验：还可以按日期来拆分大的日志文件

    • 异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字throws往上抛出。

      • 正例：logger.error(各类参数或者对象toString() + "_" + e.getMessage(), e);
      • 经验：现场信息即出错当时的数据情况

    • 国际化团队或海外部署的服务器由于字符集问题，使用全英文来注释和描述日志错误信息。

  • 推荐
    • 谨慎地记录日志。生产环境禁止输出debug日志；有选择地输出info日志；如果使用warn来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。
      • 说明：大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。记录日志时请思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？
      • 经验：因此在打日志时，一定要分配合适的日志级别
    • 尽量用英文来描述日志错误信息，如果日志中的错误信息用英文描述不清楚的话使用中文描述即可，否则容易产生歧义
• 具体情况
  • 强制

    • 在日志输出时，字符串变量之间的拼接使用占位符的方式。

      • 说明：因为String字符串的拼接会使用StringBuilder的append()方式，有一定的性能损耗。使用占位符仅是替换动作，可以有效提升性能。
      • 正例：logger.debug("Processing trade with id: {} and symbol: {}", id, symbol);

    • 对于trace/debug/info级别的日志输出，必须进行日志级别的开关判断。

      • 说明：虽然在debug(参数)的方法体内第一行代码isDisabled(Level.DEBUG_INT)为真时（Slf4j的常见实现Log4j和Logback），就直接return，但是参数可能会进行字符串拼接运算。此外，如果debug(getName())这种参数内有getName()方法调用，无谓浪费方法调用的开销。

      • 正例：

        // 如果判断为真，那么可以输出trace和debug级别的日志 
        if (logger.isDebugEnabled()) { 
            logger.debug("Current ID is: {} and name is: {}", id, getName()); 
        }
        

    • 避免重复打印日志，浪费磁盘空间，务必在log4j.xml中设置additivity=false。

      • 正例：<logger name="com.taobao.dubbo.config" additivity="false">
  • 推荐
    • 可以使用warn日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非必要，请不要在此场景打出error级别，避免频繁报警。
      • 说明：注意日志输出的级别，error级别只记录系统逻辑出错、异常或者重要的错误信息。
      • 经验：一般业务异常只需要记录成warning级别