SonarQube：创建自定义规则以获取类中的自定义注释

Question

我正在尝试创建一个自定义 SonarQube 规则，该规则将检测特定自定义 Java 注释的使用情况。这是我找到的代码，它打印了一个类中使用的所有注释的列表。

public class SampleAnnotationCheck extends IssuableSubscriptionVisitor {
    @Override
    public List<Tree.Kind> nodesToVisit() {
        return ImmutableList.of(Tree.Kind.METHOD);
    }

    @Override
    public void visitNode(Tree tree) {
        MethodTree methodTree = (MethodTree) tree;
        for (AnnotationInstance ai : ((JavaSymbol.MethodJavaSymbol) methodTree.symbol()).metadata().annotations()) {
            System.out.println(ai.symbol().name());
        }
    }
}

示例 Java 文件：

@GET
@Path(values)
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
method1(...) {...}

@CustomAnnotation(values)
@POST
@Path(values)
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
method2(...) {...}

@PATCH
@Path(values)
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
method3(...) {...}

预期输出：

GET
Path
Consumes
Produces
CustomAnnotation
POST
Path
Consumes
Produces
PATCH
Path
Consumes
Produces

实际输出：

GET
Path
Consumes
Produces
!unknownSymbol!
POST
Path
Consumes
Produces
!unknownSymbol!
Path
Consumes
Produces

我得到了 !unknownSymbol！而不是自定义注释的实际名称。自定义注释之一是 io.swagger.jaxrs.PATCH。

另一个注解在一个单独的包中定义并由示例类导入。

我们是否必须在某处注册这些自定义注释以供 API 检测？

请建议应该进行哪些更改，以便我们可以检测并打印实际的自定义注释名称。

提前致谢！

Answer 1

我假设您正在遵循本指南并在您的测试中运行检查 https://docs.sonarqube.org/display/PLUG/Writing+Custom+Java+Rules+101 。要为您的测试提供依赖项，您可以

• 将 jars 放入 target/test-jars 目录（在此处查看如何使用 maven 依赖插件 https://github.com/SonarSource/sonar-custom-rules-examples/blob/master/java-custom-rules/pom.xml#L147）

• 在您的测试中使用JavaCheckVerifier.verify(filename, check, classpath)提供自定义类路径