2021.10.31 孤尽训练营D6

一个项目的成员编程水平有高有低，初学者对于日志以及异常处理方面的要求和使用场景可能并不清晰，在项目开发过程中，定义一个日志设计文档和异常处理设计文档其实是有帮助的，除了能让初学者对这方面的开发有一个较清晰的认识，也能统一项目成员对日志和异常处理流程的使用。

经讨论，我们团队的日志设计文档包含以下内容：

• 日志使用框架。本次采用slf4j + logback框架。
• 使用场景，如何使用。对于controller层、service层之类的层，定义在何种场景下进行日志的打印和输出，定义日志打印的方式，如通过注解等。
• 日志的记录格式，如 {logname}_yyyy-MM-dd.log
• 日志的类型以及对应的存储级别、存储时长和最大存储大小
• 定义日志级别的边界。区分打印日志时如何选择级别。
• 定义日志的存放位置。一般是放在项目根目录，同java目录同级

错误码设计文档包括：

• 错误码表示方式，例如错误码以m位字母 + n位数字之类的方式结合起来表示
• 定义。定义错误码中的字母和数字分别代表的意义

异常处理设计文档包括：

• 异常处理实现思路。当发生异常时，开发人员应该如何定位到具体的代码块和异常点；或开发人员在编程过程中是如何将不同层的异常输出到用户界面的。
• 实现方式。记录了基类和多个异常类，并通过继承的方式联系起来，从而达到将不同层的异常进行连接和转换的目的。

---

此三个文档是由团队头脑风暴想出来的，可能有遗漏，待后续补充吧。具体的设计可能还得在开发过程中才能发现。