全面掌握软件架构的守护神-ArchUnit

ArchUnit 是一个免费、简单和可扩展的库，可以使用任何普通的 Java 单元测试框架检查 Java 代码的架构和编码规则。,ArchUnit 通过分析给定的 Java 字节码，将所有类导入到 Java 代码结构中，来检查包、类、层、切片上依赖关系，包括对循环依赖关系等问题的检查。,ArchUnit 于2017年4月23日发布第一个版本，2022年10月3日发布了 1.0.0 版本，共32次Release。,ArchUnitNet 是一个 关于.NET/C# 的架构测试工具。,,ArchUnit 由 ArchUnit、 ArchUnit-junit4、ArchUnit-junit5-api、 ArchUnit-junit5-engine 和
ArchUnit-junit5-engine-api 等模块组成，还为最终用户提供了 archunit-example 模块。,ArchUnit 模块包含编写架构测试所需的核心基础结构，如ClassFileImporter、域对象和规则语法结构。ArchUnit 分为 Core、Lang 和 Library 三层，Core 层处理基本的基础结构，比如将字节码导入为Java对象； Lang 层提供以简洁的方式制定架构规则的语法； Library 层包含更为复杂的预定义规则，如多层分层架构。,ArchUnit-junit4 模块包含与 JUnit 4集成的基础结构，特别是用于缓存导入类的 ArchUnitRunner。,ArchUnit-junit5-* 模块包含与 JUnit 5集成的基础结构，并包含在测试运行之间缓存导入类的基础结构。ArchUnit-junit5-API 包含用户 API，用于编写支持 ArchUnit 的 JUnit 5的测试，ArchUnit-junit5-engine 包含运行这些测试的运行时引擎。
ArchUnit-junit5-engine-API 包含一些 API 代码，这些 API 代码用于那些想要对运行 ArchUnit JUnit 5测试进行更详细控制的工具，特别是一个 FieldSelector，它可以用来指示 ArchUnitTestEngine 运行一个特定的规则字段(比较 JUnit 4和5 Support)。,archunit-example 模块包含违反这些规则的示例体系结构规则和示例代码。在这里可以找到关于如何为项目设置规则的灵感，或者在 ArchUnit-最新发布版本的示例。,有一个maven插件arch-unit-maven-plugin，可以从 Maven 运行 ArchUnit 规则。,要使用 ArchUnit，在类路径中包含相应的 JAR 文件就足够了。,,大多数对象类似于 Java 反射 API，包括继承关系。因此，一个 JavaClass 具有一些 JavaMember，JavaMember 可以是 JavaField、 JavaMethod、 JavaConstruction (或 JavaStaticInitializer)。,CodeUnit 虽然不存在于反射 API 中，但是为任何可以访问其他代码的东西引入一个概念是有意义的。它要么是一个方法，一个构造函数(包括类初始化器) ，要么是一个类的静态初始化器(例如静态块，静态字段赋值，等等)。,对另一个类的访问也是一个不在反射范畴的概念，ArchUnit在最细粒度上，只能从 CodeUnit 通过 JavaFieldAccess 、JavaMethodCall、JavaConstructorCall 来分别访问字段、方法或构造函数。,,由于被访问的字段、方法、构造函数可能定义在超类中，所以引入了FieldAccessTarget、MethodCallTarget、ConstructorCallTarget等Target系列概念，用于解析到真正的目标类。,,,由于导入的类集并不总是包含所有的类，所以上图中resolves to可能解析到0个对象。,另外，上图中MethodCallTarget可以resolves to多个JavaMethod，其原因在于某个方法可能实现了多个接口，如下图所示。,,Core API具备强大的功能，但是Lang API更为简洁。,Lang 层除了为类提供API之外，还为其成员提供了正反两个系列的API，包括members()、noMembers()、fields()、noFields()、codeUnits()、noCodeUnits()、constructors()、noConstructors()等。,在ArchUnit，大多数规则都是如下架构。,如果预定义API不能满足要求，可以自定义规则。,因遗留代码或其它无法满足规则的情况，可以将一个名为
archunit_ignore_patterns.txt 的文本文件放在classpath的根目录下，并在每一行使用一个可以匹配要忽略的冲突的正则表达式。,ArchUnit 在 Library 层预定义了若干架构检查的 API。目前可以方便地检查分层架构和洋葱架构，将来可能会扩展到管道、过滤器，以及业务和技术关注点分离等。,如果以上切片不能满足要求，还可以使用SliceAssignment类来定制切片。,ArchUnit 通过 GeneralCodingRules 类提供了一组通用性较高的编码规则检查。,DependencyRules 类提供了一组检查类之间依赖关系的规则和条件。,ProxyRules 提供了关于使用代理对象的检查。,ArchUnit 在
com.tngtech.archunit.library.plantuml 包下提供了一个支持 PlantUML 的特性，用于直接从 PlantUML 派生出检查规则，对相应的类进行检查。,支持的UML只能是组件图，用Java类的Package作为组件原型。ArchUnit对组件图还有一些特殊要求，同时提供一些检查的额外选项。,当违规行为过多，无法立即修复时，需要建立一种迭代机制，防止代码基线进一步恶化。,ArchUnit 的 FreezingArchRule 类提供这方面的帮助，将现有违规行为记录到 ViationStore 中，然后后续检查只报告新增的违规行为，并忽略已知的违规。一旦违规得到修复，FreezingArchRule 将自动将其从已知冲突中去除，无需额外回归。代码行号的变化不会影响违规行为。,FreezingArchRule 默认使用一个简单的纯文本文件保存 ViationStore，以便利用 VCS 进行跟踪管理。该文件的路径包括 ViationStore 的创建和更新行为也是可配置的，方便用于CI环境。,与代码质量度量(如圈复杂度或方法长度)类似，软件架构度量力求度量软件的结构和设计。,ArchUnit 可以用来计算一些众所周知的软件体系结构度量。,可使用 @ArchIgnore 注解来忽略对规则的检查。,可使用如下方式对检查规则进行分组，提升规则的组织性，并允许在项目或模块间复用规则。,ArchUnit 通过使用空格替换原始规则名称中的下划线，提供了在测试报告中生成更多可读名称的可能性。,也可以将下面的属性移除或设置为false来关闭该特性。,ArchUnit 会使用 Java 资源标准加载机制来加载classpath根下的 archunit.properties 配置文件。,可以通过将系统属性传递给执行ArchUnit的JVM进程来覆盖 archunit.properties 中的配置。,