如何编写SpotBugs检测器检测Java类无用导入？遇变量源包获取问题

首先明确：BytecodeScanningDetector不适合做无用导入检测——Java编译成字节码后，导入语句会被直接替换为类的全限定名，字节码中根本不会保留导入声明的原始信息，所以从字节码层面拿不到任何导入相关数据。

正确路径是继承SourceCodeDetector，它能直接访问Java源码的抽象语法树（AST），从而获取导入语句和代码中实际使用的类/包信息。

核心实现步骤 #

• 重写visitClassContext方法，获取当前类的AST根节点：

  @Override
  public void visitClassContext(ClassContext classContext) {
      JavaFile javaFile = classContext.getJavaFile();
      if (javaFile == null) {
          return;
      }
      CompilationUnit compilationUnit = javaFile.getCompilationUnit();
      // 后续处理导入语句和代码引用
  }
  

• 提取所有导入声明：遍历compilationUnit.imports，收集每个导入的全限定名（包括java.util.*这类通配符导入）。
• 提取代码中实际使用的类型：遍历AST中的变量类型、方法返回值、参数类型、实例化对象等节点，收集它们的全限定名。
• 对比导入集合与实际使用集合，标记无用导入：
  • 普通导入（如import java.util.List;）：若对应全限定名未在代码中出现，标记为无用。
  • 通配符导入（如import java.util.*;）：若该包下无任何类被引用，标记为无用。

关键注意点 #

• 单独处理静态导入：比如import static java.util.Collections.emptyList;，需要提取静态成员引用并单独对比。
• 排除默认导入：java.lang.*属于默认导入，无需检测。
• 正确识别嵌套类/内部类的全限定名，避免误判。
• 借助SpotBugs的ASTVisitor简化AST遍历：

  compilationUnit.accept(new ASTVisitor() {
      @Override
      public boolean visit(TypeDeclaration node) {
          // 处理类声明中的类型引用
          return super.visit(node);
      }
  });
  

为什么BytecodeScanningDetector不可行？ #

字节码仅保留类的全限定名，没有任何原始导入语句的记录。比如源码中import java.util.List;，编译后字节码只会出现Ljava/util/List;，无法反向推导是否存在该导入，更无法判断是否有未被使用的导入。

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