- [强制] 存储方案和底层数据结构的设计获得一致评审通过,并沉淀文档。
说明:有缺陷的底层数据结构容易导致系统风险高、可扩展性差,重构成本因历史数据迁移、系统平滑过渡也会陡然增加。所以,对存储方案和数据结构需要进行认真的设计和评审,生产环境提交执行后,团队成员需要进行double check。
正例:评审内容包括存储介质选型、表结构设计能否满足技术方案、存取性能和存储空间能否满足业务发展、表或字段之间的辩证关系、字段名称、字段类型等;数据结构变更(如在原有表中新增字段)也需要进行评审通过后再上线。
- [强制] 在需求分析阶段,如果与系统交互的User超过1类,并且相关的User Case超过5个,那么使用用例图来表达结构化需求会更加清晰。
用例图:用例图，展现了一组用例(User Case)、参与者（actor）以及它们之间的关系。从用户角度描述系统的静态使用情况，从而建立需求模型。
- [强制] 如果某个业务对象的状态超过3个,那么应使用状态图来表达并且明确状态变化的各个触发条件。
说明:状态图的核心是对象状态,首先明确对象有多少种状态,然后明确两两状态之间是否存在直接转换关系,再明确触状态转换的条件是什么。
正例:淘宝订单状态有已下单、待付款、已付款、待发货、已发货、已收货等。比如已下单与已收货两种状态之间是不可能有直接转换关系的。
- [强制] 如果系统中某个功能的调用链路上涉及的对象超过3个,则应使用时序图来表达并且明确各调用环节的输入与输出。
说明:时序图反映了一系列对象间的交互与协作关系,可以清晰立体地反映系统的调用纵深链路。
- [强制] 如果系统中模型类超过5个,并且存在复杂的依赖关系,则应使用类图来表达并且明确类之间的关系。
说明:类图就像建筑领域的施工图,如果搭平房,可能不需要,但如果建造”蚂蚁Z空间”大楼,则肯定需要详细的施工图。
- [强制] 如果系统中超过2个对象之间存在协作关系,并且需要表示复杂的处理流程,则使用活动图来表示。
说明:活动图是流程图的拓展,增加了能够体现协作关系的对象泳道,支持表示并发等。
- [推荐] 在考虑主干功能的同时,需求分析与系统设计需要充分评估异常流程与业务边界
反例:用户在淘宝网站的付款过程中,如银行扣款成功,则会给用户发送扣款短信;但是当支付宝入款时,由于断网演练产生异常,淘宝订单页面依然显示未付款,导致用户投诉。
- [推荐] 类在设计与实现时要符合单一原则。
说明:单一原则是最易理解却又最难实现的一条规则,随着系统的演进,工程师很多时候会忘记类设计的初衷。
- [推荐] 谨慎使用继承的方式进行扩展,优先使用聚合或组合的方式来实现
说明:若一定要使用继承,则必须符合里氏代换原则。此原则要求父类能够出现的地方子类一定能够出现,比如”把钱交出来”中,钱的子类美元、欧元、人民币等都可以出现。
- [推荐] 在系统设计时,根据依赖倒置原则,尽量依赖抽象类与接口,有利于扩展与维护。
说明:低层次模块依赖于高层次木块的抽象,方便系统间的解耦。
- [推荐] 在系统设计时,注意对扩展开放,对修改闭合。
说明:在极端情况下,交付的代码是不修改的,同一业务域内的需求变化,应通过模块或类的扩展来实现。
- [推荐] 在系统设计阶段,共性业务或公共行为抽取出来公共模块、公共配置、公共类、公共方法等,在系统中不应出现重复代码的情况。
说明:随着代码的重复次数不断增加,维护成本呈指数级上升。
- [参考] 系统设计的主要目的是明确需求、理顺逻辑、后期维护,次要目的是用于指导编码。
说明:避免为了设计而设计,系统设计文档有助于后期的系统维护,所以设计结果需要进行分类归档保存。
- [参考] 设计的本质是识别和表达系统难点,并找到系统的变化点,并隔离变化点。
说明:世间众多设计模式其实就是一种设计模式,即隔离变化点的模式。
- [参考] 系统架构设计的目的:
- 确定系统边界。确定系统在技术层面上的做与不做。
- 确定系统内模块之间的关系。确定模块之间的依赖关系及模块的宏观输入与输出。
- 确定知道后续设计与演化的原则。使后续的子系统或模块设计在一个规定的框架内继续演化。
- 确定非功能性需求。非功能性需求是指安全性、可用性、可扩展性等。
- [参考] 避免发生如下误解:敏捷开发=讲故事+编码+发布。
说明:敏捷开发是快速交付迭代可用的系统,省略多余的设计方案,摒弃传统的审批流程,但需要关心关键点上的必要设计和文档沉淀。
