在日常开发过程中,Spring、Dubbo、Mybatis等都是我们常用的开源框架。当你在使用这些框架时,不可避免需要通过分析源码来理解内部的实现原理。那么,你在翻阅源代码时,有没有想过这些框架的代码结构为什么要这样进行设计和实现呢?背后是否有一些组件设计的原则呢?这就是今天我们要讨论的话题。
我们知道,组件(Component)是设计和规划软件系统代码结构的基本单元,而在代码结构设计上最重要的关注点就是耦合(Coupling)度,用来处理组件与组件之间的关系。这里,我们以Dubbo框架为例进行切入并给出它的组件关系图。Dubbo框架的源码比较复杂,从顶层的代码结构进行梳理,我们可以得到这样的包结构图。
我们看到Dubbo在代码结构上一共包含common、remoting、rpc、cluster、registry、monitor、config和container等8大核心包,它们之间相互依赖构成一个整体。但这里的依赖关系并不是随意设计的,而是使用到了经典的组件设计原则(Component Design Principle)。
什么是组件设计原则?
组件设计原则有时候也称为分包(Package)原则。针对耦合度,在组件设计上包含以下三条设计原则:
- 无环依赖原则
无环依赖原则的英文全称是Acyclic Dependencies Principle,它的含义很明确,就是说组件与组件之间的关联关系中不应该存在环状结构,我们要避免形成循环依赖。
- 稳定抽象原则
稳定抽象原则,即Stable Abstractions Principle。该原则认为如果一个组件是稳定的,那么它就应该是抽象的。反之,如果一个不稳定的组件中就不应该包含很多抽象的内容。
- 稳定依赖原则
稳定依赖原则,即Stable Dependencies Principle,强调的也是稳定性,认为组件与组件之间的依赖关系应该是有方向的,也就说一个组件只应该依赖于比它更稳定的组件,反之就是不合理的。
从原则的命名上我们也不难看出,组件耦合原则实际上更多关注的是稳定性(Stablility)。那么什么是稳定性呢?在软件系统中,如果某一个包被许多其他的软件包所依赖,也就是具有很多输入依赖关系的包就是稳定的,例如下图中的这个X组件。
而在下图中存在一个Y组件,但我们认为组件Y是不稳定的,因为Y没有被其他的组件所依赖,但Y自身依赖很多别的组件。
现实中的诸如Dubbo这种框架代码中的包结构通常比较复杂,可能很难找到这些一眼就能判断其稳定性的组件,这时候我们就需要借助一些量化标准来对包结构的稳定性进行衡量。让我们一起来看一下。
组件设计原则的度量方法
我们先来看看组件的稳定度如何进行度量,我们可以使用以下公式:
I = Ce / (Ca + Ce)
其中Ca代表向心耦合(Afferent Coupling),表示有多少个组件依赖与这个组件。而Ce代表离心耦合(Efferent Coupling),表示这个组件本身所依赖的组件数量。I代表Instability,即不稳定性,显然它的值处于[0,1]之间。
针对前面介绍的X和Y两个组件,我们可以使用该工作做一个简单计算。不难得出组件X的Ce=0,所以不稳定性I=0,说明它非常稳定。相反,组件Y的Ce=3,Ca=0,所以它的不稳定性I=1,说明它非常不稳定。
另一方面,组件的抽象度也同样存在类似的计算公式:
A = AC / CC
其中A代表抽象度(Abstractness)。AC(Abstract Class)表示组件中抽象类的数量,而CC(Concrete Class)表示组件中所有类的总和,这样通过对比AC和CC就能简单得出该组件的抽象度。
事实上,组件之间都存在一个依赖链,稳定性在该依赖链上具有传递性。下图展示的是一种更常见的场景,沿着依赖的方向,组件的不稳定性应该逐渐降低,稳定性应该逐渐升高。如果已经处于稳定状态的组件就不应该去依赖处于不稳定状态的组件。
另一方面,正如上图所展示的,大多数组件即具备一定的稳定性也表现出一定的抽象度。如果一个组件的稳定度和抽象度都是1,意味着该组件里面全是抽象类且没有任何组件依赖它,那么这个组件就没有任何用处。相反,如果一个组件稳定度和抽象度都是0,那么意味着这个组件不断在变化,不具备维护性,这也是我们不想设计的组件。所以,在稳定度和抽象度之间我们应该保持一种平衡,下图中中间的那个线就是平衡线。在有些资料中,这条平衡线有一个专业的名称,即主序列(Main Sequence),如下图所示。
我们用距离(Distance)的概念来量化这种平衡,距离的计算公式:
D = abs(1 - I - A) * sin(45)
距离的图形化表示参考下图。
通过这些度量方法,我们就可以全面分析组件的稳定度、抽象度以及与主序列之间的平衡关系。
讲到这里,你可能会问,如何能够有效计算出这些度量方法背后的具体量化数据呢?通过人工的方式进行计算显然不可行,这时候就需要引入一些专门的测量工具了。
组件设计原则的测量工具
这里介绍一款组件关系分析的利器:JDepend。JDepend是用来评价Java代码是否遵循组件设计原则的便捷工具,可以给出代码工程中包与包之间的依赖关系,并分析出每个包的稳定和抽象程度以及是否存在循环依赖等。这些指标与前面中介绍的组件设计量化标准保持一致。
使用JDepend时,我们一般加载它为Eclipse提供的插件。安装完JDepend插件之后,在Eclipse中会出现一个“Run JDepend Analysis”菜单。
直接执行命令,就可以得到JDepend的分析结果了。接下来,我们还是以Dubbo为例,来看一下该框架中位于整个依赖关系中心位置的dubbo.rpc,可以看到如下图所示的分析结果。
JDepend给出了四个子页面,分别是所选中的对象、存在循环依赖关系的包、多依赖的包和被依赖的包。从图中,我们看到具体类(CC)、抽象类(AC)、向心耦合(Ca)、离心耦合(Ec)、不稳定性(I)、抽象度(A)和距离(D)等组价设计原则中所介绍的指标数量,同时还使用“Cycle!”用来标识是否包结构是否存在循环依赖。当然,针对这些可视化界面,JDepend还提供了完整的文本结果描述。
同时,JDepend还为我们自动生成了主序列图以及各个包在该图中的分布情况。对于com.alibaba.dubbo.rpc包而言,得到的效果如下图。
在上图中,我们点击某个点,可以看到该点所代表的包结构中的不稳定性、抽象度和主序列之间的距离值。而图中所分布点分为三种颜色,绿色集中主序列线附件,代表在不稳定性和抽象度之间达成了比较好的一种平衡。黑色点位则相对差一下,如果红色点位,则表示设计上出现了问题,需要引起我们的注意。
可以说,任何组件的设计在耦合度上都不可能是完美的,对于复杂的系统而言尤其如此。因此,更多的时候,我们追求的是一种平衡性。组件设计原则为我们追求这种平衡性提供了很好的理论依据和量化标准,我们可以通过工具将这些理论依据和量化标准转化为工程实践,从而更好地指导我们的日常开发工作。