关于记录日志的几个小心得

欢迎和大家交流技术相关问题：
邮箱: jiangxinnju@163.com
博客园地址: http://www.cnblogs.com/jiangxinnju
GitHub地址: https://github.com/jiangxincode
知乎地址: https://www.zhihu.com/people/jiangxinnju

如何记录好日志其实是个很值得探讨的事情，下面两篇文章介绍了一些基本的原则：

• Logging 日志记录最佳实践：http://www.oschina.net/question/12_44624
• 写给开发者：记录日志的10个建议：http://blog.jobbole.com/52018/

基于这些原则，并针对最近在工作中的实践情况，再补充一下：

1. 日志内容必须是一段能够独立成句的内容，因为日志主要的查看者很可能不是你自己，要保证任何开发人员看到你的日志都能明白其中的意思，并能够快速定位问题。
2. 工具类代码不要记录日志，要通过抛出多种异常或者通过返回值的方式告诉调用者，在内部发生了什么，产生了什么结果。
3. 业务代码要在业务逻辑进入和离开时记录日志，要知道流程在哪个模块中出现了问题，防止多方定位，互相推诿扯皮。模块内部，所有的重要分支也都要有日志记录。
4. 每一个实体要能够唯一标识，比如类的引用一定要带包名。