如何扩展NullnessChecker提取方法的@Nullable/@NonNull注解？

嘿，我之前也折腾过Checker Framework的注解提取，你的思路完全可行——直接扩展NullnessChecker来获取有效空值注解，比生成测试代码反推断靠谱多了！下面是一步步的入门指引，帮你快速上手：

1. 先搞懂核心组件 #

首先得理清几个Checker Framework里的关键类，这是扩展的基础：

• NullnessChecker：空值检查的核心类，负责执行空值分析逻辑；
• NullnessAnnotatedTypeFactory：NullnessChecker依赖的类型工厂，它能计算出「有效注解」——也就是结合了默认规则、继承关系、上下文后的最终注解，不是源码里写的原始注解；
• ExecutableElement：Java AST里代表方法的元素，你需要把反射拿到的Method转换成这个类型，才能让Checker Framework识别。

2. 搭建自定义Checker的基础框架 #

先创建一个继承自NullnessChecker的自定义类，核心是获取它的NullnessAnnotatedTypeFactory——这是我们提取有效注解的关键入口：

public class NullnessAnnotationExtractor extends NullnessChecker {

    private NullnessAnnotatedTypeFactory typeFactory;

    @Override
    public void initChecker() {
        super.initChecker();
        // 获取NullnessChecker对应的类型工厂，后续用它计算有效注解
        typeFactory = (NullnessAnnotatedTypeFactory) getTypeFactory();
    }

    // 后续的注解提取方法会放在这里
}

3. 把反射Method转换成ExecutableElement #

你手里的是反射的Method实例，得把它转换成Checker Framework能处理的ExecutableElement。可以用Elements工具类来实现：

// 假设你已经通过反射拿到了目标Method
Method reflectMethod = ...;

// 获取Elements工具类，用于查找AST元素
Elements elements = typeFactory.getProcessingEnvironment().getElementUtils();
// 先找到方法所在类的TypeElement
TypeElement declaringClass = elements.getTypeElement(reflectMethod.getDeclaringClass().getCanonicalName());

// 遍历类的所有方法，找到和反射Method匹配的ExecutableElement
ExecutableElement targetMethod = null;
for (ExecutableElement method : ElementFilter.methodsIn(declaringClass.getEnclosedElements())) {
    // 先匹配方法名和参数数量
    if (!method.getSimpleName().contentEquals(reflectMethod.getName()) ||
        method.getParameters().size() != reflectMethod.getParameterCount()) {
        continue;
    }

    // 再匹配参数类型（基础场景下对比全限定名即可）
    boolean paramsMatch = true;
    List<? extends VariableElement> methodParams = method.getParameters();
    Class<?>[] reflectParamTypes = reflectMethod.getParameterTypes();
    for (int i = 0; i < methodParams.size(); i++) {
        TypeMirror paramType = methodParams.get(i).asType();
        String paramTypeName = typeFactory.getQualifiedName(paramType).toString();
        if (!paramTypeName.equals(reflectParamTypes[i].getCanonicalName())) {
            paramsMatch = false;
            break;
        }
    }

    if (paramsMatch) {
        targetMethod = method;
        break;
    }
}

提示：如果方法有重载，上面的匹配逻辑需要补充泛型参数的对比，但基础场景下这样足够用了。

4. 提取返回值和参数的有效注解 #

拿到ExecutableElement后，就可以用NullnessAnnotatedTypeFactory直接获取最终的有效注解了：

提取返回值的有效空值注解 #

if (targetMethod != null) {
    AnnotatedType annotatedReturnType = typeFactory.getAnnotatedReturnType(targetMethod);
    // 检查是否有@NonNull或@Nullable注解
    boolean isNonNull = annotatedReturnType.hasAnnotation(NonNull.class);
    boolean isNullable = annotatedReturnType.hasAnnotation(Nullable.class);

    // 输出结果，你也可以改成存入文件或返回数据结构
    System.out.printf("方法 [%s] 返回值有效注解：%s%n",
        targetMethod.getSimpleName(),
        isNonNull ? "@NonNull" : isNullable ? "@Nullable" : "默认规则（通常为@NonNull）");
}

提取参数的有效空值注解 #

if (targetMethod != null) {
    List<? extends VariableElement> params = targetMethod.getParameters();
    for (int i = 0; i < params.size(); i++) {
        VariableElement param = params.get(i);
        AnnotatedType annotatedParamType = typeFactory.getAnnotatedType(param);
        
        boolean isNonNull = annotatedParamType.hasAnnotation(NonNull.class);
        boolean isNullable = annotatedParamType.hasAnnotation(Nullable.class);

        System.out.printf("参数 %d [%s] 有效注解：%s%n",
            i+1,
            param.getSimpleName(),
            isNonNull ? "@NonNull" : isNullable ? "@Nullable" : "默认规则");
    }
}

注意：这里的「默认规则」指的是Checker Framework的空值默认策略，比如NullnessChecker默认采用非空默认——除非显式标注@Nullable，否则所有未标注的元素都会被视为@NonNull。

5. 运行你的自定义Checker #

要运行这个扩展，你需要把它打包成jar，然后用Checker Framework的命令行工具或者集成到构建工具里：

• 命令行方式：用javac指定你的自定义Checker作为处理器：

javac -processor com.yourpackage.NullnessAnnotationExtractor -cp checker-framework.jar:your-extractor.jar your-target-classes.jar

• 如果想批量提取注解，也可以写一个main方法手动初始化Checker环境（参考Checker Framework的CheckerMain源码），不过命令行方式更直接。

6. 进阶小提示 #

• 对于泛型方法、继承来的注解（比如父类方法的注解被子类继承），NullnessAnnotatedTypeFactory已经帮你处理好了，直接调用方法就能拿到正确的有效注解；
• 可以把提取结果输出成JSON、CSV等格式，方便后续程序处理；
• 如果需要处理更多场景（比如字段的注解），可以用类似的思路，调用typeFactory.getAnnotatedType(fieldElement)即可。

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