您在Java项目上使用哪些代码分析工具?
我对各种感兴趣
- 静态代码分析工具(FindBugs,PMD和其他任何工具)
- 代码覆盖率工具(Cobertura,Emma等)
- 任何其他基于仪器的工具
- 还有什么,如果我想念什么
如果适用,还请说明您使用的构建工具以及这些工具与IDE和构建工具的集成程度。
如果仅以特定方式(例如,IDE插件或构建工具插件)提供工具,则该信息也值得注意。
您在Java项目上使用哪些代码分析工具?
我对各种感兴趣
如果适用,还请说明您使用的构建工具以及这些工具与IDE和构建工具的集成程度。
如果仅以特定方式(例如,IDE插件或构建工具插件)提供工具,则该信息也值得注意。
Answers:
对于静态分析工具,我经常使用CPD,PMD,FindBugs和Checkstyle。
CPD是PMD“复制/粘贴检测器”工具。我使用PMD一会儿之前,我注意到了“查找重复的代码”链接上的PMD的网页。
我想指出的是,这些工具有时可以扩展到超出其“开箱即用”规则的范围。不仅仅是因为它们是开源的,所以您可以重写它们。这些工具中的一些随应用程序或“挂钩”一起提供,可以对其进行扩展。例如,PMD附带了“设计器”工具,使您可以创建新规则。同样,Checkstyle具有DescendantToken检查,该检查具有允许进行大量自定义的属性。
我将这些工具与基于Ant的build集成在一起。您可以点击链接查看我的评论配置。
除了简单地集成到构建中之外,我还发现以其他几种方式将工具配置为“集成”有帮助。即,报告生成和警告抑制的一致性。我想在讨论中添加这些方面(可能还应该带有“ static-analysis”标签):人们如何配置这些工具以创建“统一”解决方案?(我在这里单独询问了这个问题)
首先,对于警告报告,我转换输出,以便每个警告具有简单的格式:
/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结合使用。
EclEmma是一个很棒的 Eclipse插件,它通过在编辑器中为Java源着色来显示代码覆盖率(截图)) -该覆盖率是通过运行JUnit测试生成的。当您试图找出特定类涵盖哪些行时,或者想要仅查看单个测试涵盖哪些行时,这确实很有用。与生成报告然后查看报告以查看覆盖率较低的类相比,这对用户更加友好和有用。
Checkstyle和Findbugs Eclipse插件也很有用,它们会在您键入时在编辑器中生成警告。
Maven2具有报告插件,可与上述工具配合使用,以在构建时生成报告。我们使用它来获取总体项目报告,当您需要合计数字时,这些报告会更有用。这些是由我们的CI构建生成的,这些构建使用Continuum运行。
以下所有我们都在Maven 2.x构建和Eclipse / RAD 7中使用并轻松集成了:
此外,在我们的Maven构建中,我们具有:
此外,如果您使用的是Maven 2.x,则CodeHaus的Mojo项目中有一组方便的Maven插件。
注意:Clover与Bamboo CI服务器具有现成的集成(因为它们都是Atlassian产品)。也有适用于FindBugs,PMD和CheckStyle的Bamboo插件,但如上所述,免费的Hudson CI服务器也具有这些插件。
Checkstyle是我在以前的公司中使用过的另一个样式...它主要用于样式检查,但是它也可以执行一些静态分析。另外,Clover用于代码覆盖,尽管要知道它不是免费的工具。
我正在寻找许多答案来学习新工具并将这些知识整合到一个问题/线程中,因此我怀疑该问题是否会有1个真正的答案。
我对自己的问题的回答是,我们使用:
Hudson还具有一个任务扫描器插件,该插件将显示您的TODO和FIXME的计数,并显示它们在源文件中的位置。
在我们的案例中,所有组件都与Maven 1.x集成在一起,并与Hudson捆绑在一起,Hudson会在签入以及每晚和每周的其他工作中运行我们的构建。Hudson趋势图显示了我们的JUnit测试,覆盖率,Findbug和开放任务。还有一个Hudson插件可以报告和绘制我们的编译警告。我们还使用Hudson plots插件进行了一些性能测试,这些测试带有自己的性能和内存使用情况随时间变化的图表。