如何简便编写检测Java Optional与null比较的FindBugs检测器？

嘿，我完全懂你盯着FindRefComparison.java源码头大的感觉——那玩意儿要覆盖所有引用比较的场景，代码量自然爆炸。其实要做一个专门检测Optional实例与null直接比较的检测器，根本不用啃那么复杂的逻辑，有几个轻量化的思路可以走：

1. 基于核心检测器模板快速搭建 #

FindBugs/SpotBugs的检测器核心逻辑其实很清晰，不用继承那些复杂的通用检测器，你可以直接从基础的BytecodeScanningDetector入手，只关注我们需要的指令：

• 首先，重写sawOpcode方法，重点捕捉这几类指令：
  • IFNULL/IFNONNULL：直接判断某个值是否为null的分支指令
  • IF_ACMPEQ/IF_ACMPNE：两个引用对象比较是否相等（包括和null比较的情况）
• 然后，针对每个指令，检查操作数栈上的对象类型是否为java.util.Optional：
  • 可以用FindBugs提供的ClassDescriptor来快速判断类型，比如：

    ClassDescriptor optionalDesc = getClassDescriptor("java/util/Optional");
    if (getClassDescriptorFromStack(stackIndex).equals(optionalDesc)) {
        // 触发告警逻辑
        reportBug(new BugInstance(this, "OPTIONAL_COMPARED_WITH_NULL", HIGH_PRIORITY)
                .addClassAndMethod(this)
                .addSourceLine(this));
    }
    

这种方式只聚焦我们需要的场景，代码量会比FindRefComparison少很多，逻辑也更清晰。

2. 复用现有工具类减少重复代码 #

FindBugs/SpotBugs内置了很多工具类帮你简化类型判断和bug报告：

• 用TypeUtils.isOptionalType()（SpotBugs里有这个工具方法）直接判断类型是否为Optional，不用自己手动构建ClassDescriptor
• 用BugReporter的现成方法快速创建bug实例，不用手动拼接信息

比如SpotBugs里的简化逻辑：

@Override
public void sawOpcode(int seen) {
    if (seen == IFNULL || seen == IFNONNULL) {
        if (TypeUtils.isOptionalType(getStackItemType(0))) {
            bugReporter.reportBug(
                new BugInstance(this, "OPTIONAL_COMPARED_WITH_NULL", Priority.HIGH)
                    .addClass(this)
                    .addMethod(this)
                    .addSourceLine(this)
            );
        }
    }
}

3. 切换到SpotBugs（推荐！） #

FindBugs已经停止维护好几年了，SpotBugs是它的活跃分支，不仅兼容原有检测器，还提供了更清晰的文档和更多现成的小检测器示例。你可以直接找SpotBugs仓库里专门处理Optional的检测器（比如OptionalUsageChecker），参考它的实现逻辑来修改，比啃FindBugs的老代码轻松多了。

4. 快速验证你的检测器 #

写完检测器后，不用打包整个工具链来测试：

• 写一个简单的测试类，比如：

  public class BadOptionalCode {
      public void badMethod(Optional<String> opt) {
          if (opt == null) { // 这就是我们要检测的场景
              // ...
          }
      }
  }
  

• 用SpotBugs的测试模块直接运行你的检测器，看是否能精准触发告警，快速迭代调整逻辑。

内容的提问来源于stack exchange，提问作者D. Malone