如何编写涉及间接继承的Checkstyle自定义检查？

Question

我们需要编写一个 checkstyle 自定义检查来验证直接或间接继承自某个类 A 的类的特定条件。是否可以使用 checkstyle API 来识别间接继承？ 例如，假设我们有：

• Class C ---extends---> B类
• B类---延伸--->类 A

在这种情况下，通过查找“extends”标记 (TokenTypes.EXTENDS_CLAUSE) 并在 extends 子句 AST 中查找 B，可以轻松检查 C 是否是 B 的子类。但是我们怎么知道C也是A的子类呢？

Java反射加上instanceof是唯一的出路吗？ （在我们的例子中并不理想，因为我们必须对数千个文件进行检查。）

PMD 或另一个静态分析工具允许我使用该（间接继承）条件编写自定义检查？

Answer 1

这是可以做到的，但并不容易，因为 checkstyle 没有 Java 编译器。所以它只能看源文本并分析其语法树，但无法“理解”它。

因此，您必须从 checkstyle 检查中加载该类。

为此，您很可能需要定义自己的类加载器，以便您可以从您的 Eclipse 工作区（或者您的源所在的任何其他位置）加载该类。

现在您只需调用 instanceof A 即可！

我不会担心性能。您可以将类文件的 LRU 缓存添加到自定义类加载器中，这将解决该问题。另外，如果检查在您的 IDE 中运行，它只需要加载很少的类（直接继承树中的类），如果它在整个源上运行，它将在晚上运行，不是吗？

由于这个问题已经很老了，如果您需要代码示例，请告诉我。

Answer 2

我们已经用 Java 反射解决了这个问题：

Class<?> clazz = Class.forName(ClassA);
if (ClassC.class.isAssignableFrom(clazz)) {
    // Class C is a direct or indirect subclass of ClassA
}

它限制了自定义检查的适用性，因为它只有在 ClassA 和 ClassC 位于类路径中时才有效。