如何编写ArchUnit测试验证特定注解类仅含一个公开方法？

1. 引入ArchUnit依赖 #

首先确保测试依赖中包含ArchUnit核心包和Spring扩展包（针对Spring注解场景），以Maven为例：

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

2. 编写核心测试逻辑 #

创建JUnit 5测试类，通过ArchRule定义约束规则并执行校验：

import com.tngtech.archunit.core.domain.JavaClasses;
import com.tngtech.archunit.core.importer.ClassFileImporter;
import com.tngtech.archunit.lang.ArchRule;
import org.junit.jupiter.api.Test;
import org.springframework.stereotype.Component;

import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.classes;
import static com.tngtech.archunit.lang.syntax.ConditionPredicates.declaredPublicMethods;

public class ComponentMethodValidationTest {

    @Test
    void componentsMustHaveExactlyOnePublicMethod() {
        // 导入项目中需要检查的目标包下所有类
        JavaClasses targetClasses = new ClassFileImporter()
                .importPackages("com.yourcompany.yourproject");

        // 定义规则：所有带@Component注解的类，必须恰好有1个自身声明的公开方法
        ArchRule componentMethodRule = classes()
                .that().areAnnotatedWith(Component.class)
                .should().haveExactly(1, declaredPublicMethods());

        // 执行规则校验
        componentMethodRule.check(targetClasses);
    }
}

3. 关键细节说明 #

• 方法范围控制：
  • declaredPublicMethods()仅校验类自身声明的公开方法，不包含父类/接口继承的方法；
  • 如果需要包含继承的公开方法，替换为publicMethods()即可。
• 规则扩展：若需排除特定类（比如带@Controller注解的Component子类），可追加条件：

  .that().areAnnotatedWith(Component.class)
  .and().areNotAnnotatedWith(Controller.class)
  

• 包范围优化：importPackages()可以指定更精确的子包路径，减少不必要的类导入，提升测试效率。

内容的提问来源于stack exchange，提问作者user21000666