自动检查Java文件以编码标准合规性

Question

我正在从事Java开发.我最近遇到了必须遵守编码标准的情况:成员和方法排序,命名约定,修饰符序列.我正在考虑自动检查合规性的方法,或者生成某种进行重新排序的机制.

我们正在使用Eclipse开发,但该技术将是开放的.它可能的一种工作方式是生成外部构建器工具并将其添加到项目中.缺点是它会自动应用于所有文件,这可能会遇到遗留代码的问题,将错误计数推高到不再是合理的合理度量标准的程度.此外,它使代码审查变得更加困难,这是不希望的.

另一种方式是某种具有信息功能的解析器.我们可以在Jenkins中运行一个进程,这肯定会起作用,但这也意味着代码已经通过了审核,这对于代码合规性检查通常有点晚.

是否有建议甚至简单的方法将这些功能集成到IDE,源控制系统(Mercurial)甚至Jenkins中？这在其他地方如何执行？

Answer 1

我不建议自动进行此类更改。尽管大多数 checkstyle/pmd 符合要求，但我碰巧需要忽略一些警告/错误。此外，此类简单问题的数量非常少。大多数通知需要更复杂的操作，并且如果没有人工交互可能无法完成。

我正在使用声纳集成。它包含许多外部检查器，如PMD、CPD、Checkstyle、Findbugs ，并且可以与Cobertura （测试覆盖率统计）等其他一些有用的工具集成。将 Sonar 构建绑定到 Jenkins 构建几乎是微不足道的，并且尝试避免主要/关键问题可能被认为是一个好方法。

在开发环境中，我使用 Eclipse 与 findbugs 集成。还有一些与声纳的集成点，但它需要将代码提交到服务器或在本地运行服务器，我个人不喜欢这一点。然而，在 Sonar 中进行代码审查后经过几个周期的打磨代码后，您会发现您（和其他团队成员）遵守了大部分规则，并且每天检查报告就足够了。