工程设计论——如何写好工程代码

2022 年 2 月 15 日 阿里技术


一  内容概述


  1. 从抽象的工程设计论角度阐述了如何写好一份代码。阐述了设计模式和设计原则的底层原理。


  2. 解释了设计模式与设计原则适用的场景及局限性。工程设计论是在有限设计能力下对被设计对象进行的认知和进行逆运算的过程。在不符合这一条件的领域,不应当死扣设计模式与设计原则。在软件领域,一个显而易见的例子就是不要在极度追求性能的代码中死扣设计模式与设计原则。


  3. 解释了设计原则中的单一职责原则为何难以掌握和运用。


  4. 面向接口设计是软件系统设计的最终形态,对开发流程中先写单例再开发的原因做了解释。


二  理论基础


  1. 哲学基础:罗素《哲学问题》。


  2. 数学基础:矩阵理论,工程控制论。


  3. 工程基础:一定工程设计经验,如代码开发等。


  4. 设计科学基础:谢友柏老师的《设计科学与设计竞争力》,Nam Suh的《公理设计》。


三  什么是设计——设计和计算与认知之间的联系


一门科学的建立,应当首先明确本学科的局限性,确定本学科最基本的问题与框架。明确的基本框架应能够迅速得到一门学科的基础结论与研究方法;明确的基本问题可以用于检验上述的结论与方法。指出自然界中每一杯水中都有金元素并不能对金矿的发现起到什么促进作用。设计科学的现在的发展应该做减法而不是做加法。对于设计所具备的特征,有很多描述。这些描述最基本的共同点是设计是需要达到一定的目标的(即需求)。其他特征并不是设计最基本的特征。例如最优化设计中就没有需求变更,logo设计中就没有系统故障。

如果认同需求是设计的共同点,那么搞清楚需求是什么则是重要的。 大部分人都认为,在我们的实际工作中,需求是不明确的,不完整的。那我们不妨用辩证的思维来考虑这个问题的反面,什么是明确的,完整的需求?一份完整的需求,对于所有人而言都是清晰的,不会产生什么不一样的理解。那么对于什么样的产品能够满足相应的需求,也应该是清晰的。用集合论的话来说,一个集合被其外延所完全确定。换句话说,如果需求能够被一个确定的验收方式来定义,比如说单元测试,那么这份需求可以说是明确和完整的。

我们还需要更进一步地探讨什么是验收。以单元测试为例,我们用单元测试来输出一个True或是输出一个False;如果认为单元测试本身是一个函数,那验收就是要求被设计对象在该函数下的相必须为True。那么,如果我们的需求足够简单,会发生什么情况?比如说我们的需求是找到一个x,使其满足x+1=0,我们一般称这种问题为求解,或者是逆运算。可以看到,当我们对需求及其实现方式的认识完全清晰的时候,需求将退化成为一个函数,设计将退化成为逆运算的过程。

设计的过程中,我们对于需求及实现方式的认识是不全面的,这是其与逆运算不同的核心点(而不是需求不明确或者是需求会发生变更)。例如化工产品的合成路线设计,例如高效排序算法的设计,都不存在需求本身不明确的问题。认知的不全面迫使我们需要在设计的过程中,一边对需求及其实现方式进行认知,获取更多的知识,一边进行求逆运算,找到能够满足需求的实现方式。

四  工程设计的过程


在进行工程设计的过程中,对于认知和计算的交替流程,我们总结了一套行之有效的经验,即对需求的拆分和组合。

我们刚刚已经说过,需求本质上是要求一个对象,在某个函数下的像具备某些特征,这本质上是一种约束。而“被设计对象由A,B两个组件构成,A具备123特征,B具备456特征”,这和需求的描述方式没有什么不同,本质上也是一种约束。也就是说,分拆本身也是对被设计对象的一种约束,只不过满足分拆约束的对象并不一定满足需求的约束。因此我们不妨把分拆的约束当作一种对被设计对象的弱约束。

因而工程设计可以被总结成为如下的流程:

  1. 根据对需求的相关研究,给出实现方式的弱约束,我们一般采用对系统拆分的方式来进行弱约束。在软件领域,最常见的弱约束就是对组件划分的约束,各个部件之间的依赖关系,接口的定义,数据交互方式之间的约束。(认知过程,我们一般称之为需求拆解与架构设计)


  2. 利用第一步的弱约束,来对需求中的强约束的实现方式进行具体的分析和求解。(逆运算过程,我们一般称之为编码)


我们刚刚已经说明了,分拆本质上也是一种约束。第二步中的求解结果,仍旧有可能是一种对子系统需求,此时就需要我们继续进行更加细化的设计。

引入弱约束这个概念,是因为在我们对被设计对象一无所知的情况下,研究如何实现相应的需求是相对困难的。那么我们不妨假设被设计对象具备某些性质(这种假设往往也强依赖于个人经验),并将这些假设性质(比如说接口)作为研究如何实现的一种工具和框架。

例如在代码设计中,拆分为A,B两个模块并进行并行设计时,如果在A模块的实现流程完全不知道B模块的信息,那么将会对A模块的设计产生巨大的阻碍(比如前端完全不知道后端的数据格式)。但是,B模块的具体实现方式还未确定,此时A模块也不可能对B模块的信息由完整的了解,且并不是每一个B模块的信息对于其他模块都是有用的(比如后端选用的数据库格式,后端部署的位置,后端的实现方式)。所以我们需要折中的对B模块进行约束(比如规定接口),使得A模块能够获得必要的相关信息。了解过认知论的同学也应该知道,这种接口本身就是一种对B模块的认知(参照罗素的感觉材料或是我在 前序文章中 所述的“关系”)。我认为这是依赖注入的底层逻辑,也是面向接口设计将成为软件设计的最终形态的底层依据。


公式化地来描述上述流程,对于一个找到满足 的设计问题,我们将这个问题分为两步:


  1. 将J(X)=0拆分成为


  2. 根据的性质,找到使得的具体值,例如;并同时研究,找到的具体形式,例如


在这个例子中,工程设计与科学研究后进行计算的最大区别即在于,第二步中的具体实现过程是并行的。各个组件的实现的并行在软件工程中是常见的(前后端分别编码,最后进行调试即是如此)。我们当然可以在完全研究清楚J(X)的性质下,再去进行设计。限制我们不去这么做的条件,并非是这样得到的产品效果一定不好,而是设计需要投入的工期与人力有限制。完全设计好前端之后,再去进行后端设计,当然是可以的,但是这种串行化的工作模式,显而易见的会对工期造成负面影响。


为了使得这种拆分方式可行,独立职责的原则就需要被引进以保证最后的组装工作顺利完成。在上一步中,我们的工作是并行的,意味着我们并不知道所需要取得的值是多少。 如果我们最终研究得到


那我们显然是找不到相应的解的。这就需要我们保证f({X}),g({X}),m({X})之间的相互独立。我们对拆分地独立性及其负面影响进行进一步地探讨:


  1. 强独立:存在一个定义域为两个自变量组X构成的二元空间,值域为自变量组X的函数融合函数U;使得对于任意的


  2. 弱独立:对于任意的


  3. 不独立:存在

对于强独立而言,只要组合函数J,及部分函数f,g的研究和求解是成功的,设计即是成功的。强独立的意思是,如果我们分别找到两个取值 ,使得部分函数f,g的值取到了我们想要的结果m,n;那我们可以根据找到一个综合的解 使得部分函数f,g同时取到我们想要的值。比如说对于: 。那么对于任意一个我们要求的f,g的取值,我们都可以将其用 , 来保证

对于弱独立而言,同时对组合函数J,及部分函数f,g进行研究,可能会带来组合上的困难,但是不至于使得设计彻底失败。比如说对于: 。对于任意的m,n,我们都是能找到 来满足我们的需求的(注意这里一般是由研究组合函数J的同学,来提出对部分函数f,g详细取值要求m,n)。由于对函数g进行研究和设计的人,事先可能不知道 ,他们完全可能设计出来 的方式。因此这种情况,需要后期的合作与调试,才能完成整个设计。

对于不独立而言,同时对组合函数J,及部分函数f,g进行研究,可能会使得设计彻底失败。比如说, 。研究组合函数J的同学最终得到的答案可能是 ,这显然是无解的。因此这个拆分可以认为是失败的。

这一规则对应于软件领域中的单一职责原则,有人评论这一原则是较为难以运用和掌握的( “单一职责原则是最简单但又最难运用的原则” )。事实确实如此,接下来我们将对这一点进行探讨。

我们换一种看起来正确的模棱两可的表述更方便我们发现问题在哪。这个陈述是:独立的功能应当由独立的类来实现。那么,问题出现了。我们怎么去判断两个功能之间相互独立?熟悉哲学,并对哲学中对“Free”的讨论有接触的人会很快反应过来,“Free”这个词必然是建立于某种映射之上,单独说A与B“Free”没有任何意义。家庭教育和学校教育是否独立?道德教育和智力教育是否独立?从不同的角度会有不一样的答案。从时间上,家庭教育和学校教育相互独立;从评分标准上,道德教育和智力教育也相互独立。如果把教育也作为一种设计,我们是应该把教育划分成为家庭教育和学校教育,还是划分成为道德教育和智力教育?划分的依据究竟应该是什么?

显而易见的事情是,我们所能够接受的判断功能之间的相互独立的依据,应该是从其实现方式上相互独立。那么上面那句话,就可以改写成为:实现上独立的功能应当被独立地实现。这有点像一句政治正确的废话,其具体的运用强依赖于设计人员对于相关领域的事前经验与判断。不具备相关领域的经验,进行功能划分必然会出现一些搞笑的结果。这就是单一职责原则是最简单,也最困难的原则的原因。

五  总结与局限


设计是在对需求的认知不完整的情况下,对被设计对象进行求解的一个过程。这就迫使我们需要一边认识被设计对象,一边进行求解。为了并行化地进行这一过程,也为了使得对被设计对象地认识有初步的研究工具和基础,我们总结出了一套利用分拆提供弱约束,并基于这种分拆,来并行进行不同组件之间的设计的流程。由于分拆只能提供关于被设计对象的较弱认识,因此依赖倒置和面向接口设计是必须的。为了使得并行化的设计最终可以被组装,单一职责原则(独立原则)是必须的。

可以看到,整个设计理论是必须基于对需求的认知不完整,且需要低成本(首要的是时间成本)地完成设计这一条件。对于设计周期比较长,认知较为充分的领域,设计理论并不适用。完全只用设计模式来衡量设计的好坏,也是不可取的。这方面的反例有很多,LeetCode上面的题目,恐怕没有哪一个符合了设计模式,比如说找链表倒数第k个节点中的双指针就是一个典型。对于人体而言,也并不遵循什么单一职责原则,甚至可以说耦合地不像,人在饥饿的时候,可以分解蛋白质来供能;我们在飞机设计过程中,有考虑过在液压油泄露时,拿燃油来充当液压油么?一些经典设计也并不遵循设计理论与原则,例如活塞环既能够防止漏气,又能够降低摩擦磨损,这显然也不是符合独立公理的。

只有对设计科学的底层逻辑有着深入的研究,才能使得这门科学发挥其真正的作用。虽然本文尽可能地对这个领域进行了一些减法地操作,略去了一些不核心的要素,但是无论在理论上,还是例子上,都没有能够提供一个真正能够被验证成为正确或是错误的想法或是命题。本文甚至连错误都算不上,这无论如何都是让人不满意的。

六  附——利用分拆来设计系统的一个例子


很多设计领域的文章提出的例子,都是一些已有的设计;或是拿着根本没有市场的需求来设计一款产品。这种先射箭后画靶的行为并不能促进科学的发展。因此找一个大家都熟知的领域,提出解决起来较为有难度,但是需求明确的问题来作为探讨的例子。很幸运的是,我的确解决了我自己提出的问题。

在机械领域,平面杆件机构的设计是最基本的问题。例如对下图中这种四杆机构,我们经常会进行摆角的设计等工作。那么,我们能不用匀速的电机和平面杆件,使得平面杆件上的某一点有着指定的轨迹?例如用平面杆件画一只兔子?

    

对于这个问题,我们梳理我们已经知道的知识,来给出一些弱约束:


  1. 一个确定的平面杆组机构,其上任意一点的位置都是一个随时间变化的周期函数。我们可以用复数域上的函数来进行表示,即:


  2. 由匀速电机带动的杆件(主动件),其终点的轨迹是一个圆,且这个圆的运动规律与其他杆件无关。


  3. 不由匀速电机带动的杆件(从动件)的轨迹,由主动件的运动轨迹和其与主动件的链接所决定。

那么,我们再由拆分给出另外的弱约束,以解决这一问题:

  1. 最终设计的平面杆组,由主动件和一些连接组构成。这些连接组应当具备两个自由端点,且连接组上一点在运动中始终是这两个自由端点的中点,即

在这样一个弱约束下,我们的问题就变为了:

  1. 如何通过一些圆周运动,及建立在其上的加法体系,拟合任意一个周期运动。


  2. 如何找到一个连接组,使得其具备上述条件。

问题一的答案由傅里叶变换给出:


问题二可以由如下杆组完成,转动副2始终为转动副1,3的中点:

 

最终的设计,我用了16个主动件,及16个连接组,共计80个杆件,得到的结果已经在上图中展示了。

诚实而言,我认为这个例子在说明弱约束和强约束,以及拆分对于工程设计的必要性方面,仍旧难以摆脱先射箭后画靶的嫌疑。但是至少,我不认为我设计的机构,就是本问题的最优解;我想本问题用以说明工程设计并不能得到最好的设计这一点,还是足够的。



搜索与推荐技术实战训练营

点击阅读原文查看详情
登录查看更多
0

相关内容

设计模式(Design Pattern)是一套被反复使用、多数人知晓的、经过分类的、代码设计经验的总结。
【干货书】算法设计艺术,319页pdf
专知会员服务
112+阅读 · 2021年10月24日
【干货书】计算机科学家的数学,153页pdf
专知会员服务
164+阅读 · 2021年7月27日
【干货书】Python科学编程,451页pdf
专知会员服务
125+阅读 · 2021年6月27日
专知会员服务
109+阅读 · 2021年6月23日
如何学好数学?这有一份2021《数学学习路线图》请看下
专知会员服务
89+阅读 · 2020年12月26日
【2020新书】如何认真写好的代码和软件,318页pdf
专知会员服务
63+阅读 · 2020年3月26日
《代码整洁之道》:5大基本要点
专知会员服务
49+阅读 · 2020年3月3日
领域驱动编程,代码怎么写?
阿里技术
0+阅读 · 2022年3月15日
如何将你的代码可视化?
AI前线
0+阅读 · 2022年3月11日
如何拥有源源不断的行动力?
创业邦杂志
0+阅读 · 2022年3月4日
经验分享:如何写好硬件产品的需求文档?
人人都是产品经理
0+阅读 · 2022年1月12日
6000字,快速理解低代码
人人都是产品经理
1+阅读 · 2022年1月3日
软件分析与设计:分析什么?如何设计?
阿里技术
0+阅读 · 2021年12月23日
你用过最久的数码产品是什么?
ZEALER订阅号
0+阅读 · 2021年12月5日
如何领导团队做好技术债管理
InfoQ
0+阅读 · 2021年11月21日
需求分析如何落地?这篇告诉你答案
人人都是产品经理
1+阅读 · 2021年10月29日
当设计模式遇上 Hooks
阿里技术
0+阅读 · 2021年8月30日
国家自然科学基金
0+阅读 · 2014年12月31日
国家自然科学基金
0+阅读 · 2013年12月31日
国家自然科学基金
1+阅读 · 2012年12月31日
国家自然科学基金
0+阅读 · 2012年12月31日
国家自然科学基金
1+阅读 · 2012年12月31日
国家自然科学基金
0+阅读 · 2011年12月31日
国家自然科学基金
0+阅读 · 2011年12月31日
国家自然科学基金
1+阅读 · 2009年12月31日
国家自然科学基金
0+阅读 · 2009年12月31日
国家自然科学基金
0+阅读 · 2008年12月31日
Arxiv
0+阅读 · 2022年4月16日
Arxiv
0+阅读 · 2022年4月15日
Disentangled Information Bottleneck
Arxiv
12+阅读 · 2020年12月22日
VIP会员
相关VIP内容
【干货书】算法设计艺术,319页pdf
专知会员服务
112+阅读 · 2021年10月24日
【干货书】计算机科学家的数学,153页pdf
专知会员服务
164+阅读 · 2021年7月27日
【干货书】Python科学编程,451页pdf
专知会员服务
125+阅读 · 2021年6月27日
专知会员服务
109+阅读 · 2021年6月23日
如何学好数学?这有一份2021《数学学习路线图》请看下
专知会员服务
89+阅读 · 2020年12月26日
【2020新书】如何认真写好的代码和软件,318页pdf
专知会员服务
63+阅读 · 2020年3月26日
《代码整洁之道》:5大基本要点
专知会员服务
49+阅读 · 2020年3月3日
相关资讯
领域驱动编程,代码怎么写?
阿里技术
0+阅读 · 2022年3月15日
如何将你的代码可视化?
AI前线
0+阅读 · 2022年3月11日
如何拥有源源不断的行动力?
创业邦杂志
0+阅读 · 2022年3月4日
经验分享:如何写好硬件产品的需求文档?
人人都是产品经理
0+阅读 · 2022年1月12日
6000字,快速理解低代码
人人都是产品经理
1+阅读 · 2022年1月3日
软件分析与设计:分析什么?如何设计?
阿里技术
0+阅读 · 2021年12月23日
你用过最久的数码产品是什么?
ZEALER订阅号
0+阅读 · 2021年12月5日
如何领导团队做好技术债管理
InfoQ
0+阅读 · 2021年11月21日
需求分析如何落地?这篇告诉你答案
人人都是产品经理
1+阅读 · 2021年10月29日
当设计模式遇上 Hooks
阿里技术
0+阅读 · 2021年8月30日
相关基金
国家自然科学基金
0+阅读 · 2014年12月31日
国家自然科学基金
0+阅读 · 2013年12月31日
国家自然科学基金
1+阅读 · 2012年12月31日
国家自然科学基金
0+阅读 · 2012年12月31日
国家自然科学基金
1+阅读 · 2012年12月31日
国家自然科学基金
0+阅读 · 2011年12月31日
国家自然科学基金
0+阅读 · 2011年12月31日
国家自然科学基金
1+阅读 · 2009年12月31日
国家自然科学基金
0+阅读 · 2009年12月31日
国家自然科学基金
0+阅读 · 2008年12月31日
Top
微信扫码咨询专知VIP会员