在自定义声纳规则中获取 Java 方法注释的正确方法

Question

我尝试编写自定义声纳规则 (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

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

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

关于您对语法树的评论：语法树中的标识符将不包含有关包的信息（因为它的名称泄露了它，它只涉及 syntax ;)）。但是，您可以使用以下方法从源中查找注释的类型：

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

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