阿里巴巴java编码规范——日志规约

目录

强制

推荐

---

强制

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

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

3.应用中的扩展日志(如打点、临时监控、访问日志等)命令方式：appName_logType_logName.log。其中appName是日志的描述，logType是日志类型，如stats/monitor/access等。通过文件名可以知道日志文件属于什么应用，什么类型、什么目的，有利于归类查找。

4.在日志输出时，字符串变量之间的拼接使用占位符的方式。因为String字符串的拼接会使用StringBuffer的append()方式，有一定的性能损耗。使用占位符仅是替换动作，可以有效提升性能。

5.对于trace/debug/info级别的日志输出，必须进行日志级别的开关判断。虽然在debug的方法体内第一行代码为真时就直接return，但是参数可能会进行字符串拼接运算。此外，如果过debug这种参数内有getName()方法的调用，无谓浪费了方法调用的开销。

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

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

推荐

1.谨慎地记录日志。生产环境禁止输出debug日志；有选择地输出info日志；如果使用warn来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。

2.可以使用warn日志级别来记录用户输入参数错误的情况，避免用户投诉时无所适从。如非必要，请不要在此场景打印出error级别，避免频繁报警。

3.尽量用英文来描述日志错误信息，如果日志中的错误信息用英文描述不清楚使用中文，否则容易产生歧义。国际化或者海外部署的服务器由于字符集问题，使用全英文来注释和描述日志错误信息。