保障代码质量代码分析工具FindBugs介绍.docxVIP

保障代码质量：代码分析工具 FindBugs 介绍 摘要：本文介绍了代码分析工具 FindBugs 的功能及使用方法。FindBugs 可以在开发阶段检查出代码中常见但不易觉察的 Bug，通过 FindBugs 有效地帮助开发人员提高代码质量。 FindBugs 简介 FindBugs 是一个静态分析工具，它检查类或者 JAR 文件，将字节码与一组缺陷模式进行对比发现代码中可能存在的 Bug。有了静态分析工具，就可以在不实际运行程序的情况对代码进行分析。FindBugs 不是通过分析类文件的形式或结构来确定程序的逻辑，而是利用字节码分析和很多内置的 bug 模式检测器来查找代码中的常见 bug。它可以帮助您找出代码的哪些位置有意或者无意地偏离了良好的设计原理。 FindBugs 能检查出哪些问题 下面列出了 FindBugs 可以检查出的一些常见的问题： 找出 hash equals 不匹配 这个检测器寻找与 equals() 和 hashCode() 的实现相关的几个问题。这两个方法非常重要，因为几乎所有基于集合的类—— List、Map、Set 等都调用它们。 忽略方法返回值 String aString = bob;b.replace(b, p); String aString = bob; b.replace(b, p); if(b.equals(pop)) 这个错误很常见。在第 2 行，程序员认为他已经用 p 替换了字符串中的所有 b。确实是这样，但是他忘记了字符串是不可变的。所有这类方法都返回一个新字符串，而从来不会改变消息的接收者。 空指针对 null 的解引用（dereference）和冗余比较 Person person = aMap.get(zhangsan);if (person != null) Person person = aMap.get(zhangsan); if (person != null) { person.updateAccessTime(); 4 } 5 String name = person.getName(); 在这个例子中，如果第 1 行的 Map 不包括一个名为“ zhangsan”的人， 那么在第 5 行询问 person 的名字时就会出现 null 指针异常。因为 FindBugs 不知道 map 是否包含“zhangsan”，所以它将第 5 行标记为可能 null 指针异常。 初始化之前读取字段 public class Thing { public class Thing { private List actions; public Thing(String startingActions) { StringTokenizer tokenizer = new StringTokenizer(startingActions); while (tokenizer.hasMoreTokens()) { actions.add(tokenizer.nextToken()); 7 } 8 } 9 } 在这个例子中，第 6 行将产生一个 null 指针异常，因为变量 actions 还没有初始化。 打开 IO 输入输出流没有关闭的问题。 try {boolean try { boolean readerFlag = true; BufferedReader FileReader(d:\\test.txt)); while (readerFlag) { reader = new BufferedReader(new allWordInTxt = reader.readLine(); diTxt = reader.readLine(); diTxt = reader.readLine(); String end = reader.readLine(); if (end == null) { readerFlag = false; break; } } } catch (FileNotFoundException e1) { e1.printStackTrace(); } catch (IOException e) { e.printStackTrace(); } 在这个例子中，对 test.txt 的输入流 reader 开启后一直没有释放。 开启数据库连接没有关闭的问题。 程序中经常会出现开启数据库连接忘记关闭的情况。这种错误不容易发觉， 但是很容易引发数据库连接占用较多，不能连接数据库的问题。通过 FindBugs 可以很轻易地将这个问题排查出来。 其它常见问题 死循环。 在不同类型的变量中使用 equals()判断是否相等。 硬编码问题。 定义从来不会被使用的变量。 一直