前言:根据项目提炼了的经验总结。主要提供一种BugFree的思路
1.写日志时要养成的好习惯
- 保证在定位日志时可以离开代码情镜还能看懂问题是什么。
- 在方法前加 @Transactional,抛出异常之后,事务会自动回滚,数据不会插入到数据库。
- 规范打印日志的格式
其中最重要的是接口和关键字,用于追踪定位
log.warn(String.format("[接口名或操作名][Key Msg]:%s happens.because[param],[solve clue]",errorObj));
以上两点的代码举例:
@Transactional(value = "transactionManager", rollbackFor=Exception.class)
public Boolean addLog(Request request) throws Exception {
Boolean result = false;
if(null!=request){
Result<LogDO> LogDOResult =Manager.getLogById(request.getId());
logger.info("add request num is"+ request.getId());
} //要指出正确或异常的数据ID,方便定位
else{
logger.error("查询addLog接口信息失败,[Id=" + Id + "]");
throw new Exception("不存在数据,ID:"+request.getId());
}
return result;
}
2.定位错误日志时,主要用时间和内容关键字来定位错误信息,而requestId不具有描述性
在log的配置文件里添加相关业务的log文件名,便于统一管理。
从上图可知,当预约业务有问题则可以去xshell中找appointreg.log,具体方式如下图:
整个背景流程大概是这样: