我们可以列举许多Java静态分析工具,每种工具都专注于特定领域并具有其优势,我们可以列举一下:
- Pmd是基于静态规则集的Java源代码分析器,它识别潜在的问题,例如:
- 可能的错误-空的try / catch / finally / switch块。
- 查找Java代码中的错误的FindBugs 。 它使用静态分析来识别Java程序中数百种不同的潜在错误类型。
- Checkstyle定义了一组可用的模块,每个模块均提供具有可配置的严格性级别(强制性,可选…)的规则检查。 每个规则都会引发通知,警告和错误。
存在许多利用这些工具的结果的方法:
- XML格式 :可以从这些工具中的每一个生成XML文件,并且可以将其用于创建HTML报告或由其他工具使用以利用分析结果。
- HTML格式 :HTML报告是生成报告并在团队之间共享的首选方法,您可以使用xsl样式表创建自定义报告。
- IDE插件 :几乎所有已知的IDE都为这些工具提供了插件,从而使您有可能从源代码中发现所有违规行为。
代码质量工具的问题之一是,它们往往使开发人员遇到的问题并不是真正的问题-即误报。 当出现误报时,开发人员将学会忽略工具的输出或完全放弃它。
为了更好地利用他们的结果,最好是只专注于我们想要的东西,并为开发人员提供有用的视图。 在本文中,我们将发现另一种有趣的方法,可以更好地利用所有已知的Java静态分析工具的结果,并像数据库一样查询它们。
JArchitect和CQLinq
JArchitect是另一个静态分析工具,是对其他工具的补充,它使用基于Linq(CQLinq)的代码查询语言来像数据库一样查询代码库。
在JArchitect 3之前,您只能查询从JArchitect提取的分析数据,但是V4提供了从许多其他静态分析工具导入分析结果并使用CQLinq查询的可能性。
让我们以PDT核心(Eclipse的Php插件)的源代码为例。 并发现我们如何利用JArchitect的这些工具的分析结果。
从这里开始是请求分析结果之前要遵循的步骤:
- 步骤1:使用PMD,CPD,FindBugs和CheckStyle分析项目。 并生成包含结果的XML文件。
- 步骤2:使用JArchitect分析项目。
- 步骤3:从菜单“插件->导入插件结果文件”将所有xml文件导入JArchitect。
默认情况下,JArchitect提供许多有用的查询来请求这些工具,并且所有这些查询都可以轻松自定义。
让我们发现一些CQLinq查询:
获取所有问题:
获取所有问题的请求非常简单,但是正如您所看到的那样,这不是很有趣,要利用232 725个问题来获取结果确实是一个挑战。
为了更好地利用这些工具的结果,我们可以使用CQLinq对其进行过滤,并仅关注我们想要的内容。
按工具要求
我们可以修改第一个请求并添加有关工具的标准。
规则集要求
我们还可以按发布规则集进行过滤:
优先要求
我们还可以按优先级过滤:
最经常出现的问题
有趣的是,这些工具报告的问题最多。
班级最多的课程
知道包含许多违规的类非常有趣
正如我们所看到的,CheckStyle报告了数千个问题,其中许多问题可以忽略。
上一个查询很有趣,但是并没有给我们提供质量欠佳的类,另一个有用的指标是NBLinesOfCode,这是很正常的,因为有很多代码行的类包含很多问题,因此我们可以修改先前的请求,以计算“问题数”和NBLinesofCode之间的比率。
这个结果非常奇怪的是,这8个头等舱的比率超过200,在这种情况下,按代码行,我们有200多个问题。
为了解释此行为,让我们看一下CompilerAstParser的一些行:
NbLinesOfCode是语句的数量,而不是物理行,并且该Class声明了许多数组,每个数组都由数千条物理行声明,但是每个数组声明都被视为一个语句。
如前所示,对于最经常出现的问题,以下规则“ +”应放在新行上。 每个数组被违反数千次。 也许最好从CheckStyle配置文件中删除这些规则。
最受欢迎的方法有问题
当静态分析工具报告问题时,找到要解决的优先问题很有用? 特别是在涉及错误时。
确实,特定方法中可能存在错误,但是有趣的是,有多少方法受到该错误的影响,而流行的方法是最常用的方法,因此最好快速解决它们。
使用CQLinq,我们可以结合所有这些工具的结果和JArchitect的结果来创建更详细的查询,并将这些检查添加到构建过程中。
问题趋势
在项目中遇到问题也不例外,可以说这很正常,但是我们必须检查项目的质量趋势。 确实,如果问题的数量在变更和演变之后增加,这是一个不好的指标。
JArchitect提供了趋势监视功能来创建趋势图。 趋势图由在分析时随时间记录的趋势指标值组成。 默认情况下,超过50个趋势指标可用,并且可以轻松创建自己的趋势指标。
让我们为Pmd问题创建趋势指标:
然后,您可以轻松地创建趋势图以监视先前的趋势指标并将其添加到JArchitect仪表板。
通过此趋势图,我们可以监视Pmd问题的演变,并尝试了解指标随着版本而增长的原因。
自定义JArchitect报告
JArchitect使得可以在HTML报表中附加列出一些CQLinq查询的额外报表部分。
在“ CQLinq查询资源管理器”面板中,所报告的特定CQLinq组以橙色矩形为边界。
您还可以将Pmd趋势图添加到报告中:
在HTML报告中,可以从菜单访问这些添加的部分:
这是在报告中为Pmd CQLinq查询添加的页面:
结论
JArchitect 4现在对其他静态分析工具开放,您也可以按此处的说明轻松插入自定义工具。 这样,您可以使用所有JArchitect功能来更好地利用已知的Java静态分析工具的结果。
翻译自: https://www.javacodegeeks.com/2013/11/exploit-better-the-results-of-pmd-findbugs-and-checkstyle.html