一．概述
產品線最近在線上出了兩個相似的問題：開發人員在寫迴圈程式碼的時候沒有在迴圈體內使用到迴圈變數而發生了錯誤，比如如下程式碼：

1	List<Integer> list = getList();

2	for(int i = 0;i < 9 ;i++){

3	System.out.println(list.get(0));

4

}

其實我們在程式碼中是想寫list.get(i)的，為了發現諸如此類的問題，我們需要把它固化成靜態程式碼檢查的規則，然後在每次的持續整合中執行。
現在用得比較廣的Java靜態程式碼檢查工具有Findbugs和PMD，由於最近在研究抽象語法樹方面的東西，這次就採用PMD來實現。PMD有兩種實現，對於簡單的規則我們直接藉助已經寫好的Xpath規則就能很輕鬆地達到，對於複雜的規則我們就必須熟悉PMD的api和設計規則了，以下就兩種方式進行介紹。

二．用類Xpath寫規則
首先下載4.2.5版本的PMD，然後採用命令列的方式進入到bin目錄，並執行 designer命令，我們可以看到如下圖：

左上角你需要貼入的程式碼，左下角是生成的抽象語法樹，右上角是設計的xpath規則，右下角是符合xpath查詢條件的內容。對於以下一段程式碼：

1	public class a {

2	int hello;

3	int world;

4

5	private void run() {

6	int one = 1;

7	int two = 2;

8

}

9

}

生成的語法樹如下：

如果你需要找到所有的變數定義，那麼使用//VariableDeclaratorId就ok，如果要找到本地變數的定義，那麼使用//LocalVariableDeclaration，這裡的xpath以//開頭表示一個廣泛匹配，表示只要是某個節點就ok，//後面跟的變數是抽象語法樹中的節點。
如果要做這麼一條規則：找出所有if中存在空語句的程式碼，比如如下程式碼：

1	public class Foo {

2	void bar(int x) {

3	if (x == 0) {

4

// empty!

5

}

6

}

7

}

那麼我們的規則可以寫為//IfStatement/Statement[EmptyStatement or Block[count(*) = 0]]，表示找出if中的statement中的空宣告或者語句數量為0的程式碼。對於所有寫好的規則我們都必須使用多種原始碼進行反覆測試，然後在幾個真實專案中試用一下發現沒有問題才正式加入靜態程式碼檢查工具中。

三．呼叫API寫規則
對於一個複雜的規則，我們沒法用xpath來表達，那就必須呼叫PMD的API了。對於PMD和Findbugs這種檢查工具都是採用訪問者模式，示意圖如下：

這裡的ObjectStructure就是整個語法樹，Element就是語法樹中的各個節點物件，比如TypeDeclaration（型別宣告）節點、FieldDeclaration（欄位宣告）節點等等，Visitor觀察者即為我們的規則。當我們的規則寫好後，由PMD負責呼叫規則來觀察所有語法樹中的節點，如果發現觀察到的內容與規則不符就會將資訊記錄到PMD的Report裡。
對於我們概述中提到的需求，就是採用呼叫API的方式來實現，我們只需要繼承AbstractJavaRule（這個類就相當於Visitor介面的抽象類實現，裡面有些預設的行為）。
程式碼如下：

1	package net.sourceforge.pmd.rules;

2

3	import java.util.List;

4

5	import net.sourceforge.pmd.AbstractJavaRule;

6	import net.sourceforge.pmd.ast.ASTClassOrInterfaceType;

7	import net.sourceforge.pmd.ast.ASTForInit;

8	import net.sourceforge.pmd.ast.ASTForStatement;

9	import net.sourceforge.pmd.ast.ASTName;

10	import net.sourceforge.pmd.ast.ASTStatement;

11	import net.sourceforge.pmd.ast.ASTVariableDeclaratorId;

12

13	public class ForVariableNotUseRule extends AbstractJavaRule {

14

15	public Object visit(ASTForStatement node, Object data) {

16	if (!isUsed(node)) {

17	addViolation(data, node, "the varable in for statement is not used");

18

}

19	return data;

20

}

21

22	private boolean isUsed(ASTForStatement node) {

23	Boolean isUsed = false;

24	ASTForInit forInit = node.getFirstChildOfType(ASTForInit.class);

25	if (null == forInit) {

26	isUsed = true;

27

} else {

28	ASTClassOrInterfaceType variableType = forInit.getFirstChildOfType(ASTClassOrInterfaceType.class);

29	if(variableType != null && "Iterator".equals(variableType.getImage())){

30	return true;

31

}

32

33	ASTVariableDeclaratorId variableDeclaratorId = forInit

34	.getFirstChildOfType(ASTVariableDeclaratorId.class);

35	String variableName = variableDeclaratorId.getImage();

36

37	ASTStatement statement = node

38	.getFirstChildOfType(ASTStatement.class);

39	List<ASTName> names = statement.findChildrenOfType(ASTName.class);

40	for (ASTName name : names) {

41	if (variableName.equals(name.getImage())) {

42	isUsed = true;

43

}

44

}

45

}

46	return isUsed;

47

}

48

}

主要邏輯在isUsed（）方法裡面，我們首先找到for迴圈中初始化的語句，然後找到初始化變數的名稱。接著我們分析初始化裡面是不是使用迭代器方式使用，如果是我們認為不會出現之前提到的問題。最後再判斷初始化變數是否在後續的for迴圈程式碼中使用到。
PS:開發中我們如果不用到for中的變數我們應該使用迭代器或者foreach，這是一種更加優雅的方式。

四．加入到靜態程式碼檢查工具
規則寫好後，最後我們要做的工作是把它加入到靜態檢查工具中，我們修改pmd rule資料夾下的pmd.xml檔案，在裡面加上：

1	<rule name="ForVariableNotUseRule" since="4.2.5" message="the variable in the for statement but it never used" class="net.sourceforge.pmd.rules.ForVariableNotUseRule" externalInfoUrl="http://pmd.sourceforge.net/rules/basic-jsf.html#DontNestJsfInJstlIteration">

2	<description>The rule check the variable defined in the "for cycle" and never used in the next code. It is a bad code and lead to a bug, even so you should use foreach. </description>

3	<priority>2</priority>

4

<example>

5

<![CDATA[

6	List<Integer> list = new ArrayList<Integer>();

7	for(int i = 0;i < 9 ;i++){

8	System.out.println(list.get(0));

9

}

10

]]>

11	</example>

12

</rule>

五．總結
以上就是對如何增加靜態程式碼檢查規則進行一個簡單的介紹，其實大部分需求PMD或者Findbugs都幫我們做好了，如果確實需要新增一個規則的時候我們需要確認是不是已經在已有規則裡面了，而不必重複造輪子。另外分析Java抽象語法樹其實還可以完成非常多的功能，比如Java原始碼比對、原始碼生成工具等，Eclipse裡面多處用到了這些技術。