java - 在自定义 Sonar 规则中获取 Java 方法注释的正确方法

Question

我尝试编写自定义 Sonar 规则 (Java)，并努力寻找获取调用 Java 方法注释的正确方法。此规则应检测对标记为 @VisibleForTesting 的方法和字段的非法访问。从生产代码访问这些元素是非法的，但从同一个类访问是合法的。我的第一种方法是实现 BaseTreeVisitor.visitMethodInvocation(MethodInvocationTree) 并使用所属符号的元数据:

• 获取注释:methodInvocationSymbol.metadata().annotations()
• 分析每个AnnotationInstance(注解类)及其所有者(注解包)的符号名称

只要其他类调用该方法，它就可以很好地工作。当在同一个类中调用时 - 注释名称和包设置为 !unknownSymbol!。

我还尝试了另一种方法:分析 AnnotationTree 的 IdentifierTree(在 BaseTreeVisitor.visitMethodInvocation(MethodInvocationTree) 内)，但是我找不到如何获取注释包名称的方法。

我使用 sonar-java-plugin 3.7.1 和 sonar-plugin-api 5.1。

代码在此mvn / Eclipse project中提交.UnexpectedAccessCheckTest 包含 2 个用例。 “InvokedFromOtherClass”运行良好。 InvokedFromSameClass 通过了测试，但这只是偶然发生的——注释没有被正确检测到。它产生这个输出:

[main] DEBUG d.t.s.p.vft.checks.IsAnAnnotation - Checking Annotation. 
    Expected [com.google.common.annotations.VisibleForTesting] 
    got [.!unknownSymbol!]

正确的运行用例产生这个:

[main] DEBUG d.t.s.p.vft.checks.IsAnAnnotation - Checking Annotation. 
    Expected [com.google.common.annotations.VisibleForTesting] 
    got [com.google.common.annotations.VisibleForTesting]

你有什么提示给我吗？

Answer 1

第一种方法是首选，它应该适用于每个方法调用，即使在同一个类中也是如此。

如果它不起作用，则可能意味着调用的方法不是从语义解析的(这就是符号设置为未知的原因，当涉及泛型时，分析器在方法调用方面存在一些错误)。为了向您指出正确的票证，需要一个示例。

关于您对语法树的评论:语法树中的标识符不会包含有关包的信息(正如其名称所示，它仅涉及语法 ;))。但是，您可以使用以下方法从源中查找注释的类型:

annotationTree.annotationType().symbolType().is("com.mypackage.MyAnnotation")

确保预期的二进制文件在运行扫描时位于类路径中(请参阅 sonar.java.binaries 属性，或者如果您使用 maven-dependency-plugin使用 Maven)。