模块开发设计文档的结构

模块开发设计文档的结构：

 

1.逻辑：业务逻辑

 

2.结构：目录文件结构

 

3.接口：接口定义一般分get、add、update三类公用接口，另外部分为私有接口。接口一般服务在serverice层，需要有一定的通用性

 

4.数据：数据库表的设计

 

 

5. 基本架构： 

 

 

面向对象的基本原则：

 

1. 一个类只需要做好一件事，不一致额外的功能应该细分到其他类去实现

 

2. 一个类应该可扩展，而不可修改的，也就是说尽多可能是通过扩展的方式来新增和改变类的功能，例如使用装饰器模式，父子类继承

 

3. 一个不应该强依赖另一个类：例如a类中需要使用到b类，应该使用注入到a类的方式来实现，而不是在a类中直接new到b类

 

   每个类对另一个类来说都是可替代的：例如，现在c类实现的功能与b类似，那么通过注入c来替换b即可

4. 尽可能的使用配置，而不是硬编码

 

5. 面向接口编程：尽可能的关心接口的功能，而不需要关心接口功能的具体实现，例如，a类需要调用到b类或成类，这时候a类只需要关心b类和c类提供了哪些接口即可