日志规约

使用日志框架API

  应用中不可直接使用日志系统(Log4j、Logback)中的 API,而应依赖使用日志框架SLF4J 中的 API,使用门面模式的日志框架,有利于日志框架的升级和使用统一。

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

保存时间

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

避免重复打印

  务必在 log4j.xml 中设置 additivity=false,如代码所示:

<logger name="com.taobao.dubbo.config" additivity="false"> 

打印方式和输出内容

  • 对 trace/debug/info 级别的日志输出,必须使用条件输出形式或者使用占位符的方式。
//示例:使用占位符
logger.debug("Processing trade with id: {} and symbol : {} ", id, symbol); 

//反例:如果日志级别是 warn,上述日志不会打印,但是会执行字符串拼接操作,如果 symbol 是对象,会执行 toString()方法,浪费了系统资源,执行了上述操作,最终日志却没有打印。
logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);
  • 异常信息应该包括两类信息:案发现场信息和异常堆栈信息。如果不处理,那么通过
    关键字 throws 往上抛出
logger.error(各类参数或者对象 toString + "_" + e.getMessage(), e);

线上环境禁止使用System.out()、System.err或者e.printStackTrace()打印日志

转载:阿里巴巴Java开发手册

猜你喜欢

转载自blog.csdn.net/yangguosb/article/details/80324002