java - 自动检查 Java 文件是否符合编码标准

Question

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

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

另一种方法是使用某种仅具有信息功能的解析器。我们可以在 Jenkins 中运行一个流程，这当然会奏效，但这也意味着代码已经通过审查，这对于代码合规性检查来说通常有点晚。

是否有建议或什至是简单的方法将此类功能集成到 IDE、源代码控制系统 (Mercurial) 甚至 Jenkins 中？这在其他地方是如何实现的？

Answer 1

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

我正在使用 Sonar一体化。它包含许多外部检查器，如 PMD , 持续专业发展, Checkstyle , Findbugs并且可以与其他一些有用的工具集成，例如 Cobertura (测试覆盖率统计)。将 Sonar 构建绑定(bind)到 Jenkins 构建几乎是微不足道的，并且尝试避免主要/关键问题可能被认为是一种好方法。

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