ArchUnit：用代碼守護(hù) Java 項(xiàng)目架構(gòu)

一、為什么需要架構(gòu)測(cè)試

隨著 Java 項(xiàng)目規(guī)模增長(zhǎng)，架構(gòu)腐化幾乎是不可避免的趨勢(shì)——分層混亂、循環(huán)依賴、職責(zé)擴(kuò)散等問題逐漸蔓延。傳統(tǒng)的人工 Code Review 很難系統(tǒng)性地發(fā)現(xiàn)這些結(jié)構(gòu)性問題，尤其當(dāng)團(tuán)隊(duì)人數(shù)增多、代碼量膨脹時(shí)，靠"約定"來維護(hù)架構(gòu)約束變得越來越不可靠。

ArchUnit 就是為了解決這個(gè)痛點(diǎn)而生的：把架構(gòu)規(guī)則寫成測(cè)試用例，讓 CI 自動(dòng)幫你守護(hù)架構(gòu)。

二、ArchUnit 是什么

ArchUnit 是一個(gè)輕量級(jí)的 Java 架構(gòu)測(cè)試框架，核心思路非常簡(jiǎn)單——用 Java 代碼定義架構(gòu)規(guī)則，然后像跑單元測(cè)試一樣執(zhí)行這些規(guī)則檢查。如果代碼違反了預(yù)設(shè)的架構(gòu)約束，測(cè)試就會(huì)失敗并給出具體的違規(guī)信息。

它不需要額外的構(gòu)建插件或代理，只是一個(gè)普通的測(cè)試依賴，和 JUnit 配合使用即可。

三、能解決哪些問題

3.1 分層架構(gòu)的訪問控制

在典型的三層架構(gòu)（Controller → Service → DAO）中，最常見的違規(guī)就是表現(xiàn)層直接調(diào)用了數(shù)據(jù)訪問層，繞過了業(yè)務(wù)邏輯層。ArchUnit 可以精確定義這類規(guī)則：哪一層只能訪問哪一層，違規(guī)即報(bào)錯(cuò)。

3.2 模塊間的依賴約束

當(dāng)項(xiàng)目拆分為多個(gè)模塊后，模塊之間的依賴關(guān)系需要嚴(yán)格管控。比如"模塊 A 不能依賴模塊 C"這種約束，用 ArchUnit 一行規(guī)則就能表達(dá)，避免不合理的耦合悄悄引入。

3.3 代碼結(jié)構(gòu)規(guī)范

除了宏觀的架構(gòu)約束，ArchUnit 還能檢查微觀的代碼組織規(guī)范，比如：

• 所有 Entity 類必須在 entities 包下
• 所有 Service 類必須實(shí)現(xiàn)特定接口
• Controller 類不能持有 DAO 層的引用

四、核心優(yōu)勢(shì)

五、實(shí)戰(zhàn)使用

5.1 引入依賴

Maven 配置：

<dependency>
    <groupId>com.tngtech.archunit</groupId>
    <artifactId>archunit-junit5</artifactId>
    <version>0.21.0</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>com.tngtech.archunit</groupId>
    <artifactId>archunit</artifactId>
    <version>0.21.0</version>
    <scope>test</scope>
</dependency>

5.2 驗(yàn)證分層架構(gòu)

確保表現(xiàn)層（presentation）不會(huì)直接調(diào)用數(shù)據(jù)訪問層（dataaccess），強(qiáng)制所有調(diào)用必須經(jīng)過業(yè)務(wù)邏輯層中轉(zhuǎn)：

@Test
public void presentation_should_not_call_dataaccess_directly() {
    JavaClasses classes = new ClassFileImporter()
        .importPackages("com.example.project");

    ArchRule rule = noClasses()
        .that().areInPackage("com.example.project.presentation")
        .should().callClassesThat()
        .areInPackage("com.example.project.dataaccess");

    rule.check(classes);
}

5.3 檢查模塊依賴

禁止模塊 A 直接依賴模塊 C，避免跨層耦合：

@Test
public void moduleA_should_not_depend_on_moduleC() {
    JavaClasses classes = new ClassFileImporter()
        .importPackages("com.example.project");

    ArchRule rule = noClasses()
        .that().areInPackage("com.example.project.moduleA")
        .should().dependOnClassesThat()
        .areInPackage("com.example.project.moduleC");

    rule.check(classes);
}

5.4 驗(yàn)證代碼結(jié)構(gòu)

強(qiáng)制所有以 Entity 結(jié)尾的類必須放在 entities 包中：

@Test
public void entities_should_be_in_correct_package() {
    JavaClasses classes = new ClassFileImporter()
        .importPackages("com.example.project");

    ArchRule rule = classes()
        .that().haveSimpleNameEndingWith("Entity")
        .should().beInPackage("com.example.project.entities");

    rule.check(classes);
}

5.5 執(zhí)行測(cè)試

跑測(cè)試即可，和普通單測(cè)完全一致：

mvn test
# 或
gradle test

違規(guī)時(shí)會(huì)輸出詳細(xì)的錯(cuò)誤信息，明確告訴你哪個(gè)類違反了哪條規(guī)則。

總結(jié)

ArchUnit 的核心價(jià)值在于把隱性的架構(gòu)約定變成顯性的、可執(zhí)行的測(cè)試用例。它不依賴外部工具，不需要改變構(gòu)建流程，只需要在 test 目錄下寫幾個(gè)規(guī)則類，就能在每次 CI 構(gòu)建時(shí)自動(dòng)檢查架構(gòu)是否被破壞。對(duì)于中大型 Java 項(xiàng)目來說，這是一種低成本、高回報(bào)的架構(gòu)治理手段。