日志使用规范

2019独角兽企业重金招聘Python工程师标准>>>

【强制】日志系统调用方式如下：
        import org.slf4j.Logger;
        import org.slf4j.LoggerFactory;
        private static final Logger logger = LoggerFactory.getLogger(Abc.class);        
        切记：Abc.class 必须是当前Java类。

【强制】对trace/debug/info级别的日志输出，必须使用条件输出形式或者使用占位符的方式，如下：
        logger.debug("this method with id: {} name : {} ", id, name);     

【强制】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字throws往上抛出
        正例：
        logger.error("认证失败，系统异常："+e.getMessage(), e);           
        错例：
        logger.error(e);
        logger.error(e.getMessage());
        logger.error("上下文"+e.getMessage())；        

【推荐】
    <br>谨慎地记录日志。
    <br>生产环境禁止输出debug日志；
    <br>有选择地输出info日志；
    <br>如果使用warn来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。
    <br>说明：大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。
    <br>记录日志时请思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？不要认为日志记录不怎么消耗性能，大量的垃圾日志会把系统性能严重拖慢。

【参考】可以使用warn日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。注意日志输出的级别，error级别只记录系统逻辑出错、异常等重要的错误信息。如非必要，请不要在此场景打出error级别。

转载于:https://my.oschina.net/openplus/blog/1809595