java程序日志规范

1. 【强制】应用中不可直接使用日志系统( Log4j、 Logback)中的 API,而应依赖使用日志框架

SLF4J 中的 API,使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一。

1

2

3

4

5

import org.slf4j.Logger;

 

import org.slf4j.LoggerFactory;

 

private static final Logger logger = LoggerFactory.getLogger(Abc.class);

2. 【强制】日志文件推荐至少保存 15 天,因为有些异常具备以“ 周” 为频次发生的特点。

3. 【强制】应用中的扩展日志(如打点、临时监控、访问日志等)命名方式:

appName_logType_logName.log。 logType:日志类型,推荐分类有 stats/desc/monitor/visit

等; logName:日志描述。这种命名的好处:通过文件名就可知道日志文件属于什么应用,什么类型,什么目的,也有利于归类查找。

正例: mppserver 应用中单独监控时区转换异常,如:

mppserver_monitor_timeZoneConvert.log

说明: 推荐对日志进行分类,错误日志和业务日志尽量分开存放,便于开发人员查看,也便于

通过日志对系统进行及时监控。

4. 【强制】对 trace/debug/info 级别的日志输出,必须使用条件输出形式或者使用占位符的方

式。

说明: logger.debug("Processing trade with id: " + id + " symbol: " + symbol); 如果

日志级别是 warn,上述日志不会打印,但是会执行字符串拼接操作,如果 symbol 是对象,会

执行 toString()方法,浪费了系统资源,执行了上述操作,最终日志却没有打印。

正例: (条件)

1

2

3

if (logger.isDebugEnabled()) {

logger.debug("Processing trade with id: " + id + " symbol: " + symbol);

}

正例: (占位符)

logger.debug("Processing trade with id: {} and symbol : {} ", id, symbol);

5. 【强制】避免重复打印日志,浪费磁盘空间,务必在 log4j.xml 中设置 additivity=false。

正例: <logger name="com.taobao.ecrm.member.config" additivity="false">

6. 【强制】异常信息应该包括两类信息:案发现场信息和异常堆栈信息。如果不处理,那么往上

抛。

正例: logger.error(各类参数或者对象 toString + "_" + e.getMessage(), e);

7. 输出的 POJO 类必须重写 toString 方法,否则只输出此对象的 hashCode 值(地址值),没啥

参考意义。

8. 【推荐】可以使用 warn 日志级别来记录用户输入参数错误的情况,避免用户投诉时,无所适

从。注意日志输出的级别, error 级别只记录系统逻辑出错、异常、或者重要的错误信息。如

非必要,请不要在此场景打出 error 级别,避免频繁报警。

9. 【推荐】谨慎地记录日志。生产环境禁止输出 debug 日志;有选择地输出 info 日志;如果使

用 warn 来记录刚上线时的业务行为信息,一定要注意日志输出量的问题,避免把服务器磁盘

撑爆,并记得及时删除这些观察日志。

说明: 大量地输出无效日志,不利于系统性能提升,也不利于快速定位错误点。纪录日志时请

思考:这些日志真的有人看吗?看到这条日志你能做什么?能不能给问题排查带来好处?

10.【参考】如果日志用英文描述不清楚,推荐使用中文注释。对于中文 UTF-8 的日志,在 secureCRT

中, set encoding=utf-8;如果中文字符还乱码,请设置:全局>默认的会话设置>外观>字体>

选择字符集 gb2312;如果还不行,执行命令: set termencoding=gbk,并且直接使用中文来

进行检索。

 

此文章本站原创,地址 https://www.vxzsk.com/584.html   转载请注明出处!谢谢

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值