make checkstyle 检查 javax 路径注解

Question

我正在尝试使用正则表达式创建一个 checkstyle 模块，用于检查 javax.ws.rs.Path 注释是否以斜杠开头。

在我定义的 checkstyle.xml 文件中

<module name="Regex">
    <property name="format" value="/api" />
    <property name="message" value="Missing /" />
</module>

我想要它检查的是我是否有如下资源类

@Path("/api/v1/persons")
public class PersonResource {
  ...
}

如果我的班级如下所示，那么它应该没有任何问题通过检查

@Path("api/v1/persons")
public class PersonResource {
  ...
}

请注意，第一个 / 丢失了，那么它应该会从我的 checkstyle 中收到错误/警告。

现在这可以通过 checkstyle 实现吗，还是我必须自己编写 check。

而且我似乎在 Annotations 中找不到任何可以解决问题的东西。

Answer 1

没有标准的检查来满足你的需要，但是有非标准的检查和http://sevntu-checkstyle.github.io/sevntu.checkstyle/apidocs/com/github/sevntu/checkstyle/checks/annotation/ForbidAnnotationElementValueCheck.html应该能够强制执行正确的值，你只需要制作正确的正则表达式。项目页面https://github.com/sevntu-checkstyle/sevntu.checkstyle。如果您在使用自定义检查时遇到问题，可以将此检查移至标准库，但这需要您的帮助。