想必大家都有过这样的经历：在项目中遇到报错需要紧急修复时，却因为日志信息模糊不清，无法迅速准确地定位到错误源头，这确实让人感到十分苦恼和无奈。

在新入职一家公司并着手修改遗留bug时，经常发现之前的开发者并未记录详尽的异常日志，这导致我们无法迅速锁定错误根源。问题可能源于前端传参的不准确，也可能是后端逻辑存在缺陷，由于缺乏具体的日志信息，我们难以在第一时间确定问题的真正原因，这无疑增加了排查和修复的难度。

在笔者所在的这家公司，项目中日志的打印方式可谓是五花八门，令人眼花缭乱。然而，这些日志中极少有完整且有用的信息能够真正帮助我们在定位bug时发挥作用，这无疑增加了我们排查和解决问题的难度。

来看看项目中不同的日志打印方式：

这个只是单纯打印了 log

这个则是打印了堆栈

这个什么都不打印。。。

不健全的日志肯定是迟早会出问题的

那么如何写一个规范的日志呢?

对于普通开发者来说，我们可以参考阿里巴巴的 Java 规范手册

 如第5条所说，尽量用前缀 + 占位符方式去替换异常参数，这样简洁明了

第8条推荐我们尽量使用完善的日志框架去记录日志，个人推荐 Slf4j

第9条提醒开发者完善异常信息，方便定位问题所在

第10条比较重要，相信很多刚入行的同学都是对象转 json 去记录的，而且很多人用的还都是暗坑无数的 FastJson，这些问题处理不善就是一个个坑，建议大家还是采用 toString 方式去记录