避免被diss，务必记住这些正确打日志的方式 _日志

文章插图

使用slf4j

使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。
实现方式统一使用: Logback框架

打日志的正确方式什么时候应该打日志

定位问题：当你遇到问题的时候，只能通过debug功能来确定问题，你应该考虑打日志，良好的系统，是可以通过日志进行问题定位的。
执行逻辑判断：当你碰到if…else 或者 switch这样的分支时，要在分支的首行打印日志，用来确定进入了哪个分支
功能执行流程：经常以功能为核心进行开发，你应该在提交代码前，可以确定通过日志可以看到整个流程。
......

基本格式必须使用参数化信息的方式:
logger.debug("Processing trade with id:[{}] and symbol : [{}] ", id, symbol);对于debug日志，必须判断是否为debug级别后，才进行使用:

if (logger.isDebugEnabled()) {    logger.debug("Processing trade with id: " +id + " symbol: " + symbol);}

不要进行字符串拼接,那样会产生很多String对象，占用空间，影响性能。反例(不要这么做):
logger.debug("Processing trade with id: " + id + " symbol: " + symbol);使用[]进行参数变量隔离如有参数变量，应该写成如下写法:
logger.debug("Processing trade with id:[{}] and symbol : [{}] ", id, symbol);这样的格式写法，可读性更好，对于排查问题更有帮助。
不同级别的使用ERROR:基本概念影响到程序正常运行、当前请求正常运行的异常情况:

打开配置文件失败
所有第三方对接的异常(包括第三方返回错误码)
所有影响功能使用的异常，包括:SQLException和除了业务异常之外的所有异常(RuntimeException和Exception)

不应该出现的情况: 比如要使用Azure传图片，但是Azure未响应
如果有Throwable信息，需要记录完成的堆栈信息:
log.error("获取用户[{}]的用户信息时出错",userName,e);说明如果进行了抛出异常操作，请不要记录error日志，由最终处理方进行处理：
反例(不要这么做):

try{    ....}catch(Exception ex){  String errorMessage=String.format("Error while reading information of user [%s]",userName);  logger.error(errorMessage,ex);  throw new UserServiceException(errorMessage,ex);}

WARN基本概念不应该出现但是不影响程序、当前请求正常运行的异常情况:

有容错机制的时候出现的错误情况
找不到配置文件，但是系统能自动创建配置文件

即将接近临界值的时候，例如：缓存池占用达到警告线。
业务异常的记录,比如: 当接口抛出业务异常时，应该记录此异常。
INFO:基本概念系统运行信息

Service方法中对于系统/业务状态的变更
主要逻辑中的分步骤

外部接口部分

客户端请求参数(REST/WS)
调用第三方时的调用参数和调用结果

说明

并不是所有的service都进行出入口打点记录,单一、简单service是没有意义的(job除外,job需要记录开始和结束,) 。反例(不要这么做):public List listByBaseType(Integer baseTypeId) {
log.info("开始查询基地");
BaseExample ex=new BaseExample();
BaseExample.Criteria ctr = ex.createCriteria();
ctr.andIsDeleteEqualTo(IsDelete.USE.getValue());
Optionals.doIfPresent(baseTypeId, ctr::andBaseTypeIdEqualTo);
log.info("查询基地结束");
return baseRepository.selectByExample(ex);
}
对于复杂的业务逻辑，需要进行日志打点，以及埋点记录，比如电商系统中的下订单逻辑，以及OrderAction操作(业务状态变更) 。
对于整个系统的提供出的接口(REST/WS)，使用info记录入参
如果所有的service为SOA架构，那么可以看成是一个外部接口提供方，那么必须记录入参。
调用其他第三方服务时，所有的出参和入参是必须要记录的(因为你很难追溯第三方模块发生的问题)

DEBUG基本概念