如何在 ArchUnit 测试中全局排除 target 目录-java教程-PHP中文网

如何在 ArchUnit 测试中全局排除 target 目录

ArchUnit 默认分析类路径中的所有 .class 文件，而 Maven 的 target/ 目录包含编译产物，不应参与架构约束检查；本文介绍通过自定义 ImportOption 实现一次性、全局排除 target 目录的规范做法。

archunit 默认分析类路径中的所有 `.class` 文件，而 maven 的 `target/` 目录包含编译产物，不应参与架构约束检查；本文介绍通过自定义 `importoption` 实现一次性、全局排除 `target` 目录的规范做法。

ArchUnit 的核心设计理念是基于字节码（.class 文件）进行静态分析，而非源码（.java 文件）。这意味着它默认会扫描整个类路径（Classpath）——包括 target/classes、target/test-classes 甚至依赖 JAR 中的类。若未显式限制，ArchUnit 可能误将构建生成目录（如 Maven 的 target/）纳入分析范围，导致冗余扫描、性能下降，甚至因临时类引发误报。

要全局、安全、可复用地排除 target 目录，推荐实现一个自定义 ImportOption。该接口仅需重写 includesLocation(Location) 方法，根据 Location 的 URI 路径判断是否跳过：

import com.tngtech.archunit.core.importer.ImportOption;
import com.tngtech.archunit.core.importer.Location;

public class ExcludeTargetFolder implements ImportOption {
    @Override
    public boolean includesLocation(Location location) {
        String path = location.getUri().getPath();
        return !path.contains("/target/") && !path.contains("\target\");
    }
}

随后，在测试类中通过 @AnalyzeClasses 的 importOptions 属性统一启用：

import com.tngtech.archunit.junit.AnalyzeClasses;
import com.tngtech.archunit.junit.ArchTest;
import com.tngtech.archunit.lang.ArchRule;

@AnalyzeClasses(
    packages = "com.example.myapp",
    importOptions = {ExcludeTargetFolder.class} // ← 全局生效，无需为每条规则重复配置
)
class ArchitectureTests {
    @ArchTest
    static final ArchRule no_cycles = 
        com.tngtech.archunit.library.dependencies.SliceRuleDefinition.slices()
            .matching("com.example.myapp.(*)..")
            .should().beFreeOfCycles();

    @ArchTest
    static final ArchRule coding_rules = 
        com.tngtech.archunit.library.GeneralCodingRules.NO_CLASSES_SHOULD_USE_JAVA_UTIL_DATE;
}

⚠️ 重要注意事项：

ArchUnit 不分析源码，因此无需排除 src/main/java 下的 .java 文件；真正需要规避的是 target/ 下的 .class 输出目录；
若使用 IDE 运行测试（如 IntelliJ），请确保测试运行时的类路径未意外包含 target/ —— 大多数现代 IDE + Maven 插件已自动隔离，但自定义 Classpath 时需手动校验；
ExcludeTargetFolder 中的路径判断采用宽松匹配（含 /target/ 或 arget），兼容 Unix/Linux/macOS 与 Windows 路径分隔符；
此方案适用于 ArchUnit 1.0+（含您使用的 1.1.0），且与 JUnit 5 完全兼容。