文档章节

如何更好地利用Pmd、Findbugs和CheckStyle分析结果

colorchen
 colorchen
发布于 2017/01/04 14:12
字数 2035
阅读 136
收藏 4

里列出了很多Java静态分析工具,每一种工具关注一个特定的能发挥自己特长的领域,我们可以列举一下:

  • Pmd 它是一个基于静态规则集的Java源码分析器,它可以识别出潜在的如下问题:
    – 可能的bug——空的try/catch/finally/switch块。
    – 无用代码(Dead code):无用的本地变量,方法参数和私有方法。
    – 空的if/while语句。
    – 过度复杂的表达式——不必要的if语句,本来可以用while循环但是却用了for循环。
    – 可优化的代码:浪费性能的String/StringBuffer的使用。

  • FindBugs 它用来查找Java代码中存在的bug。它使用静态分析方法标识出Java程序中上百种潜在的不同类型的错误。

  • Checkstyle 它定义了一系列可用的模块,每一个模块提供了严格程度(强制的,可选的…)可配置的检查规则。规则可以触发通知(notification),警告(warning)和错误(error)。

现在有很多查看这些工具的处理结果的方式:

  • XML格式:这些工具都可以产生XML文件,这些XML文件能用来产生HTML报表或者是被别的工具用来浏览分析的结果。
  • HTML格式:HTML格式是最受欢迎的产生报表和团队间分享的的方式,你也可以用xsl表格创建你自己的报表。
  • IDE插件:几乎所有叫得上名字的IDE都给这些工具提供了插件,这使得发现源码中存在的所有问题几乎变成可能。

代码质量工具的一个问题是,它们有时候会给开发者提示很多不是错误的错误-也叫做假阳性(false positives)。当这种情况发生的时候,开发者可以学着忽略工具的输出信息,或者是把这些输出全部抛弃掉。

为了更好的利用这些工具的输出结果,给开发者一个更有用的视图,最好是有一种只关注我们想要的东西的方式。本文中,我们将找出其他有趣的方式来更好的利用所有这些有名的Java静态分析工具的输出结果,然后可以像查询数据库那样查询这些结果。

JArchitect和CQLinq

JArchitect是另一个静态分析工具,它弥补了其他工具(的不足),它是使用一种基于Linq(CQLinq)的代码查询语言像查询数据库那样来查询代码。

JArchitect3的以前版本,只能查询从JArchitect提取出来的分析数据,但是从JArchitect4开始,可以把许多其他静态分析工具的输出结果包含进来,然后使用CQLinq做查询。

让我们以PDT核心(eclipse的Php插件)的源码为例来说明如何在JArchitect中利用好这些静态工具的分析结果。

在查询分析结果以前,要遵守以下几个步骤:

  • 第一步:

用PMD,CPD,FindBugs和CheckStyle分析项目工程,生成包含分析结果的XML文件。

  • 第二步:

用JArchitect分析项目工程。

  • 第三步:

在JArchitect点击菜单“插件(Plugins)”->“导入插件结果文件(Import Plugins Result Files)”把所有的XML文件导入到JArchitect中。

JArchitect默认给这些工具提供了许多有用的查询,并且这些查询都是可以很简单的进行定制的。

让我们来看一些CQLinq的查询:

获取的所有的问题(issue):

获取所有问题的请求很简单,但是没什么用处,因为如何利用23272个问题的分析结果确实是一个很大的挑战。

为了更好的利用这些工具的分析结果,我们可以用CQLinq来做过滤,然后只关注那些我们想要关注的东西。

根据所使用的检查工具发请求

我们可以修改第一个请求,然后添加一个查询工具的criteria。

据规则集发请求

我们也可以根据问题的规则集做过滤:

根据优先级发请求

也可以根据优先级做过滤:

出现次数最多的问题

知道哪些问题是被这些工具报告次数最多的是很有用的。

出现问题最多的类

知道哪些类包含了最多的问题是很有用的。

上图可以看出来,CheckStyle报告的上千个问题中有很多是可以忽略的。

前面的查询很有用,但是,它并没有给我们一个精确的类质量的信息,因为要考虑的另一个有用的维度就是代码行数(NBLinesOfCode)。一般来说代码行数多的类会包含更多的问题,基于这个考虑,我们可以修改之前的请求来计算出问题数目和代码行数(NBLinesOfCode)的比率。

上面的查询结果看上去很奇怪,前8个类的问题数和代码行数比率超过了200,也就是说一行代码有超过200个问题。

为了解释这种行为,我们看下CompilerAstParser的一些代码:

代码行数(NBLinesOfCode)指的是语句的数目而不是代码的物理行数,CompilerAstParser这个类声明了很多数组,每一个都包含了几千个物理行,但是,每一个数组都被认为是一个语句。

就像前面展示的出现次数最多的问题那样,每一个数组都把”+应该在一个新行上”这个规则违反了上千次。或许最好是应该把这样的规则从CheckStyle的配置文件中删掉。

出问题最多的方法

当静态警察工具报告了问题以后,定位解决问题的优先级是很有用的,尤其是当包含bug的时候。

bug可能存在于某一个特定的方法中,但是,知道还有多少方法也受这个bug的影响是非常有用的。知道了出问题最多的这个方法做好事尽快把它解决掉。

使用CQLinq,我们可以把这些工具的结果和JArchitect的结果结合起来创建出更复杂的查询,然后把这些检查规则添加到构建过程中去。

问题的趋势

工程中有问题并不是异常情况,我们甚至可以说是正常的,但是,我们要检查工程的质量趋势。如果随着工程的更新和演化问题数目增加了,将会是一个很坏的指标。

JArchitect提供了趋势监控特性来创建趋势图。趋势图是根据分析时间记录的特定维度上的值创建出来的。默认有50多个趋势维度,也可以很简单定制趋势维度。

下面给Pmd问题创建一个趋势维度:

然后,你就可以很简单的创建趋势图在趋势维度上做监控,然后把它添加到JArchitect的操作面板中。

有了这个趋势图,我们就可以监视Pmd问题的进化,然后发现这个维度的问题随版本进化的原因。

定制JArchitect报表

JArchitect可以在列出了CQLinq查询的HTML报表中追加额外的报表区。

在CQLinq查询浏览面板中,一个特定的CQLinq组是用橙色的的边框包围的。

也可以把Pmd趋势图添加到报表中:

在HTML报表中,这些被添加进来的区域可以通过菜单访问:

这是被添加进Pmd查询报表中的页面:

结论

JArchitect 4 对其他的静态分析工具是开放的,你也可以很简单的像本文说的那样把你自己的工具做成它的插件。这样你就可以使用JArchitect的所有的功能来更好的利用那些有名的java静态分析工具的分析结果。

本文转载自: https://javadepend.wordpress.com/2013/11/25/exploit-better-the-results-of-pmd-findbugs-and-checksty

colorchen
粉丝 2
博文 30
码字总数 12316
作品 0
郑州
程序员
私信 提问
常用 Java 静态代码分析工具的分析与比较

简介: 本文首先介绍了静态代码分析的基本概念及主要技术,随后分别介绍了现有 4 种主流 Java 静态代码分析工具 (Checkstyle,FindBugs,PMD,Jtest),最后从功能、特性等方面对它们进行分析...

IBMdW
2011/07/01
49.2K
20
Android静态代码分析工具

原文地址:https://medium.com/mindorks/static-code-analysis-for-android-using-findbugs-pmd-and-checkstyle-3a2861834c6a 静态代码分析工具广泛用于Java开发,以改进代码库并识别潜在的漏...

小菜鸟程序媛
2018/06/20
0
0
Java静态检测工具/Java代码规范和质量检查简单介绍(转)

静态检查: 静态测试包括代码检查、静态结构分析、代码质量度量等。它可以由人工进行,充分发挥人的逻辑思维优势,也可以借助软件工具自动进行。代码检查代码检查包括代码走查、桌面检查、代...

easonjim
2017/10/18
0
0
Android 静态代码分析工具

简评: 作者在文中提到的三个静态代码分析工具不是互相替代的关系,各有各的侧重点,如果有需要完全可以同时使用。 静态代码分析是指无需运行被测代码,仅通过分析或检查源程序的语法、结构、...

极光推送
05/13
6
0
springboot+jenkins+maven+findbugs进行自动化测试

最近想做自动化静态bug测试,然后在自己的windows系统上搭了个jenkins,可是按照网上教程做的时候出问题了: 1、项目通过maven编译、启动后jenkins还不停止。 明明启动成功了,但莫名其妙的还...

弧线之内
2017/08/31
619
3

没有更多内容

加载失败,请刷新页面

加载更多

debian10使用putty配置交换机console口

前言:Linux的推广普及,需要配合解决实际应用方能有成效! 最近强迫自己用linux进行实际工作,过程很痛苦,还好通过网络一一解决,感谢各位无私网友博客的帮助! 系统:debian10 桌面:xfc...

W_Lu
35分钟前
10
0
aelf Enterprise 0.8.0 beta有奖公测,“Bug奖金计划”重磅开启

2019年9月30日,aelf Enterprise 0.8.0 beta版正式发布。aelf Enterprise 0.8.0 beta是一个完备的区块链系统, 包含完备的区块链系统、开发套件、开发文档、以及配套的基础应用和基础服务。 ...

AELF开发者社区
36分钟前
8
0
oracle 初始化数据库脚本

create user lpf identified by 123456; create tablespace lpf_ts_cms datafile '/opt/app/oracle/product/11.2.0/lpf.dbf' size 200M; alter user lpf default tablespace lpf_ts_cms; sel......

internetafei
40分钟前
6
0
《区块链DAPP开发入门、代码实现、场景应用》笔记1——天外飞仙DAPP

Solidity编程语言解决了编写智能合约的不友好的问题,但是当合约编译并部署之后,对与这些接口的访问,对于一般的使用者来说,门槛有点高, 对普通用户来说也是非常不友好,为了使广大用户理...

柯南和由美
45分钟前
6
0
流程图制作软件推荐_流程图制作软件哪个好

流程图(Flow Chart)是一种表示算法思路的图示,通过特定图形、图表可以直观的说明某一过程。这种过程既可以是生产线上的工艺流程图,也可以标明某项任务必需的管理过程。为了便于识别,绘制...

工具分享
47分钟前
7
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部