随着需求开发迭代,代码库规模逐渐变大,新的团队成员引入等诸多因素,系统起初制定的架构规则不可避免遭到破坏。不仅仅是破坏团队的统一开发规范,更为重要的是随着代码库规模逐渐增长,大大降低系统的可维护性、扩展性,增加评审复杂度和重构成本,也最终导致团队生产力下降以及研发成本增长。
在敏捷开发环境下,系统通过迭代增量的交付价值,系统架构也是如此。团队不可能在项目之初就建立完美的系统架构,系统架构应该随着系统迭代不断演进。
架构演进和架构腐化是看待架构的不同视角:架构腐化着眼于现状,架构演进侧重于未来
架构腐化不可避免,随着时间流转腐化现象必然发生。而我们需要做的是:通过某种方式及早发现和修正
我们需要通过引入一种机制或技术,降低或及早发现架构腐化现象的发生,保持统一的系统架构约束。
对于架构规则常见的验证方式:代码评审、代码质量分析工具或平台、Archunit
以下对常见的几种方式进行优劣势对比:
代码评审:通过强流程控制代码评审活动发生,增强代码评审的强度和质量
优势
劣势
代码质量分析工具:比如Sonar、Checkstyle等
优势
劣势
Archunit:通过单元测试形式对架构规则自动化检查
优势
劣势
ArchUnit是一款免费、简单可扩展的类库,它可以使用任何Java单元测试框架来检查Java代码的架构约束。基于Archunit我们可以自动化检测:
Archunit和代码质量分析工具的关系如下图所示,二者都可以对代码进行分析,在功能覆盖上存在一定交叉。
Archunit不能解决所有的架构属性的约束自动化验证,其主要侧重于系统的演进性、可维护性、可测试性、可解释性等,也可以对耦合度、命名规范等进行验证。
使用Archunit编写架构规则约束非常简单,其提供了便捷的流式API,可以快速的构建规则。
示例1:RULE.01 所有的枚举类必须以Enum为后缀
示例2:对应用分层进行约束校验
在IDE下执行Archiunit单元测试结果示意如下图所示:
架构规则组织可以从多个维度,比如:
下图左侧所示:基于逻辑分类对规则进行分组
下图右侧所示:基于职能分类对规则进行分组
团队是否要引入Archunit本身也是一项架构决策,建议采用文档化形式对该决策进行记录,记录形式参考 《 轻量级架构决策记录机制 》
如果团队想要引入Archunit,从流程化和规范化视角可以基于准备-试点-优化-推广的模式进行实施:
实施准备:
从规范复用的角度考虑,团队需要定义统一的开发规范,包括但不限于编码规范、异常规范、命名规范、依赖规范等等,并在团队内达成一致。建议采用统一的、文档化的形式进行记录(比如,在线表格系统)。对于每条开发规则建议增加比如 “正例”、“反例”、“规则描述”、“规则详细说明”、“是否可自动实现” 等维度描述信息
基于Archunit实现通用架构约束以便在不同项目间进行复用
对于遗留系统已经形成了特定的规则(有可能是已经发生腐化),由于业务系统的持续迭代,在单个迭代完全大规模重构已有系统的可能性不大。所以,建议采增量方式,在迭代研发资源可接受的范围内,逐步引入并丰富架构规则,并对破坏规则的应用代码进行重构。
Archunit不能做什么:
Archunit对架构约束的自动化检测极有价值,且具有较低的接入和定制化成本,强烈建议团队引入试点。引入Archunit进行架构约束自动化检查后,将对以下方面产生影响: