您在 Java 项目中使用哪些代码分析工具？

前言

您在 Java 项目中使用哪些代码分析工具？

我对各种感兴趣

• 静态代码分析工具（FindBugs、PMD 和任何其他工具）
• 代码覆盖工具（Cobertura、Emma 等）
• 任何其他基于仪器的工具
• 还有什么，如果我错过了什么

如果适用，还要说明您使用的构建工具以及这些工具与您的 IDE 和构建工具的集成程度。

如果工具仅以特定方式可用（作为 IDE 插件，或者说，构建工具插件），那么该信息也值得注意。

静态分析工具

对于静态分析工具，我经常使用 CPD、PMD、FindBugs和Checkstyle。

CPD 是 PMD“复制/粘贴检测器”工具。在我注意到PMD 网页上的“查找重复代码”链接之前，我使用 PMD 有一段时间了。

我想指出，这些工具有时可以扩展到它们“开箱即用”的规则集之外。不仅仅是因为它们是开源的，因此您可以重写它们。其中一些工具带有允许它们扩展的应用程序或“钩子”。例如，PMD 带有允许您创建新规则的“设计器”工具。此外，Checkstyle 具有DescendantToken检查，该检查具有允许大量自定义的属性。

我将这些工具与基于 Ant 的构建集成在一起。您可以点击链接查看我评论的配置。

除了与构建的简单集成之外，我发现将工具配置为以其他几种方式进行某种“集成”很有帮助。即报告生成和警告抑制的一致性。我想在这个讨论中添加这些方面（可能也应该有“静态分析”标签）：人们如何配置这些工具来创建一个“统一”的解决方案？（我在这里单独问过这个问题）

首先，对于警告报告，我转换了输出，使每个警告都具有简单的格式

/absolute-path/filename:line-number:column-number: warning(tool-name): message

这通常被称为“Emacs 格式”，但即使您不使用 Emacs，它也是一种用于同质化报告的合理格式。例如：

/project/src/com/example/Foo.java:425:9: warning(Checkstyle):Missing a Javadoc comment.

我的警告格式转换是由我的 Ant 脚本和 Ant filterchains 完成的。

我做的第二个“整合”是为了警告抑制。默认情况下，每个工具都支持注释或注释（或两者），您可以将它们放在代码中以使您想忽略的警告静音。但是这些各种警告抑制请求并没有一致的外观，这似乎有些愚蠢。当你抑制警告时，你正在抑制警告，所以为什么不总是写“ SuppressWarning？”

例如，PMD 的默认配置禁止NOPMD在注释中带有字符串“”的代码行上生成警告。此外，PMD 支持 Java 的@SuppressWarnings注解。我将 PMD 配置为使用包含“”的注释，SuppressWarning(PMD.而不是NOPMD使 PMD 抑制看起来相似。我填写了使用注释样式抑制时违反的特定规则：

// SuppressWarnings(PMD.PreserveStackTrace) justification: (false positive) exceptions are chained

只有 " SuppressWarnings(PMD." 部分对注释很重要，但它与 PMD 对@SuppressWarning通过名称识别个别规则违规的注释的支持一致：

@SuppressWarnings("PMD.CompareObjectsWithEquals") // justification: identity comparision intended

类似地，Checkstyle 抑制注释对之间的警告生成（不提供注释支持）。默认情况下，关闭和打开 Checkstyle 的注释分别包含字符串CHECKSTYLE:OFF和CHECKSTYLE:ON。更改此配置（使用 Checkstyle 的“SuppressionCommentFilter”）以使用字符串“ BEGIN SuppressWarnings(CheckStyle.”和“ END SuppressWarnings(CheckStyle.”使控件看起来更像 PMD：

// BEGIN SuppressWarnings(Checkstyle.HiddenField) justification: "Effective Java," 2nd ed., Bloch, Item 2
// END SuppressWarnings(Checkstyle.HiddenField)

对于 Checkstyle 注释，特定的检查违规 ( HiddenField)很重要，因为每个检查都有自己的 " BEGIN/END" 注释对。

FindBugs 还支持带有@SuppressWarnings注释的警告生成抑制，因此无需进一步配置即可实现与其他工具的某种程度的一致性。不幸的是，Findbugs 必须支持自定义@SuppressWarnings注解，因为内置 Java@SuppressWarnings注解的SOURCE保留策略不够强大，无法将注解保留在 FindBugs 需要的类文件中。我完全限定了 FindBugs 警告抑制以避免与 Java 的@SuppressWarnings注释冲突：

@edu.umd.cs.findbugs.annotations.SuppressWarnings("UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR")

这些技术使不同工具的事情看起来相当一致。请注意，让每个警告抑制都包含字符串“ SuppressWarnings”可以轻松运行简单搜索以查找整个代码库中所有工具的所有实例。

代码覆盖工具

Cobertura、Checkstyle、(Ecl)Emma 和 Findbugs 的组合。

• Findbugs 查找常见错误错误/编码 - 从 maven 运行，并且还可以轻松集成到 Eclipse 中
• Cobertura 用于我们的报道报告 - 从 maven 运行

EclEmma是一个很棒的Eclipse 插件，它通过在编辑器中着色 java 源代码来显示代码覆盖率（截图）——覆盖率是通过运行 JUnit 测试生成的。当您试图找出特定类中涵盖了哪些行，或者如果您想查看单个测试涵盖了哪些行时，这非常有用。这比生成报告然后查看报告以查看哪些类的覆盖率低得多的用户友好和有用得多。

Checkstyle 和 Findbugs Eclipse 插件也很有用，它们会在您键入时在编辑器中生成警告。

Maven2 具有报告插件，可与上述工具一起在构建时生成报告。我们使用它来获取整体项目报告，这在您需要汇总数字时更有用。这些是由我们使用Continuum运行的 CI 构建生成的。

联系方式

关于文章中提到的工具可以通过关注公众号《编程乐学》获取对应资料，同时，公众号还有更多有趣的项目以及关于学习编程的笔记资料大家可以看看。