规范的打印日志
一、使用slf4j
使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一
实现方式统一使用：Logback 框架。
二、什么时候应该打日志
1️⃣当遇到问题的时候，只能通过 debug 功能来确定问题，应该考虑打日志，良好的系统，是可以通过日志进行问题定位的。
2️⃣当碰到 if…else 或者 switch 这样的分支时，要在分支的首行打印日志，用来确定进入了哪个分支。
3️⃣经常以功能为核心进行开发，应该在提交代码前，可以确定通过日志可以看到整个流程。
三、基本格式
1️⃣必须使用参数化信息的方式：
logger.debug("Processing trade with id:[{}] and symbol : [{}] ", id, symbol);
2️⃣对于 debug 日志，必须判断是否为 debug 级别后，才进行使用：
if (logger.isDebugEnabled()) {
logger.debug("Processing trade with id: " +id + " symbol: " + symbol);
}
3️⃣不要进行字符串拼接，那样会产生很多 String 对象，占用空间，影响性能。
反例：
logger.debug("Processing trade with id: " + id + " symbol: " + symbol);
4️⃣使用[]进行参数变量隔离。如有参数变量，应该写成如下写法：
logger.debug("Processing trade with id:[{}] and symbol : [{}] ", id, symbol);
这样的格式写法，可读性更好，对于排查问题更有帮助。
四、不同级别的使用
1️⃣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);
}
2️⃣WARN
不应该出现但是不影响程序、当前请求正常运行的异常情况：
- 有容错机制的时候出现的错误情况
- 找不到配置文件，但是系统能自动创建配置文件
- 即将接近临界值的时候。例如缓存池占用达到警告线业务异常的记录。当接口抛出业务异常时，应该记录此异常。
3️⃣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 架构，那么可以看成是一个外部接口提供方，那么必须记录入参。
-
调用其他第三方服务时，所有的出参和入参是必须要记录的(因为很难追溯第三方模块发生的问题)。
4️⃣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);
5️⃣TRACE
特别详细的系统运行完成信息，业务代码中，不要使用(除非有特殊用意，否则请使用 DEBUG 级别替代)
规范示例说明：
@Override
@Transactional
public void createUserInfo(@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());
}
}
