资讯专栏INFORMATION COLUMN

阿里巴巴制定了这 16 条设计规约!

archieyang / 920人阅读

摘要:强制存储方案和底层数据结构的设计获得评审一致通过,并沉淀成为文档。正例淘宝订单状态有已下单待付款已付款待发货已发货已收货等。确定指导后续设计与演化的原则。

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

说明:有缺陷的底层数据结构容易导致系统风险上升,可扩展性下降,重构成本也会因历史数据迁移和系统平滑过渡而陡然增加,所以,存储方案和数据结构需要认真地进行设计和评审,生产环境提交执行后,需要进行 double check。

正例:评审内容包括存储介质选型、表结构设计能否满足技术方案、存取性能和存储空间能否满足业务发展、表或字段之间的辩证关系、字段名称、字段类型、索引等;数据结构变更(如在原有表中新增字段)也需要进行评审通过后上线。

2、【强制】在需求分析阶段,如果与系统交互的 User 超过一类并且相关的 User Case 超过 5 个,使用用例图来表达更加清晰的结构化需求。
3、【强制】如果某个业务对象的状态超过 3 个,使用状态图来表达并且明确状态变化的各个触发条件。

说明:状态图的核心是对象状态,首先明确对象有多少种状态,然后明确两两状态之间是否存在直接转换关系,再明确触发状态转换的条件是什么。

正例:淘宝订单状态有已下单、待付款、已付款、待发货、已发货、已收货等。比如已下单与已收货这两种状态之间是不可能有直接转换关系的。

4、【强制】如果系统中某个功能的调用链路上的涉及对象超过 3 个,使用时序图来表达并且明确各调用环节的输入与输出。

说明:时序图反映了一系列对象间的交互与协作关系,清晰立体地反映系统的调用纵深链路。

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

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

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

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

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

反例:用户在淘宝付款过程中,银行扣款成功,发送给用户扣款成功短信,但是支付宝入款时由于断网演练产生异常,淘宝订单页面依然显示未付款,导致用户投诉。

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

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

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

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

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

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

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

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

12、【推荐】系统设计阶段,共性业务或公共行为抽取出来公共模块、公共配置、公共类、公共方法等,避免出现重复代码或重复配置的情况。

说明:随着代码的重复次数不断增加,维护成本指数级上升。

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

说明:敏捷开发是快速交付迭代可用的系统,省略多余的设计方案,摒弃传统的审批流程,但核心关键点上的必要设计和文档沉淀是需要的。

反例:某团队为了业务快速发展,敏捷成了产品经理催进度的借口,系统中均是勉强能运行但像面条一样的代码,可维护性和可扩展性极差,一年之后,不得不进行大规模重构,得不偿失。

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

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

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

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

16、【参考】系统架构设计的目的:

确定系统边界。确定系统在技术层面上的做与不做。

确定系统内模块之间的关系。确定模块之间的依赖关系及模块的宏观输入与输出。

确定指导后续设计与演化的原则。使后续的子系统或模块设计在规定的框架内继续演化。

确定非功能性需求。非功能性需求是指安全性、可用性、可扩展性等。

本文内容整理自《阿里巴巴Java开发手册 1.4.0》,获取完整版请关注以下公众号后台回复关键字:手册。

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/76864.html

相关文章

  • 新增16设计规约阿里巴巴Java开发手册(详尽版)开放下载!

    摘要:熟悉和遵守阿里巴巴开发手册的编程风格,那只是标,而代码可读性的本可以追溯到软件设计阶段。何为条设计规约是根据阿里巴巴实际项目架构经验提炼而成,共条。本次新增的不单是条新的设计规约,还是千万阿里人的技术之心。 摘要:2018年6月,《阿里巴巴Java开发手册》再次刷新代码规范认知,我们新增了16条设计规约!现免费开放下载,不可错过!《阿里巴巴Java开发手册》是阿里内部Java工程师所遵...

    _ang 评论0 收藏0
  • 阿里巴巴Java代码规约插件p3c-pmd使用指南与实现解析

    摘要:年月底,阿里巴巴集团发布了阿里巴巴开发手册终极版,年月日,在杭州云栖大会上,代码规约插件全球首发,插件支持以上版本和以上版本。阿里巴巴代码规约插件安装阿里代码规约插件有插件和插件。 2017年9月底,阿里巴巴集团发布了《阿里巴巴Java开发手册》PDF终极版,2017年10月14日,在2017杭州云栖大会上,Java代码规约插件全球首发,p3c-pmd插件支持Eclipse4.2以上版...

    worldligang 评论0 收藏0
  • 常识之外的规范——阿里java开发手册笔记(全章节)

    摘要:说明这篇文章是我第一次认真阅读阿里巴巴开发手册终极版的笔记。说明本手册明确防止是调用者的责任。一年半载后,那么单元测试几乎处于废弃状态。好的单元测试能够最大限度地规避线上故障。 说明 这篇文章是我第一次(认真)阅读《阿里巴巴 Java 开发手册(终极版)》的笔记。手册本身对规范的讲解已经非常详细了,如果你已经有一定的开发经验并且有良好的编码习惯和意识,会发现大部分规范是符合常识的。所以...

    Martin91 评论0 收藏0
  • IntelliJ IDEA 18 周岁,吐血推进珍藏已久的必装插件

    摘要:代码规约扫描插件以今年年初发布的阿里巴巴开发规约为标准,作为的插件形式存在,检测代码中存在不规范得位置然后给予提示。 IntelliJ IDEA是目前最好最强最智能的Java IDE,前几天,他刚刚年满18岁。 showImg(https://segmentfault.com/img/remote/1460000017974611); 本文,给大家推荐几款我私藏已久的,自己经常使用的...

    赵春朋 评论0 收藏0
  • 如何在企业各团队间推广开发规范?

    摘要:前些日在阿里技术公众号回复了一个开发规范如何推广的问题,获得了蛮多点赞。参与制定规范如果你直接把阿里开发手册扔给开发人员,大多数开发是抵触的。阿里的开发手册很详细,但不建议你直接作为你企业的规范。 前些日在阿里技术公众号回复了一个开发规范如何推广的问题,获得了蛮多点赞。故写此一篇文章细讲一下我们的推广方式,给困惑的朋友贡献一点思路。 开发规范很重要 领导要一盘西红柿炒蛋,交给A,B,C...

    _DangJin 评论0 收藏0

发表评论

0条评论

archieyang

|高级讲师

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<