关于日志分析:别在-Java-代码里乱打日志了这才是打印日志的正确姿势

我的公众号：MarkerHub，Java 网站：https://markerhub.com

更多精选文章请点击：Java 笔记大全.md

不同级别的日志应该辨别应用，另外用 [] 进行参数变量隔离。

西格玛的博客
http://t.cn/E9BkD7a

应用 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)
调用第三方时的调用参数和调用后果

阐明

1. 并不是所有的 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);
}

2.对于简单的业务逻辑，须要进行日志打点，以及埋点记录，比方电商零碎中的下订单逻辑，以及 OrderAction 操作 (业务状态变更)。

3. 对于整个零碎的提供出的接口 (REST/WS)，应用 info 记录入参

4. 如果所有的 service 为 SOA 架构，那么能够看成是一个内部接口提供方，那么必须记录入参。

5. 调用其余第三方服务时，所有的出参和入参是必须要记录的 (因为你很难追溯第三方模块产生的问题)

DEBUG

基本概念

能够填写所有的想晓得的相干信息 (但不代表能够轻易写，debug 信息要有意义, 最好有相干参数)
生产环境须要敞开 DEBUG 信息
如果在生产状况下须要开启 DEBUG, 须要应用开关进行治理，不能始终开启。

阐明

如果代码中呈现以下代码，能够进行优化:

//1. 获取用户根本薪资

//2. 获取用户休假状况

//3. 计算用户应得薪资

优化后的代码:

logger.debug("开始获取员工 [{}] [{}] 年根本薪资",employee,year);

logger.debug("获取员工 [{}] [{}] 年的根本薪资为[{}]",employee,year,basicSalary);
logger.debug("开始获取员工 [{}] [{}] 年[{}]月休假状况",employee,year,month);

logger.debug("员工 [{}][{}] 年[{}]月年假 / 病假 / 事假为[{}]/[{}]/[{}]",employee,year,month,annualLeaveDays,sickLeaveDays,noPayLeaveDays);
logger.debug("开始计算员工 [{}][{}] 年[{}]月应得薪资",employee,year,month);

logger.debug("员工 [{}] [{}] 年[{}]月应得薪资为[{}]",employee,year,month,actualSalary);

TRACE

基本概念

特地具体的零碎运行实现信息，业务代码中，不要应用.(除非有非凡用意，否则请应用 DEBUG 级别代替)

标准示例阐明

@Override
@Transactional
public void createUserAndBindMobile(@NotBlank String mobile, @NotNull User user) throws CreateConflictException{boolean debug = log.isDebugEnabled();
    if(debug){log.debug("开始创立用户并绑定手机号. args[mobile=[{}],user=[{}]]", mobile, LogObjects.toString(user));
    }
    try {user.setCreateTime(new Date());
        user.setUpdateTime(new Date());
        userRepository.insertSelective(user);
        if(debug){log.debug("创立用户信息胜利. insertedUser=[{}]",LogObjects.toString(user));
        }
        UserMobileRelationship relationship = new UserMobileRelationship();
        relationship.setMobile(mobile);
        relationship.setOpenId(user.getOpenId());
        relationship.setCreateTime(new Date());
        relationship.setUpdateTime(new Date());
        userMobileRelationshipRepository.insertOnDuplicateKey(relationship);
        if(debug){log.debug("绑定手机胜利. relationship=[{}]",LogObjects.toString(relationship));
        }
        log.info("创立用户并绑定手机号. userId=[{}],openId=[{}],mobile=[{}]",user.getId(),user.getOpenId(),mobile);
    }catch(DuplicateKeyException e){log.info("创立用户并绑定手机号失败, 已存在雷同的用户. openId=[{}],mobile=[{}]",user.getOpenId(),mobile);
        throw new CreateConflictException("创立用户发生冲突, openid=[%s]",user.getOpenId());
    }
}

Java 笔记大全.md

太赞了，这个 Java 网站，什么我的项目都有！https://markerhub.com

这个 B 站的 UP 主，讲的 java 真不错！

关于日志分析:别在-Java-代码里乱打日志了这才是打印日志的正确姿势

小 Hub 领读：

举荐浏览