不同级别的日志应该区分使用,另外用 [] 进行参数变量隔离。
使用 slf4j
打日志的正确方式
什么时候应该打日志
基本格式
必须使用参数化信息的方式:
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:
基本概念
影响到程序正常运行、当前请求正常运行的异常情况:
不应该出现的情况:
如果有 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);
thrownewUserServiceException(errorMessage,ex);
}
WARN
基本概念
不应该出现但是不影响程序、当前请求正常运行的异常情况:
即将接近临界值的时候,例如:
业务异常的记录, 比如:
INFO:
基本概念
系统运行信息
外部接口部分
说明
1. 并不是所有的 service 都进行出入口打点记录, 单一、简单 service 是没有意义的 (job 除外, job 需要记录开始和结束,)。
反例 (不要这么做):
publicList listByBaseType(Integer baseTypeId) {
log.info("开始查询基地");
BaseExample ex=newBaseExample();
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
基本概念
说明
如果代码中出现以下代码,可以进行优化:
//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
publicvoid createUserAndBindMobile(@NotBlankString mobile, @NotNullUser user) throwsCreateConflictException{
boolean debug = log.isDebugEnabled();
if(debug){
log.debug("开始创建用户并绑定手机号. args[mobile=[{}],user=[{}]]", mobile, LogObjects.toString(user));
}
try{
user.setCreateTime(newDate());
user.setUpdateTime(newDate());
userRepository.insertSelective(user);
if(debug){
log.debug("创建用户信息成功. insertedUser=[{}]",LogObjects.toString(user));
}
UserMobileRelationship relationship = newUserMobileRelationship();
relationship.setMobile(mobile);
relationship.setOpenId(user.getOpenId());
relationship.setCreateTime(newDate());
relationship.setUpdateTime(newDate());
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);
thrownewCreateConflictException("创建用户发生冲突, openid=[%s]",user.getOpenId());
}
}