Java 静态代码分析工具简要分析与使用

原创
2018/06/21 21:22
阅读数 6.5K

本文首先介绍了静态代码分析的基本概念及主要技术,随后分别介绍了现有 4 种主流 Java 静态代码分析工具 (Checkstyle,FindBugs,PMD,Jtest),对它们进行分析和比较,希望能够帮助 Java 软件开发人员了解静态代码分析工具,并选择合适的工具应用到软件开发中。

1、什么是静态代码分析

静态代码分析是指无需运行被测代码,仅通过分析或检查源程序的语法、结构、过程、接口等来检查程序的正确性,找出代码隐藏的错误和缺陷,如参数不匹配,有歧义的嵌套语句,错误的递归,非法计算,可能出现的空指针引用等等。

在软件开发过程中,静态代码分析往往先于动态测试之前进行,同时也可以作为制定动态测试用例的参考。统计证明,在整个软件开发生命周期中,30% 至 70% 的代码逻辑设计和编码缺陷是可以通过静态代码分析来发现和修复的。

但是,由于静态代码分析往往要求大量的时间消耗和相关知识的积累,因此对于软件开发团队来说,使用静态代码分析工具自动化执行代码检查和分析,能够极大地提高软件可靠性并节省软件开发和测试成本。

2、现有主流 Java 静态分析工具

  • Checkstyle

        Checkstyle 是 SourceForge 的开源项目,通过检查对代码编码格式,命名约定,Javadoc,类设计等方面进行代码规范和风格的检查,从而有效约束开发人员更好地遵循代码编写规范。

        Checkstyle 提供了支持大多数常见 IDE 的插件,文本主要使用 Eclipse 中的 Checkstyle 插件。如下图 1 所示,Checkstyle 对代码进行编码风格检查,并将检查结果显示在 Problems 视图中。图中,代码编辑器中每个放大镜图标表示一个 Checkstyle 找到的代码缺陷。开发人员可通过在 Problems 视图中查看错误或警告详细信息。

  • FindBugs

        FindBugs 是由马里兰大学提供的一款开源 Java 静态代码分析工具。FindBugs 通过检查类文件或 JAR 文件,将字节码与一组缺陷模式进行对比从而发现代码缺陷,完成静态代码分析。FindBugs 既提供可视化 UI 界面,同时也可以作为 Eclipse 插件使用。文本将主要使用将 FindBugs 作为 Eclipse 插件。在安装成功后会在 eclipse 中增加 FindBugs perspective,用户可以对指定 Java 类或 JAR 文件运行 FindBugs,此时 FindBugs 会遍历指定文件,进行静态代码分析,并将代码分析结果显示在 FindBugs perspective 的 bugs explorer 中。

  • PMD

        PMD 是由 DARPA 在 SourceForge 上发布的开源 Java 代码静态分析工具。PMD 通过其内置的编码规则对 Java 代码进行静态检查,主要包括对潜在的 bug,未使用的代码,重复的代码,循环体创建新对象等问题的检验。PMD 提供了和多种 Java IDE 的集成,例如 Eclipse,IDEA,NetBean 等。本文主要使用 PMD 以插件方式与 Eclipse 集成。如下图 5 所示:在 Violations Overview 视图中,按照代码缺陷严重性集中显示了 PMD 静态代码分析的结果。

  • Jtest

        Jtest 是 Parasoft 公司推出的一款针对 Java 语言的自动化代码优化和测试工具,Jtest 的静态代码分析功能能够按照其内置的超过 800 条的 Java 编码规范自动检查并纠正这些隐蔽且难以修复的编码错误。同时,还支持用户自定义编码规则,帮助用户预防一些特殊用法的错误。Jtest 提供了基于 Eclipse 的插件安装。Jtest 支持开发人员对 Java 代码进行编码规范检查,并在 Jtask 窗口中集中显示检查结果。

 

3、PMD的使用方式

        以上四种工具都有各自的特点,使用方式类似,都可以基于 Eclipse 的插件安装,使用简单高效。

        现在以 PMD 为例讲解的安装和使用。

1、PMD基于 Eclipse 插件安装

  • 在线安装(推荐)

             安装地址:https://sourceforge.net/projects/pmd/files/pmd-eclipse/update-site/

             如下图:

                

  • 离线插件包安装

            下载地址:https://sourceforge.net/projects/pmd/

            安装完成后,重启Eclipse即可。

   2、PMD的使用方法

  • 查看安装是否成功

        PMD插件安装完成后,在项目源代码目录上右键,可以看到PMD选项,如下图:

            

  • 代码分析

选择 PMD -> Check Code 即可对项目所有代码进行分析,可以打开 PMD -> Violations Outline 视图 对 每一个类的 分析结果进行查看,如下图:

针对每个提示的错误进行分析 并选择性的进行优化。

在PMD中错误的优先级分为五种,对应不同的颜色展示,如下图:

可以在Violations视图中筛选不同级别的错误,如下图:

                

  • 清除PMD提示

        PMD进行代码检查后,会在类文件和左侧源文件树中生成错误优先级三角块,我们可以通过 PMD -> Clear Violatons 来清除这些展示

 

 

        PMD 自带了很多代码规范的规则,还可以自定义规则,我们可以把这些规则整合到一起,按照我们的需求进行代码检查,有关自定义规则的内容,可以自行搜索。

展开阅读全文
打赏
0
9 收藏
分享
加载中
更多评论
打赏
0 评论
9 收藏
0
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部