如何在SonarQube中使用已有的Checkstyle文件

Question

我的同事和我想把SonarQube纳入我们现有的项目。Java项目的正常开发过程包括对代码更改运行Checkstyle以确保它们遵循我们的样式规则，将项目提交到我们的代码存储库，并让Jenkins构建和打包最新版本。我们希望将SonarQube添加到最后一步中（通过Jenkins插件），但我们不希望在SonarQube中复制所有的Checkstyle规则，因为这将需要我们维护两组单独的规则，并且如果需要对规则进行更改，会使事情变得更加复杂。我们不想完全切换到SonarQube，因为我们希望在将代码提交到存储库之前仍然运行Checkstyle。我们还希望维护自己的Checkstyle文件作为主要的样式规则集，而不是维护SonarQube上的样式规则并下载生成的XML文件用于本地开发。

那么有没有办法将我们现有的一组Checkstyle XML文件“上传”（可以这么说）到SonarQube以供它在其评估中使用呢？

谢谢你的帮助。

Answer 1

另外，让Sonar使用存储库中的Checkstyle定义是不可能的。然而，可以让Sonar使用存储库中的当前Checkstyle抑制过滤器。

至于规则定义，我认为您必须在Sonar中维护它们，并且在更改任何内容时，也要更改Eclipse-CS使用的存储库中的副本。这是多余的，但至少只影响到一个人--团队的其他成员都能收获收益。这种方法还可以实现有意的差异，例如，当检查某些Eclipse特定的问题时（例如，与Sonar中不存在的源文件夹有关的问题）。

可以在Sonar中配置抑制过滤器文件的路径，以引用您的资料被签出以进行Sonar分析的位置。这样就可以在存储库中维护该部分,而不会有任何冗余。