通过自动化单元测试的形式守护系统架构

1 背景

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:dbbe10c1-3f8f-468d-a1a4-696871f27264

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:8956b0e2-05dc-4dde-9aa4-beac931993d8

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:5c6b3697-8955-4968-9b14-10ae886e6af5

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:4be5ae1b-3125-43d1-8117-23d6055a5e76

2 为什么选择Archunit

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:bed406d4-17b8-45ac-a486-da0b3d1de6cc

• 支持架构规则自动化检查
• 轻量级，接入成本低
• 结果及时反馈
• 灵活扩展且扩展成本低

对于架构规则常见的验证方式：代码评审、代码质量分析工具或平台、Archunit

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:9938a9f7-6c90-4d41-978d-fd627c9e011a

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:afd568bc-210a-4a2e-a991-9d6ed2222ba4

优势

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:fa699afe-654b-457f-a97d-519a5ab17ebb

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:b62cf554-4501-4cee-a91f-9b4e7d79ff16

劣势

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:55a349bb-b224-47c5-8fd7-788193247b02

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:9cc467ec-c1b6-4ca0-af7f-5d0633029579

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:20558bd8-9d33-45fc-ba05-08eab2f13af0

代码质量分析工具：比如Sonar、Checkstyle等

优势

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:3d629045-f5cc-4a3e-b067-73f2f844923d

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:e329bd63-a9bf-4b06-ab75-1299c6cb6d60

劣势

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:e2972d4e-de25-49b7-ab09-4b8b1288882c

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:c2bc70b9-6b2a-4a10-859c-c266050a15d0

* 定制规则有一定成本(因平台扩展能力而异)

Archunit：通过单元测试形式对架构规则自动化检查

优势

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:c569d365-cab2-4c65-9e74-5a888ea4c7b9

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:0c16210f-cd0d-4917-92a3-186834feb3d9

* Archunit 提供的Java 流式API 易于理解，接入和使用成本低
* 使用纯Java单测框架以单元测试形式自动化执行，及时反馈单测结果

劣势

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:94f190cd-9c74-4ff1-88c4-75e7eb644ed4

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:265b20a1-270d-4b80-8fde-34735f42a0f3

3 Archunit是什么

ArchUnit是一款免费、简单可扩展的类库，它可以使用任何Java单元测试框架来检查Java代码的架构约束。基于Archunit我们可以自动化检测：

• 循环依赖
• 包的包含关系
• 类的依赖关系
• 类和包的包含关系
• 继承关系
• 注解

Archunit和代码质量分析工具的关系如下图所示，二者都可以对代码进行分析，在功能覆盖上存在一定交叉。

Archunit不能解决所有的架构属性的约束自动化验证，其主要侧重于系统的演进性、可维护性、可测试性、可解释性等，也可以对耦合度、命名规范等进行验证。

4 引入Archunit

4.1 开始就是如此简单

使用Archunit编写架构规则约束非常简单，其提供了便捷的流式API，可以快速的构建规则。

示例1：RULE.01 所有的枚举类必须以Enum为后缀

示例2：对应用分层进行约束校验

在IDE下执行Archiunit单元测试结果示意如下图所示：

4.2 如何组织架构规则

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:99df44a6-8d52-4c23-9f9f-72b2f5401b9d

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:910655ed-28c5-48ed-89df-1231e8f2ef11

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:33638afb-054a-4bb5-a7eb-ba528a9f457b

4.3 团队如何规范化

团队是否要引入Archunit本身也是一项架构决策，建议采用文档化形式对该决策进行记录，记录形式参考 《 轻量级架构决策记录机制 》

如果团队想要引入Archunit，从流程化和规范化视角可以基于准备-试点-优化-推广的模式进行实施：

实施准备：

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:d3b071ea-0453-460f-a442-71ccf26015ee

* 基于Archunit实现通用架构约束以便在不同项目间进行复用

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:eac723c8-1c3d-48ae-a3a0-d72aa4ea6b5e

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:e99c86b0-cd21-4ccf-9861-ded917db9eb3

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:c03a6cf7-e214-4852-bd11-46a9e01f9521

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:682d3a51-de35-4a5c-85b3-0e625e55378d

5 结语

Archunit不能做什么：

• 处理文件
• 测试所有架构属性
• 只支持JVM语言
• SOURCE注解
• 需要导入大量代码，加入CICD流水线后的时长影响
• 不能保证自身的维护性

Archunit对架构约束的自动化检测极有价值，且具有较低的接入和定制化成本，强烈建议团队引入试点。引入Archunit进行架构约束自动化检查后，将对以下方面产生影响：

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:c8dcd1f1-7057-453e-9adf-54fd24af335f

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:215cf81c-a905-43bc-829b-06527cd0c167

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:f8706e7b-9612-46e5-ae58-5ed5cd2fe2e6

[TencentCloudSDKException] code:FailedOperation.ServiceIsolate message:service is stopped due to arrears, please recharge your account in Tencent Cloud requestId:346043fd-0b84-48f0-b5ea-17c4d4b1e028

Original: https://www.cnblogs.com/Jcloud/p/16707188.html
Author: 京东云开发者
Title: 通过自动化单元测试的形式守护系统架构