簡介： 本文首先介紹了靜態代碼分析的基本概念及主要技術，隨后分別介紹了現有 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. 顯著減少在代碼逐行檢查上花費的時間，提高軟件可靠性並節省軟件開發和測試成本。
- 缺陷模式匹配：缺陷模式匹配事先從代碼分析經驗中收集足夠多的共性缺陷模式，將待分析代碼與已有的共性缺陷模式進行模式匹配，從而完成軟件的安全分析。這種方式的優點是簡單方便，但是要求內置足夠多缺陷模式，且容易產生誤報。
- 類型推斷：類型推斷技術是指通過對代碼中運算對象類型進行推理，從而保證代碼中每條語句都針對正確的類型執行。這種技術首先將預定義一套類型機制，包括類 型等價、類型包含等推理規則，而后基於這一規則進行推理計算。類型推斷可以檢查代碼中的類型錯誤，簡單，高效，適合代碼缺陷的快速檢測。
- 模型檢查：模型檢驗建立於有限狀態自動機的概念基礎之上，這一理論將被分析代碼抽象為一個自動機系統，並且假設該系統是有限狀態的、或者是可以通過抽象歸 結為有限狀態。模型檢驗過程中，首先將被分析代碼中的每條語句產生的影響抽象為一個有限狀態自動機的一個狀態，而后通過分析有限狀態機從而達到代碼分析的 目的。模型檢驗主要適合檢驗程序並發等時序特性，但是對於數據值域數據類型等方面作用較弱。
- 數據流分析：數據流分析也是一種軟件驗證技術，這種技術通過收集代碼中引用到的變量信息，從而分析變量在程序中的賦值、引用以及傳遞等情況。對數據流進行 分析可以確定變量的定義以及在代碼中被引用的情況，同時還能夠檢查代碼數據流異常，如引用在前賦值在后、只賦值無引用等。數據流分析主要適合檢驗程序中的 數據域特性。
Checkstyle 是 SourceForge 的開源項目，通過檢查對代碼編碼格式，命名約定，Javadoc，類設計等方面進行代碼規范和風格的檢查，從而有效約束開發人員更好地遵循代碼編寫規范。
Checkstyle 提供了支持大多數常見 IDE 的插件，文本主要使用 Eclipse 中的 Checkstyle 插件。如下圖 1 所示，Checkstyle 對代碼進行編碼風格檢查，並將檢查結果顯示在 Problems 視圖中。圖中，代碼編輯器中每個放大鏡圖標表示一個 Checkstyle 找到的代碼缺陷。開發人員可通過在 Problems 視圖中查看錯誤或警告詳細信息。
Checkstyle在線安裝
注意在安裝過程中保持網絡暢通，如果網絡不穩定可能會導致安裝失敗。
Help --> Install New Software
CheckStyle插件地址：http://eclipse-cs.sourceforge.net/update
使用 Checkstyle 進行編碼風格檢查
Checkstyle全局配置
Window -->Preferences,選擇checkstyle菜單，增加項目組統一的規則文件，並設置為默認規則。如下圖：
到此全局配置已經完成。
Checkstyle項目配置
項目 --> 右鍵Properties
到此項目配置已經完成。成功的話，checkstyle已經開始工作了。
此次發現項目上有很多紅叉叉，說明是代碼符合規范造成的。
根據提示信息修改后，則沒有有紅色的提示。
其它操作
在項目右鍵菜單中，checkstyle還有一些快捷操作，如下圖所示：
checkstyle查出的問題列表見problem窗口：
FindBugs 是由馬里蘭大學提供的一款開源 Java 靜態代碼分析工具。FindBugs 通過檢查類文件或 JAR 文件，將字節碼與一組缺陷模式進行對比從而發現代碼缺陷，完成靜態代碼分析。FindBugs 既提供可視化 UI 界面，同時也可以作為 Eclipse 插件使用。文本將主要使用將 FindBugs 作為 Eclipse 插件。在安裝成功后會在 eclipse 中增加 FindBugs perspective，用戶可以對指定 Java 類或 JAR 文件運行 FindBugs，此時 FindBugs 會遍歷指定文件，進行靜態代碼分析，並將代碼分析結果顯示在 FindBugs perspective 的 bugs explorer 中，如下圖 3 所示：
安裝：
安裝步驟：
1.點擊“Help->InstallNew Software”，點擊“Add”，然后在彈出框“Name”輸入“findBugs”，“Location”輸入“http://findbugs.cs.umd.edu/eclipse”，點擊“OK”，3.選擇對應插件，然后點擊“next->next->finish”。
4.完成安裝之后重啟eclipse，右擊項目文件或目錄，會發現多了Findbugs的菜單，如下圖：
打開bug列表：
圖 3. 使用 FindBugs 進行靜態代碼分析
圖中 Bug Explorer 中的灰色圖標處為 Bug 類型，每種分類下紅色圖標表示 bug 較為嚴重，黃色的圖標表示 bug 為警告程度。Propreties 列出了 bug 的描述信息及修改方案。
此外，FindBugs 還為用戶提供定制 Bug Pattern 的功能。用戶可以根據需求自定義 FindBugs 的代碼檢查條件，如下圖 4 所示：
圖 4. 使用 FindBugs 添加自定義代碼檢查規范
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 是 Parasoft 公司推出的一款針對 Java 語言的自動化代碼優化和測試工具，Jtest 的靜態代碼分析功能能夠按照其內置的超過 800 條的 Java 編碼規范自動檢查並糾正這些隱蔽且難以修復的編碼錯誤。同時，還支持用戶自定義編碼規則，幫助用戶預防一些特殊用法的錯誤。Jtest 提供了基於 Eclipse 的插件安裝。Jtest 支持開發人員對 Java 代碼進行編碼規范檢查，並在 Jtask 窗口中集中顯示檢查結果，如下圖 7 所示：
圖 7. 使用 Jtest 進行靜態代碼分析
同時，Jtest 還提供了對用戶定制代碼檢查配置甚至自定義編碼規則的支持，這一功能使得開發人員可以基於不同場景定制所需要的編碼規范，如圖 8 所示：
圖 8. 使用 Jtest 添加自定義代碼檢查規范
本章節將從以下幾個方面對上述 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 示例代碼
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
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 靜態代碼分析工具的檢驗結果做了如下比較，如下表 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 靜態分析工具，並幫助他們根據需求選擇合適的工具。