arch-verify

LLLLimbo 的头像作者 LLLLimbo

使用ArchUnit验证Java架构规则。在需要定义或验证Java项目中的包或层边界、依赖约束、切片或循环依赖时使用,包括在重构或添加CI构建的治理检查时。

📖 中文导读:使用ArchUnit验证Java架构规则。在需要定义或验证Java项目中的包或层边界、依赖约束、切片或循环依赖时使用,包括在重构或添加CI构建的治理检查时。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: arch-verify description: Verify Java architecture rules with ArchUnit. Use when you need to define or validate package or layer boundaries, dependency constraints, slices, or cyclic dependencies in Java projects, including during refactors or when adding governance checks to CI builds.

ArchUnit Verification

Workflow

  1. Identify the architectural rules to enforce (layers, packages, slices, cycles, coding rules).
  2. Choose the test framework (JUnit 4, JUnit 5, or plain unit tests).
  3. Add the matching ArchUnit dependency.
  4. Write ArchUnit rules in test sources and run them in CI.
  5. Use the Maven plugin when you need cross-repo governance.

Dependencies

JUnit 4

<dependency>
  <groupId>com.tngtech.archunit</groupId>
  <artifactId>archunit-junit4</artifactId>
  <version>1.4.1</version>
  <scope>test</scope>
</dependency>

JUnit 5

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

Other test frameworks

<dependency>
  <groupId>com.tngtech.archunit</groupId>
  <artifactId>archunit</artifactId>
  <version>1.4.1</version>
  <scope>test</scope>
</dependency>

On-demand examples

  • Run scripts/fetch-examples.sh to clone examples only when needed.
  • Use --dest /tmp/archunit-examples to override the destination.
  • The default destination /tmp/archunit-examples is auto-cleaned when it already exists.
  • Use --clean to overwrite a custom destination.
  • Use example-junit4, example-junit5, or example-plain as the starting point.

Resources