1. 简介与引言

1.1 简介

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

1.2 引言

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

2. 静态代码分析工具简介

2.1 什么是静态代码分析

静态代码分析是指无需运行被测代码，仅通过分析或检查源程序的语法、结构、过程、接口等来检查程序的正确性，找出代码隐藏的错误和缺陷，如参数不匹配，有歧义的嵌套语句，错误的递归，非法计算，可能出现的空指针引用等等。在软件开发过程中，静态代码分析往往先于动态测试之前进行，同时也可以作为制定动态测试用例的参考。统计证明，在整个软件开发生命周期中，30%至70%的代码逻辑设计和编码缺陷是可以通过静态代码分析来发现和修复的。但是，由于静态代码分析往往要求大量的时间消耗和相关知识的积累，因此对于软件开发团队来说，使用静态代码分析工具自动化执行代码检查和分析，能够极大地提高软件可靠性并节省软件开发和测试成本。

2.2 静态代码分析工具的优势

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

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

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

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

2.3.1 分缺陷模式匹配

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

2.3.2 类型推断

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

2.3.3 模型检查

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

2.3.4 数据流分析

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

3. 现有主流Java静态分析工具

3.1 Checkstyle

3.1.1 简介

Checkstyle是SourceForge的开源项目，通过检查对代码编码格式，命名约定，Javadoc，类设计等方面进行代码规范和风格的检查，从而有效约束开发人员更好地遵循代码编写规范。Checkstyle 提供了支持大多数常见IDE的插件，文本主要使用IntelliJ IDEA中的CheckStyle-IDEA插件。

3.1.2 内置编程规范

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

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

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

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

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

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

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

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

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

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

3.1.3 在idea中集成CheckStyle

File->Setting->Plugins至下图界面，搜索CheckStyle-IDEA，点击安装。

image.png

3.1.4 在idea中使用CheckStyle

第一步，使CheckStyle在idea中生效

settings->Editor->Inspections->CheckStyle

image.png

第二步，添加配置文件，即为CheckStyle配置检测的规范，设定需要的代码规范

以下是配置文件的一个样本：

<?xml version="1.0"?>

<!DOCTYPE module PUBLIC

        "-//Puppy Crawl//DTD Check Configuration 1.3//EN"

        "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">

<module name="Checker">

    <!--

        If you set the basedir property below, then all reported file

        names will be relative to the specified directory. See

http://checkstyle.sourceforge.net/5.x/config.html#Checker

        <property name="basedir" value="${basedir}"/>

    -->

    <!-- 检查每个包中是否有java注释文件，默认有package-info.java -->

    <!-- <module name="JavadocPackage"/> -->

    <!-- 检查文件是否以一个空行结束 -->

    <module name="NewlineAtEndOfFile"/>

    <!-- 检查property文件中是否有相同的key -->

    <module name="Translation"/>

    <!-- 文件长度不超过1500行 -->

    <module name="FileLength">

        <property name="max" value="1500"/>

    </module>

    <!-- 检查文件中是否含有'\t' -->

    <module name="FileTabCharacter"/>

    <!-- Miscellaneous other checks. -->

    <module name="RegexpSingleline">

        <property name="format" value="\s+$"/>

        <property name="minimum" value="0"/>

        <property name="maximum" value="0"/>

        <property name="message" value="Line has trailing spaces."/>

    </module>

    <!-- 每个java文件一个语法树 -->

    <module name="TreeWalker">

        <!-- 注释检查 -->

        <!-- 检查方法和构造函数的javadoc -->

        <module name="JavadocMethod">

            <property name="tokens" value="METHOD_DEF" />

        </module>

        <!-- 检查类和接口的javadoc。默认不检查author和version tags -->

        <module name="JavadocType"/>

        <!-- 检查变量的javadoc -->

        <module name="JavadocVariable"/>

        <!-- 检查javadoc的格式 -->

        <module name="JavadocStyle">

            <property name="checkFirstSentence" value="false"/>

        </module>

        <!-- 检查TODO:注释 -->

        <module name="TodoComment"/>

        <!-- 命名检查 -->

        <!-- 局部的final变量，包括catch中的参数的检查 -->

        <module name="LocalFinalVariableName" />

        <!-- 局部的非final型的变量，包括catch中的参数的检查 -->

        <module name="LocalVariableName" />

        <!-- 包名的检查（只允许小写字母），默认^[a-z]+(\.[a-zA-Z_][a-zA-Z_0-9_]*)*$ -->

        <module name="PackageName">

            <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$" />

            <message key="name.invalidPattern" value="包名 ''{0}'' 要符合 ''{1}''格式."/>

        </module>

        <!-- 仅仅是static型的变量（不包括static final型）的检查 -->

        <module name="StaticVariableName" />

        <!-- Class或Interface名检查，默认^[A-Z][a-zA-Z0-9]*$-->

        <module name="TypeName">

            <property name="severity" value="warning"/>

            <message key="name.invalidPattern" value="名称 ''{0}'' 要符合 ''{1}''格式."/>

        </module>

        <!-- 非static型变量的检查 -->

        <module name="MemberName" />

        <!-- 方法名的检查 -->

        <module name="MethodName" />

        <!-- 方法的参数名 -->

        <module name="ParameterName " />

        <!-- 常量名的检查（只允许大写），默认^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$ -->

        <module name="ConstantName" />

        <!-- 定义检查 -->

        <!-- 检查数组类型定义的样式 -->

        <module name="ArrayTypeStyle"/>

        <!-- 检查方法名、构造函数、catch块的参数是否是final的 -->

        <!-- <module name="FinalParameters"/> -->

        <!-- 检查long型定义是否有大写的“L” -->

        <module name="UpperEll"/>

        <!-- import检查-->

        <!-- 避免使用* -->

        <module name="AvoidStarImport"/>

        <!-- 检查是否从非法的包中导入了类 -->

        <module name="IllegalImport"/>

        <!-- 检查是否导入了多余的包 -->

        <module name="RedundantImport"/>

        <!-- 没用的import检查，比如：1.没有被用到2.重复的3.import java.lang的4.import 与该类在同一个package的 -->

        <module name="UnusedImports" />

        <!-- 长度检查 -->

        <!-- 方法不超过150行 -->

        <module name="MethodLength">

            <property name="tokens" value="METHOD_DEF" />

            <property name="max" value="150" />

        </module>

        <!-- 方法的参数个数不超过5个。 并且不对构造方法进行检查-->

        <module name="ParameterNumber">

            <property name="max" value="10" />

            <property name="ignoreOverriddenMethods" value="true"/>

            <property name="tokens" value="METHOD_DEF" />

        </module>

        <!-- 空格检查-->

        <!-- 方法名后跟左圆括号"(" -->

        <module name="MethodParamPad" />

        <!-- 在类型转换时，不允许左圆括号右边有空格，也不允许与右圆括号左边有空格 -->

        <module name="TypecastParenPad" />

        <!-- Iterator -->

        <!-- <module name="EmptyForIteratorPad"/> -->

        <!-- 检查尖括号 -->

        <!-- <module name="GenericWhitespace"/> -->

        <!-- 检查在某个特定关键字之后应保留空格 -->

        <module name="NoWhitespaceAfter"/>

        <!-- 检查在某个特定关键字之前应保留空格 -->

        <module name="NoWhitespaceBefore"/>

        <!-- 操作符换行策略检查 -->

        <module name="OperatorWrap"/>

        <!-- 圆括号空白 -->

        <module name="ParenPad"/>

        <!-- 检查分隔符是否在空白之后 -->

        <module name="WhitespaceAfter"/>

        <!-- 检查分隔符周围是否有空白 -->

        <module name="WhitespaceAround"/>

        <!-- 修饰符检查 -->

        <!-- 检查修饰符的顺序是否遵照java语言规范，默认public、protected、private、abstract、static、final、transient、volatile、synchronized、native、strictfp -->

        <module name="ModifierOrder"/>

        <!-- 检查接口和annotation中是否有多余修饰符，如接口方法不必使用public -->

        <module name="RedundantModifier"/>

        <!-- 代码块检查 -->

        <!-- 检查是否有嵌套代码块 -->

        <module name="AvoidNestedBlocks"/>

        <!-- 检查是否有空代码块 -->

        <module name="EmptyBlock"/>

        <!-- 检查左大括号位置 -->

        <module name="LeftCurly"/>

        <!-- 检查代码块是否缺失{} -->

        <module name="NeedBraces"/>

        <!-- 检查右大括号位置 -->

        <module name="RightCurly"/>

        <!-- 代码检查 -->

        <!-- 检查是否在同一行初始化 -->

        <!-- <module name="AvoidInlineConditionals"/> -->

        <!-- 检查空的代码段 -->

        <module name="EmptyStatement"/>

        <!-- 检查在重写了equals方法后是否重写了hashCode方法 -->

        <module name="EqualsHashCode"/>

        <!-- 检查局部变量或参数是否隐藏了类中的变量 -->

        <module name="HiddenField">

            <property name="tokens" value="VARIABLE_DEF"/>

        </module>

        <!-- 检查是否使用工厂方法实例化 -->

        <module name="IllegalInstantiation"/>

        <!-- 检查子表达式中是否有赋值操作 -->

        <module name="InnerAssignment"/>

        <!-- 检查是否有"魔术"数字 -->

        <module name="MagicNumber">

            <property name="ignoreNumbers" value="0, 1"/>

            <property name="ignoreAnnotation" value="true"/>

        </module>

        <!-- 检查switch语句是否有default -->

        <module name="MissingSwitchDefault"/>

        <!-- 检查是否有过度复杂的布尔表达式 -->

        <module name="SimplifyBooleanExpression"/>

        <!-- 检查是否有过于复杂的布尔返回代码段 -->

        <module name="SimplifyBooleanReturn"/>

        <!-- 类设计检查 -->

        <!-- 检查类是否为扩展设计l -->

        <!-- <module name="DesignForExtension"/> -->

        <!-- 检查只有private构造函数的类是否声明为final -->

        <module name="FinalClass"/>

        <!-- 检查工具类是否有putblic的构造器 -->

        <module name="HideUtilityClassConstructor"/>

        <!-- 检查接口是否仅定义类型 -->

        <module name="InterfaceIsType"/>

        <!-- 检查类成员的可见度 -->

        <module name="VisibilityModifier"/>

    </module>

</module>

步骤：首先在本地新建一个XML文件，将上面的代码保存到XML文件中，打开 settings->Other Settings->CheckStyle，如下图，点击＋

image.png

在弹出的小窗口中选择我们刚才保存到本地的配置文件

image.png

点击Next后点击Finsh，完成配置。

第三步，测试我们配置的CheckStyle是否生效

首先，选择要测试的代码文件，然后右击选择Check Current File，

image.png

然后选择我们配置的规则，点击之后，我们可以看到，CheckStyle帮我们指出了代码中的不规范。

image.png

3.2 FindBugs

3.2.1 简介

FindBugs 是由马里兰大学提供的一款开源 Java 静态代码分析工具。FindBugs 通过检查类文件或 JAR 文件，将字节码与一组缺陷模式进行对比从而发现代码缺陷，完成静态代码分析。FindBugs 既提供可视化 UI 界面，同时也可以作为 IntelliJ IDEA插件使用。文本将主要使用将 FindBugs-IDEA 作为 IntelliJ IDEA插件。

3.2.2 内置编程规范

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

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

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

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

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

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

3.2.3 在idea中集成FindBugs

File->Setting->Plugins至下图界面，搜索FindBugs-IDEA，点击安装。

image.png

3.2.4 在idea中使用FindBugs

安装好重启，在IEDA左下角会有[图片上传失败...(image-9a21eb-1586735691475)]

标致的控制面板，点击面板，选择要分析的Java文件点击[图片上传失败...(image-5d08d-1586735691475)]

分析，检查结果如下。

image.png

插件面板按钮说明

1 分析选中的 Java 文件

2 分析在光标所在的类

3 分析选中的包

4 分析选中的模块 (点击时会询问是否同时分析 test 包中的类)

5 分析整个项目 (点击时会询问是否同时分析 test 包中的类)

6 自定义分析的类

7 分析被修改的类 (搭配 SVN,Git 使用)

8 分析 changelist 中的类 (搭配 SVN,Git 使用)

9 停止分析

10 根据 BUG 类型分组

11 根据类分组

12 根据包分组

13 根据 BUG 严重级别分组

FindBugs 只是一款静态代码分析工具, 虽然分析大多数的问题, 但是如果希望编写更为健壮的程序, 还需进行更多的测试操作, 切不可认为 FindBugs 没有分析出问题便认为没有问题了。

3.3 PMD

3.3.1 简介

Facebook 的 Infer 是一个静态分析工具。Infer 可以分析 Objective-C， Java 或者 C 代码，报告潜在的问题。任何人都可以使用 Infer 检测应用，这可以将那些严重的 bug 扼杀在发布之前，同时防止应用崩溃和性能低下。

3.3.2 内置编程规范

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

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

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

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

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

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

3.3.3 在idea中集成PMDPlugin

File->Setting->Plugins至下图界面，搜索PMDPlugin，点击安装。

image.png

3.3.4 在idea中使用PMDPlugin

在代码编辑框或Project 窗口的文件夹、包、文件右键，选择“Run PMD”，“Pre Defined”，“All”，对指定的文件夹、包、文件进行分析：

image.png

等待一段时间，即可看到分析的结果。

image.png

点击展开即可查看相应的具体代码。

image.png

3.4 Jtest

3.4.1 简介

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

3.4.2 内置编程规范

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

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

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

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

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

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

国际化问题：

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

3.4.3 在idea中集成Jtest

由于本文是基于IntelliJ IDEA讲解的，而Jtest目前没有基于IntelliJ IDEA的插件，因此本部分不作描述(自行搜索参考在Eclipse的使用)。

3.4.4 在idea中使用Jtest

由于本文是基于IntelliJ IDEA讲解的，而Jtest目前没有基于IntelliJ IDEA的插件，因此本部分不作描述(自行搜索参考在Eclipse的使用)。

4. 错误检查能力

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

4.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 {

        int count = 0;

        //缺少空指针判断

        byte[] buffer = new byte[1024];

        while ((count = is.read(buffer)) >= 0) {

            os.write(buffer, 0, count);

        }

        //未关闭I/O流

        return true;

    }

    /**

     *

     * @param a

     * @param b

     * @param ending

     * @return copy the elements from a to b, and stop when meet element ending

     */

    public void copy(String[] a, String[] b, String ending)

    {

        int index;

        String temp = null;

        //空指针错误

        System.out.println(temp.length());

        //未使用变量

        int length=a.length;

        for(index=0; index&a.length; index++)

        {

            //多余的if语句

            if(true)

            {

                //对象比较 应使用equals

                if(temp==ending)

                {

                    break;

                }

                //缺少 数组下标越界检查

                b[index]=temp;

            }

        }

    }

    /**

     *

     * @param file

     * @return file contents as string; null if file does not exist

     */

    public  void  readFile(File file) {

        InputStream is = null;

        OutputStream os = null;

            try {

                is = new BufferedInputStream(new FileInputStream(file));

                os = new ByteArrayOutputStream();

                //未使用方法返回值

                copy(is,os);

                is.close();

                os.close();

            } catch (IOException e) {

                //可能造成I/O流未关闭

                e.printStackTrace();

            }

            finally

            {

                //空的try/catch/finally块

            }

    }

}

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

4.2 Java 静态代码分析工具对比

image.png

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

5.结论

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

Java代码检查工具方案

Java代码检查工具方案

1. 简介与引言

1.1 简介

1.2 引言

2. 静态代码分析工具简介

2.1 什么是静态代码分析

2.2 静态代码分析工具的优势

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

2.3.1 分缺陷模式匹配

2.3.2 类型推断

2.3.3 模型检查

2.3.4 数据流分析

3. 现有主流Java静态分析工具

3.1 Checkstyle

3.1.1 简介

3.1.2 内置编程规范

3.1.3 在idea中集成CheckStyle

3.1.4 在idea中使用CheckStyle

3.2 FindBugs

3.2.1 简介

3.2.2 内置编程规范

3.2.3 在idea中集成FindBugs

3.2.4 在idea中使用FindBugs

3.3 PMD

3.3.1 简介

3.3.2 内置编程规范

3.3.3 在idea中集成PMDPlugin

3.3.4 在idea中使用PMDPlugin

3.4 Jtest

3.4.1 简介

3.4.2 内置编程规范

3.4.3 在idea中集成Jtest

3.4.4 在idea中使用Jtest

4. 错误检查能力

4.1 清单Test.java示例代码

4.2 Java 静态代码分析工具对比

5.结论