阿里巴巴开发手册解析个人笔记（七 ) 设计规约

设计规约

1. 【强制】 存储方案和底层数据结构的设计获得评审一致通过，并沉淀成为文档。

说明： 有缺陷的底层数据结构容易导致系统风险上升，可扩展性下降，重构成本也会因历史数
据迁移和系统平滑过渡而陡然增加，所以，存储方案和数据结构需要认真地进行设计和评审，
生产环境提交执行后，需要进行 double check。
正例： 评审内容包括存储介质选型、表结构设计能否满足技术方案、存取性能和存储空间能否
满足业务发展、表或字段之间的辩证关系、字段名称、字段类型、索引等；数据结构变更（如
在原有表中新增字段）也需要进行评审通过后上线。

2. 【强制】在需求分析阶段，如果与系统交互的 User 超过一类并且相关的 User Case 超过 5 个，使用用例图来表达更加清晰的结构化需求。

财务，市场总监， 属于两类，别以为是一类了
画UML是否有助于减少 工作量？这是一个辩证的话题，用例图很少你也画，其实也没啥，关键在于时间与维护成本，能不画肯定尽可能不画，

3. 【强制】如果某个业务对象的状态超过 3 个，使用状态图来表达并且明确状态变化的各个触发条件。

说明： 状态图的核心是对象状态，首先明确对象有多少种状态，然后明确两两状态之间是否存
在直接转换关系，再明确触发状态转换的条件是什么。
正例： 淘宝订单状态有已下单、待付款、已付款、待发货、已发货、已收货等。比如已下单与
已收货这两种状态之间是不可能有直接转换关系的。

3种，1,2,3 三个状态 排列组合 有 6 种，比较好罗列与讨论。
而线程的状态

7个状态，涉及到了 notify(),nofityAll(),wait(),synchronized(),run(),join(),sleep(),start,yield() 9个业务方法，里面的逻辑肯定更复杂，还好不是环形关系。

4. 【强制】如果系统中某个功能的调用链路上的涉及对象超过 3 个，使用时序图来表达并且明确

各调用环节的输入与输出。
说明： 时序图反映了一系列对象间的交互与协作关系， 清晰立体地反映系统的调用纵深链路。

5. 【强制】如果系统中模型类超过 5 个，并且存在复杂的依赖关系，使用类图来表达并且明确类之间的关系。

说明： 类图像建筑领域的施工图，如果搭平房，可能不需要，但如果建造蚂蚁 Z 空间大楼，肯
定需要详细的施工图。

为什么是5个？ 我们想4个 大部分都是两两关系，三个可能是

6. 【强制】如果系统中超过 2 个对象之间存在协作关系，并且需要表示复杂的处理流程，使用活动图来表示。

说明： 活动图是流程图的扩展，增加了能够体现协作关系的对象泳道，支持表示并发等。

都画图可能更好

7. 【推荐】需求分析与系统设计在考虑主干功能的同时，需要充分评估异常流程与业务边界。

反例： 用户在淘宝付款过程中，银行扣款成功，发送给用户扣款成功短信，但是支付宝入款时
由于断网演练产生异常，淘宝订单页面依然显示未付款，导致用户投诉。
我们的异常对象有
人，人使用的工具 手机中的弱网，无网络，服务器黑箱

8. 【推荐】类在设计与实现时要符合单一原则。

说明： 单一原则最易理解却是最难实现的一条规则，随着系统演进，很多时候，忘记了类设计
的初衷。

9. 【推荐】谨慎使用继承的方式来进行扩展，优先使用聚合/组合的方式来实现。

说明： 不得已使用继承的话，必须符合里氏代换原则，此原则说父类能够出现的地方子类一定
能够出现，比如， “把钱交出来” ，钱的子类美元、欧元、人民币等都可以出现。

10.【推荐】系统设计时，根据依赖倒置原则，尽量依赖抽象类与接口，有利于扩展与维护。

说明： 低层次模块依赖于高层次模块的抽象，方便系统间的解耦。

11.【推荐】系统设计时，注意对扩展开放，对修改闭合。

说明： 极端情况下，交付的代码都是不可修改的，同一业务域内的需求变化，通过模块或类的
扩展来实现。

12.【推荐】系统设计阶段，共性业务或公共行为抽取出来公共模块、公共配置、公共类、公共方

法等， 避免出现重复代码或重复配置的情况。
说明： 随着代码的重复次数不断增加，维护成本指数级上升。

13.【推荐】避免如下误解： 敏捷开发 = 讲故事 + 编码 + 发布。

说明： 敏捷开发是快速交付迭代可用的系统，省略多余的设计方案，摒弃传统的审批流程，但
核心关键点上的必要设计和文档沉淀是需要的。
反例： 某团队为了业务快速发展，敏捷成了产品经理催进度的借口， 系统中均是勉强能运行但
像面条一样的代码， 可维护性和可扩展性极差，一年之后，不得不进行大规模重构，得不偿失。

14.【参考】系统设计主要目的是明确需求、理顺逻辑、后期维护，次要目的用于指导编码。

说明： 避免为了设计而设计，系统设计文档有助于后期的系统维护，所以设计结果需要进行分
类归档保存。

15.【参考】设计的本质就是识别和表达系统难点， 找到系统的变化点，并隔离变化点。

说明： 世间众多设计模式目的是相同的， 即隔离系统变化点。

16.【参考】系统架构设计的目的：

 确定系统边界。确定系统在技术层面上的做与不做。
 确定系统内模块之间的关系。确定模块之间的依赖关系及模块的宏观输入与输出。
 确定指导后续设计与演化的原则。使后续的子系统或模块设计在规定的框架内继续演化。
 确定非功能性需求。非功能性需求是指安全性、可用性、可扩展性等。