java - 在构建时在项目的所有文件中强制执行编码标准

Question

我知道 Stackoverflow 中有一些类似的问题，但它们要么与 .Net 相关，要么没有任何对我们有帮助的答案。

案例如下:我们和一些 friend 一起开始了一个开源项目。在为希望成功的项目奠定基础的同时，出现了一个问题:如何执行项目的代码约定？

理由是，作为一个开源项目，如果人们开始按照他们喜欢的方式重新格式化代码，补丁将变得杂乱无章，因为格式化会隐藏补丁的真正“值(value)”。所以我们想要一些东西来强制用户遵守特定的格式，如果他们不遵守则破坏构建。

该项目正在使用 Struts 2 + Spring + Hibernate，使用 Maven 2(正在考虑迁移到 Maven 3)。我们知道我们可以使用“CheckStyle”来测试 Java 文件，但这留下了一些悬而未决的问题，希望有人能回答:

• 有一些工具可以检查 XML 和 SQL 文件的样式，如果它们不遵守规则就会破坏构建？
• 是否有某种工具可以自动将源文件(Java、XML、SQL)重新格式化为所需的约定？能否以某种方式与 Maven 集成？

我们可以找到用于 Java 文件的 Jalopy，但我们更喜欢免费工具(据我们所知，最新版本是付费的)。我们仍然找不到任何关于 SQL/XML 的信息。

更新: 澄清一下:我不是在询问 PMD、Checkstyle 或这些工具。我要求的工具:

• 自动将 SQL、XML 和/或 Java 文件格式化为所需的编码约定(4 个空格等)
• 检测格式错误的 SQL 和 XML 文件并因此中断构建。

Answer 1

我将用于 java 的标准工具是

• 检查样式
• 查找错误
• 项目经理

当达到特定阈值时，所有这些都可能导致 Maven 构建失败。

但问题当然是:谁在何时运行这些工具？

我的建议是获得像 hudson 这样的持续集成服务器并将其配置为运行 maven checkstyle、findbugs 和 pmd 目标(hudson 有插件来显示所有这些工具的图表)，您将始终看到谁构建失败，因为您可以看到谁在两个构建之间提交了什么。