java开发静态代码检查 静态测试之代码检查方法有哪些

findbugs，pmd，checkstyles三者都是代码规范静态检查工具，它们之间有何异同

区别是： findbug与pclint都是针对软件漏洞进行代码检测的工具软件。findbug针对的是Java代码，pclint针对的是C代码或者C++。 Findbugs是一款Java静态代码分析工具，与其他静态分析工具（如Checkstyle和PMD）不同，Findbugs 不注重样式或者格式

成都网络公司-成都网站建设公司成都创新互联10多年经验成就非凡，专业从事成都网站设计、做网站，成都网页设计，成都网页制作，软文平台，1元广告等。10多年来已成功提供全面的成都网站建设方案，打造行业特色的成都网站建设案例，建站热线：13518219792，我们期待您的来电！

做静态代码分析都是用那个软件的？

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

引言

在 Java 软件开发过程中，开发团队往往要花费大量的时间和精力发现并修改代码缺陷。Java 静态代码分析（static code analysis）工具能够在代码构建过程中帮助开发人员快速、有效的定位代码缺陷并及时纠正这些问题，从而极大地提高软件可靠性并节省软件开发和测试成 本。目前市场上的 Java 静态代码分析工具种类繁多且各有千秋，因此本文将分别介绍现有 4 种主流 Java 静态代码分析工具 (Checkstyle，FindBugs，PMD，Jtest)，并从功能、特性等方面对它们进行分析和比较，希望能够帮助 Java 软件开发人员了解静态代码分析工具，并选择合适的工具应用到软件开发中。

静态代码分析工具简介

什么是静态代码分析

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

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

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

静态代码分析工具的优势

1. 帮助程序开发人员自动执行静态代码分析，快速定位代码隐藏错误和缺陷。

2. 帮助代码设计人员更专注于分析和解决代码设计缺陷。

3. 显著减少在代码逐行检查上花费的时间，提高软件可靠性并节省软件开发和测试成本。

Java 静态代码分析理论基础和主要技术

缺陷模式匹配：缺陷模式匹配事先从代码分析经验中收集足够多的共性缺陷模式，将待分析代码与已有的共性缺陷模式进行模式匹配，从而完成软件的安全分析。这种方式的优点是简单方便，但是要求内置足够多缺陷模式，且容易产生误报。

类型推断：类型推断技术是指通过对代码中运算对象类型进行推理，从而保证代码中每条语句都针对正确的类型执行。这种技术首先将预定义一套类型机制，包括类 型等价、类型包含等推理规则，而后基于这一规则进行推理计算。类型推断可以检查代码中的类型错误，简单，高效，适合代码缺陷的快速检测。

模型检查：模型检验建立于有限状态自动机的概念基础之上，这一理论将被分析代码抽象为一个自动机系统，并且假设该系统是有限状态的、或者是可以通过抽象归 结为有限状态。模型检验过程中，首先将被分析代码中的每条语句产生的影响抽象为一个有限状态自动机的一个状态，而后通过分析有限状态机从而达到代码分析的 目的。模型检验主要适合检验程序并发等时序特性，但是对于数据值域数据类型等方面作用较弱。

数据流分析：数据流分析也是一种软件验证技术，这种技术通过收集代码中引用到的变量信息，从而分析变量在程序中的赋值、引用以及传递等情况。对数据流进行 分析可以确定变量的定义以及在代码中被引用的情况，同时还能够检查代码数据流异常，如引用在前赋值在后、只赋值无引用等。数据流分析主要适合检验程序中的 数据域特性。

现有主流 Java 静态分析工具

Checkstyle

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

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

图 1. 使用 Checkstyle 进行编码风格检查

此外，Checkstyle 支持用户根据需求自定义代码检查规范，在下图 2 中的配置面板中，用户可以在已有检查规范如命名约定，Javadoc，块，类设计等方面的基础上添加或删除自定义检查规范。

图 2. 使用 Checkstyle 添加自定义代码检查规范

FindBugs

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

图 3. 使用 FindBugs 进行静态代码分析

图中 Bug Explorer 中的灰色图标处为 Bug 类型，每种分类下红色图标表示 bug 较为严重，黄色的图标表示 bug 为警告程度。Propreties 列出了 bug 的描述信息及修改方案。

此外，FindBugs 还为用户提供定制 Bug Pattern 的功能。用户可以根据需求自定义 FindBugs 的代码检查条件，如下图 4 所示：

图 4. 使用 FindBugs 添加自定义代码检查规范

PMD

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

图 5. 使用 PMD 进行静态代码分析

PMD 同样也支持开发人员对代码检查规范进行自定义配置。开发人员可以在下图 6 中的面板中添加、删除、导入、导出代码检查规范。

图 6. 使用 PMD 添加自定义代码检查规范

Jtest

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

图 7. 使用 Jtest 进行静态代码分析

同时，Jtest 还提供了对用户定制代码检查配置甚至自定义编码规则的支持，这一功能使得开发人员可以基于不同场景定制所需要的编码规范，如图 8 所示：

图 8. 使用 Jtest 添加自定义代码检查规范

Java 静态分析工具对比

本章节将从以下几个方面对上述 Java 静态分析工具进行比较：

应用技术及分析对象

下表 1 列出了不同工具的分析对象及应用技术对比：

表 1. 不同工具的分析对象及应用技术对比

Java 静态分析工具

分析对象

应用技术

Checkstyle    Java 源文件    缺陷模式匹配  

FindBugs    字节码    缺陷模式匹配；数据流分析  

PMD    Java 源代码    缺陷模式匹配  

Jtest    Java 源代码    缺陷模式匹配；数据流分析  

内置编程规范

Checkstyle：

Javadoc 注释：检查类及方法的 Javadoc 注释

命名约定：检查命名是否符合命名规范

标题：检查文件是否以某些行开头

Import 语句：检查 Import 语句是否符合定义规范

代码块大小，即检查类、方法等代码块的行数

空白：检查空白符，如 tab，回车符等

修饰符：修饰符号的检查，如修饰符的定义顺序

块：检查是否有空块或无效块

代码问题：检查重复代码，条件判断，魔数等问题

类设计：检查类的定义是否符合规范，如构造函数的定义等问题

FindBugs：

Bad practice 坏的实践：常见代码错误，用于静态代码检查时进行缺陷模式匹配

Correctness 可能导致错误的代码，如空指针引用等

国际化相关问题：如错误的字符串转换

可能受到的恶意攻击，如访问权限修饰符的定义等

多线程的正确性：如多线程编程时常见的同步，线程调度问题。

运行时性能问题：如由变量定义，方法调用导致的代码低效问题。

PMD：

可能的 Bugs：检查潜在代码错误，如空 try/catch/finally/switch 语句

未使用代码（Dead code）：检查未使用的变量，参数，方法

复杂的表达式：检查不必要的 if 语句，可被 while 替代的 for 循环

重复的代码：检查重复的代码

循环体创建新对象：检查在循环体内实例化新对象

资源关闭：检查 Connect，Result，Statement 等资源使用之后是否被关闭掉

Jtest

可能的错误：如内存破坏、内存泄露、指针错误、库错误、逻辑错误和算法错误等

未使用代码：检查未使用的变量，参数，方法

初始化错误：内存分配错误、变量初始化错误、变量定义冲突

命名约定：检查命名是否符合命名规范

Javadoc 注释：检查类及方法的 Javadoc 注释

线程和同步：检验多线程编程时常见的同步，线程调度问题

国际化问题：

垃圾回收：检查变量及 JDBC 资源是否存在内存泄露隐患

错误检查能力

为比较上述 Java 静态分析工具的代码缺陷检测能力，本文将使用一段示例代码进行试验，示例代码中将涵盖我们开发中的几类常见错误，如引用操作、对象操作、表达式复杂化、数 组使用、未使用变量或代码段、资源回收、方法调用及代码设计几个方面。最后本文将分别记录在默认检查规范设置下，不同工具对该示例代码的分析结果。以下为 示例代码 Test.java。其中，代码的注释部分列举了代码中可能存在的缺陷。

清单 1. Test.java 示例代码

package Test;import java.io.*;public class Test {/**     * Write the bytes from input stream to output stream.     * The input stream and output stream are not closed.     * @param is     * @param os     * @throws IOException     */public boolean copy(InputStream is, OutputStream os)throws IOException {intcount = 0;//缺少空指针判断byte[] buffer =new byte[1024];while((count = is.read(buffer)) = 0) {os.write(buffer,0, count);}//未关闭I/O流returntrue;}/**     *     * @param a     * @param b     * @param ending     * @return copy the elements from a to b, and stop when meet element ending     */publicvoid copy(String[] a, String[] b, String ending){intindex;String temp =null;//空指针错误System.out.println(temp.length());//未使用变量intlength=a.length;for(index=0; indexa.length; index++){//多余的if语句if(true){//对象比较 应使用equalsif(temp==ending){break;}//缺少 数组下标越界检查b[index]=temp;}}}/**     *     * @param file     * @return file contents as stri if file does not exist     */public void  readFile(File file) {InputStream is =null;OutputStream os =null;try{is =new BufferedInputStream(newFileInputStream(file));os =new ByteArrayOutputStream();//未使用方法返回值copy(is,os);is.close();os.close();}catch (IOException e) {//可能造成I/O流未关闭e.printStackTrace();}finally{//空的try/catch/finally块}}}

通过以上测试代码，我们对已有 Java 静态代码分析工具的检验结果做了如下比较，如下表 2 所示。

表 2. Java 静态代码分析工具对比

代码缺陷分类

示例

Checkstyle

FindBugs

PMD

Jtest

引用操作    空指针引用    √    √    √    √  

对象操作    对象比较（使用 == 而不是 equals）         √    √    √  

表达式复杂化    多余的 if 语句              √       

数组使用    数组下标越界                   √  

未使用变量或代码段    未使用变量         √    √    √  

资源回收    I/O 未关闭         √         √  

方法调用    未使用方法返回值         √            

代码设计    空的 try/catch/finally 块              √       

由表中可以看出几种工具对于代码检查各有侧重。其中，Checkstyle 更偏重于代码编写格式，及是否符合编码规范的检验，对代码 bug 的发现功能较弱；而 FindBugs，PMD，Jtest 着重于发现代码缺陷。在对代码缺陷检查中，这三种工具在针对的代码缺陷类别也各有不同，且类别之间有重叠。

总结

本文分别从功能、特性和内置编程规范等方面详细介绍了包括 Checkstyle，FindBugs，PMD，Jtest 在内的四种主流 Java 静态代码分析工具，并通过一段 Java 代码示例对这四种工具的代码分析能力进行比较。由于这四种工具内置编程规范各有不同，因此它们对不同种类的代码问题的发现能力也有所不同。其中 Checkstyle 更加偏重于代码编写格式检查，而 FindBugs，PMD，Jtest 着重于发现代码缺陷。最后，希望本文能够帮助 Java 软件开发和测试人员进一步了解以上四种主流 Java 静态分析工具，并帮助他们根据需求选择合适的工具。

代码静态检查实现原理

静态代码分析原理分为两种：分析源代码编译后的中间文件（如Java的字节码）；分析源文件。主要分析技术如下：

缺陷模式匹配

事先从代码分析经验中收集足够多的共性缺陷模式，将待分析代码与已有的共性缺陷模式进行匹配，从而完成软件安全分析。优点：简单方便；缺点：需要内置足够多的缺陷模式，容易产生误报。

类型推断/类型推断

类型推断技术是指通过对代码中运算对象类型进行推理，从而保证代码中每条语句都针对正确的类型执行。

模型检查

建立于有限状态自动机的概念基础上。将每条语句产生的影响抽象为有限状态自动机的一个状态，再通过分析有限状态机达到分析代码目的。

校验程序并发等时序特性。

数据流分析

从程序代码中收集程序语义信息，抽象成控制流图，可以通过控制流图，不必真实的运行程序，可以分析发现程序运行时的行为。

java代码静态检查工具有什么用

用来检查编译器无法发现的更复杂一点的错误，最大可能避免（可能出现的）运行错误。很多代码写法编译器不报错，严格来讲也没错，但是会极大增加运行时报错的风险，静态检查工具就是用来跑程序之前尽量发现这些问题。例如变量引用前没有判空啦多线程引用变量没有锁啦blahblahblah

北大青鸟java培训：Java程序员需要掌握的Java基础知识？

Java已经存在很长时间了，当你使用不同的软件模式，你要清楚自己的代码如何影响生产，任何问题都要考虑的全面一些。

如果你给其他程序员提供API，请严格按照约定编写。

请读一本关于在有限内存设备上编程的书。

学习如何在小型设备上操纵像素。

一旦你学会了这些，那你就可以在任何设备上工作了，因为这些设备相对来说，运行更快、内存更大。

新的开发者需要理解面向对象编程的好处语法，并确保对象容易理解。

代码库能够帮助开发者上手。

像Lynda和Dzone这样的网站提供了很多Java相关的资源，所以Java比任何其他语言都更容易入门。

因为Java,Java很酷。

聪明的开发者反复重申要少使用Java。

Java提供了Java一样的功能，能够跨浏览器支持，所以用Java你能做任何事情，不用考虑浏览器兼容性。

记住要使用工具。

它越来越好，但仍落后于其他平台。

我对于容器化技术有很高的期望。

基于云的开发工具正在不断完善。

他们将预置到工作中使你的工作更简单。

确保工具好用。

开发者应该记住Java的静态类型检查是自动化测试的另一种形式。

构建代码的时候应该更多的用静态类型检查而不是其他形式的自动化测试。

具体来说，我们发现如果一个开发人员使用Java语言的时间比其他语言多的话，他们更倾向于花费时间构造代码来让编译器检查错误条件。

通常这种努力比花在自动化测试上更好，自动化测试可能会产生更多的错误条件。

Java不一定是所有应用程序的最佳解决方案。

例如，JVM比同等的C程序更消耗内存，科学计算和数值分析通常用Python来写，C#更适合异步编程。

然后试着学习理解某一领域的软件，如果你掌握的知识太广，那么你很难再取得进一步提升。

你需要理解基础架构，不要因为需要花费太多时间学习就放弃某一语言。

你对软件幕后工作原理了解的越多，你就会变得越有价值。

知道事务如何运作的原理是基础，请保持不断学习。

掌握完整的Java知识是一种良好的基本技能，这是开发者的关键投资。

很多企业都在寻找最聪明的工程师，他们很少关注特定的语言。

往往要求们开发人员需要有很强的编码能力，熟悉计算机基础知识，了解真实世界的应用程序，知道如何编写Java应用服务器程序，理解如何调用API，理解计算机科学的核心和算法。

企业需要基础扎实的开发人员。

IT培训建议请在工作中实践核心算法和熟悉的数据结构。

在Java生态系统中寻找最简单的达到目标的方法，参与开源，从修改一行bug这种小时做起，不断进步。