java – 与Checker Framework一起使用自定义注释处理器

如果不为javac提供–processor参数(请参阅doc-javac-options),则会激活注释处理器自动发现功能(请参阅javac-doc: Annotation processing).这意味着,javac将在类路径中搜索所有可用的注释处理器(如果已指定,则为processorpath).
包含META-INF / services / javax.annotation.processing.Processor文件的Jars可以指定其注释处理器类,javac将自动使用它们.

“问题”是检查器框架有多个多个注释处理器用于检查,但您可能只想使用其中的一些：因此无法使用注释发现过程,您必须手动指定要在其中运行的所有注释处理器你的构建文件.

对于Maven构建,您可以这样做：checker-framework doc for Maven

<annotationProcessors>
  <!-- Add all the checkers you want to enable here -->
  <annotationProcessor>org.checkerframework.checker.nullness.NullnessChecker</annotationProcessor>
</annotationProcessors>

这将显式设置javac的–processor参数(参见doc-javac-options),该参数禁用默认的注释发现过程.

所以解决方案是手动添加你想要运行的所有注释处理器(除了checker-framework检查器).

例如.如果要运行NullnessChecker和Dagger,则必须同时指定：

<annotationProcessors>
  <!-- Add all the checkers you want to enable here -->
  <annotationProcessor>org.checkerframework.checker.nullness.NullnessChecker</annotationProcessor>
  <!-- Add all your other annotation processors here -->
  <annotationProcessor>dagger.internal.codegen.ComponentProcessor</annotationProcessor>
</annotationProcessors>

暗示：
要找出您当前使用的注释处理器,请运行构建并将非标准选项-XprintProcessorInfo传递给javac.

更新：

检查器还支持某种自动发现(doc-ref) – 注意：我还没有使用它.

2.2.3 Checker auto-discovery

“Auto-discovery” makes the javac compiler always run a checker plugin,
even if you do not explicitly pass the -processor command-line option.
This can make your command line shorter,and ensures that your code is
checked even if you forget the command-line option.

To enable auto-discovery,place a configuration file named
META-INF/services/javax.annotation.processing.Processor in your
classpath. The file contains the names of the checker plugins to be
used,listed one per line. For instance,to run the Nullness Checker
and the Interning Checker automatically,the configuration file should
contain:

org.checkerframework.checker.nullness.NullnessChecker org.checkerframework.checker.interning.InterningChecker