View on GitHub

modularization-examples

代码防腐实用技术

我们担心这样的症状:

Autonomy 的愿景就是尽量减轻上述的症状,让拆分出来的代码更独立(更具有Autonomy)。从而新需求需要的沟通可以更少,不需要的功能也可以比较容易被干掉。

假定业务逻辑肯定要拆分,拆分成

以 Autonomy 为目标的话,我们可以很容易判断 Git 仓库是主要的着手点。为了减少沟通,每个块业务和产品经理,应该有个对口的 Git 仓库。不选择文件和文件夹的主要原因是 Git 仓库一般对应了编程语言的 Package 的概念,如果是 JavaScript 的话,对应的有 package.json 文件。使用 Git 仓库比较容易依赖编译器进行依赖检查。而选择了文件或者文件夹,则很容易变成表面上拆开了,但是仍然有调用关系,实际上仍然和写在一起没有区别。

度量 Autonomy 有如下指标

会议时间

如果 Autonomy 的问题是高沟通成本,那么是否可以直接度量整个沟通成本。例如参与会议的时间,这是一个可能的指标。这样的指标会有什么问题呢? 有没有更好的指标?

度量会议时间会有如下的问题:

最有效的当然是总收入,总利润这样的结果指标。但是不能一竿子断定所有的过程指标都没有意义。不可能所有人都背最终的结果指标,也不可能所有的改进都要从结果指标入手。会议时间显然能说明成本构成,只是这个成本是否花得值很难判断。一个劳动者只有8个小时的符合劳动法的工作时间,如果有7个小时都在会议上,显然能够说明一些问题。所以我认为会议时间做为观察性的过程指标还是有一定意义,主要的作用是划个红线,超过了红线说明会议太多了。

会议时间这个指标的问题在于无法指导改进。因为开会多,可能仅仅是需求变多了。

“接口改动” / “实现改动” 比率

我们把Git仓库内的文件分为两种类型,负责接口的文件和负责实现的文件。如下图所示

InterfaceStability

接口文件不一定只有 RPC,任何形式的跨 Git 仓库的依赖都算接口。这里 https://connascence.io/ 有一个非常详尽的 checklist。 理想的情况下,应该尽可能少的改接口,而是主要去改实现,这样才能减少跨Git仓库的人员沟通。如果一个新需求,需要同时改动N个Git仓库。但是只要不需要改动接口(包括用 Map<string, any> 这样形式搞的隐式接口),仍然是理想的情况。虽然产品经理需要和多个团队沟通每个部分的需求是什么,但是开发团队之间的沟通仍然可以比较少。要每个新需求都只改动一个Git仓库由一个团队负责。或者说每个“产品”都仅由一个团队端到端负责。我认为这是不太现实的:

接口完全不修改,开发人员之间完全不沟通也是不可能的。我们要关注的是目前的业务逻辑拆分是不是合理,多个 Git 仓库之间的接口如果需要频繁调整,那么说明 Git 仓库是不是分得过多了,或者边界不是最佳的。要根据新的输入,不断去审视过去做过的拆分决策。而 “接口改动” / “实现改动” 比率可以量化目前业务逻辑拆分是否让每个 Git 仓库有多少 Autonomy。这个值越小,说明仅改动实现情况占比越高,自主性做得就越好。

为了数据统计比较稳定:

极端情况下,我们可以不分 Git 仓库,或者只有两个 Git 仓库,从而让 “接口改动” / “实现改动” 比率比较好看。这个也说明了分 Git 仓库的成本。把业务逻辑拆得越碎,必然会导致跨团队的沟通会上升。Git 仓库不是分得越多就越好,而是满足了团队的并发数就可以了。

这个指标的另外一个问题是日常性的文案修改会导致实现改动非常多。所以我们要以“Consistency”维度的指标去平衡。假设我们已经有了一种统一的文案配置机制。那么需要有一个“文案配置机制”接入率的指标。这样就可以避免日常性的例行修改破坏这个指标的真实性。

《A Philosophy of Software Design》 很重要的一个观点就是 “Modules should be deep”,这样的隐喻让人们把注意力放在了静态的结构上。其实作者的本意是接口如果比实现要小很多的话,接口被修改相对于实现被修改的概率也就小了很多。这样我们大部分时候就可以只改实现,而不改接口。“业务逻辑拆分”其成本和收益都要在接下来做新需求的过程中体现,抽离了业务变更的时间轴,静态的代码结构无法度量其好坏。

持久状态封装度

和其他 autonomy metrics 的关系,持久状态封装度 => “接口改动” / “实现改动” 比率 => 会议时间

也就是我们观察到总是开会是表象,“接口改动” / “实现改动” 比率是原因,而持久状态封装度则是滋生问题的温床。道理很简单,就是一个状态越能被全局引用,就越可能被全局滥用。

在 local variable 和 global variable 之间应该有一个中间态。而不是一旦这个变量无法局部在一个函数内部了,就把其变成 100% 全局可以读写,甚至是可以跨线程读写。这里面可以控制 100% 这个比例,可以控制是可读还是可写,也可以控制是否是线程内可以读写。如无必要,勿扩范围。