在ArchUnit中搜索未使用的类，如何找到MyClass.class引用？

Question

我正在尝试使用ArchUnit进行单元测试，以检查是否有任何未使用的类。但我不知道如何检查 MyClass.class 是否引用了某个类。

例如我有一堂课：

public class MyClass {
    ...
}

然后我用某种方法引用这个类：

public class MySecondClass{
    public void methodA(){
        methodThatTakesClassAsParameter(MyClass.class);
    }
    ...
}

如何从 ArchUnit 中看到 MyClass 是从 MySecondClass 引用的？

Answer 1

我可能会给你一个（部分）解决方案。

创建一个ArchCondition

  public static class NotBeUnreferenced extends ArchCondition<JavaClass> {

      NotBeUnreferenced() {
          super("is not referenced by any other compilation units");
      }

      @Override
      public void check(JavaClass javaClass, ConditionEvents events) {
          Set<JavaAccess<?>> accessesFromOtherCompilationUnits = new HashSet<JavaAccess<?>>();
          accessesFromOtherCompilationUnits.addAll(javaClass.getAccessesToSelf());
          accessesFromOtherCompilationUnits.removeAll(javaClass.getAccessesFromSelf());

          if (accessesFromOtherCompilationUnits.isEmpty() && javaClass.getDirectDependenciesToSelf().isEmpty()) {
              String message = createCheckMessage(javaClass, "is unreferenced");
              events.add(new SimpleConditionEvent(javaClass, false, message));
          }
      }

      // taken from com.tngtech.archunit.lang.conditions.ArchConditions
      public static <T extends HasDescription & HasSourceCodeLocation> String createCheckMessage(T object,
              String message) {
          return object.getDescription() + " " + message + " in " + object.getSourceCodeLocation();
      }
  }

使用ArchCondition

  ArchCondition<JavaClass> notBeUnreferenced = new NotBeUnreferenced();
  ArchRule rule = classes().should(notBeUnreferenced);
  collectedRules.add(rule);

你可能想要

• 通过附加或条件 ( )排除具有某些注释的类（例如，@EJB, @Dependent, ）@Statelessrule = rule.or(ArchConditions.beAnnotatedWith(...))
• 从测试类中排除代码
• 排除仅表现常量的类和接口

已知的限制

请注意，如果唯一的访问是编译单元（类、接口、枚举），则该编译单元被视为未引用。

• 访问.class和其他反射访问
• 对常量的访问（即静态最终字段）