TNG/ArchUnit架构测试框架核心概念解析

TNG/ArchUnit架构测试框架核心概念解析

ArchUnit A Java architecture test library, to specify and assert architecture rules in plain Java 项目地址: https://gitcode.com/gh_mirrors/ar/ArchUnit

架构测试框架的分层设计

TNG/ArchUnit作为一款强大的Java架构测试框架，采用了清晰的分层设计架构，主要分为核心层(Core)、语言层(Lang)和库层(Library)三个关键层次。这种分层设计使得框架既保持了底层操作的灵活性，又提供了高层抽象的便捷性。

核心层(Core)：架构分析的基础设施

核心层是整个框架的基石，主要负责处理字节码到Java对象的转换工作。这一层的API设计借鉴了Java反射API的思想，但进行了功能扩展：

1. 基础元素表示：提供了JavaMethod、JavaField等类来表示代码结构元素
2. 反射式API：包含getName()、getMethods()等常见反射方法
3. 依赖关系扩展：增加了JavaMethodCall、JavaFieldAccess等类来表示代码间的依赖关系

核心层最常用的功能是通过ClassFileImporter导入编译后的类文件：

// 导入指定包下的所有类
JavaClasses classes = new ClassFileImporter().importPackages("com.mycompany.myapp");

开发者可以通过这些导入的类对象，深入分析代码结构，例如获取类之间的访问关系：

// 获取当前类对外部的所有访问
Set<JavaAccess<?>> accesses = javaClass.getAccessesFromSelf();

语言层(Lang)：声明式架构规则

虽然核心层功能强大，但直接使用它编写架构测试会显得冗长且不够直观。语言层通过流畅的API(Fluent API)提供了声明式的规则定义方式，大大提升了测试代码的可读性和编写效率。

典型的架构规则定义示例：

// 定义service包中的类只能被controller或service包访问的规则
ArchRule rule = 
    classes().that().resideInAPackage("..service..")
        .should().onlyBeAccessed().byAnyPackage("..controller..", "..service..");

定义好的规则可以应用于导入的类：

JavaClasses importedClasses = new ClassFileImporter().importPackage("com.myapp");
rule.check(importedClasses);  // 执行规则检查

语言层的API具有高度可扩展性，开发者可以根据需要定制自己的规则语法，这使得它能够适应各种复杂的架构约束场景。

库层(Library)：预置架构模板

库层提供了一系列开箱即用的复杂架构规则模板，帮助开发者快速实现常见的架构模式：

1. 分层架构：通过包定义快速建立分层架构约束
2. 代码切片：将代码库划分为不同的领域区域
3. 依赖约束：确保切片间的无环性或独立性

这些预置规则大大降低了实施复杂架构规范的难度，开发者可以直接使用或基于它们进行扩展。

框架设计哲学

TNG/ArchUnit的分层设计体现了以下设计理念：

1. 关注点分离：每一层专注于解决特定领域的问题
2. 渐进式复杂度：从底层的细粒度控制到高层的抽象表达
3. 可扩展性：每个层次都留有扩展点，支持自定义实现

这种设计使得框架既适合简单的架构约束检查，也能应对企业级复杂系统的架构治理需求。通过合理利用这三个层次的功能，开发者可以构建出强大的架构保护机制，确保代码结构始终符合预期的设计规范。

ArchUnit A Java architecture test library, to specify and assert architecture rules in plain Java 项目地址: https://gitcode.com/gh_mirrors/ar/ArchUnit