提升Java代碼質量的Eclipse插件之Checkstyle的使用詳解

CheckStyle是SourceForge下的一個項目，提供了一個幫助JAVA開發人員遵照某些編碼規範的工具。它可以自動化代碼規範檢查過程，從而使得開發人員從這項重要可是枯燥的任務中解脫出來。

CheckStyle檢驗的主要內容 
·Javadoc註釋 
·命名約定 
·標題 
·Import語句 
·體積大小 
·空白 
·修飾符 
·塊 
·代碼問題 
·類設計 
·混合檢查（包活一些有用的好比非必須的System.out和printstackTrace）

從上面能夠看出，CheckStyle提供了大部分功能都是對於代碼規範的檢查，而沒有提供象PMD和Jalopy那麼多的加強代碼質量和修改代碼的功能。可是，對於團隊開發，尤爲是強調代碼規範的公司來講，它的功能已經足夠強大。

Checkstyle插件能夠集成到Eclipse IDE中去，能確保Java代碼遵循標準代碼樣式。

1、CheckStyle 安裝方法

方法一：

 

1.Eclipse中，選擇Help->Software Updates->Find and Install

 

2.選擇 Search for new features to install 選擇Next

 

3.選擇 New Remote Site

 

4.輸入更新地址：http://eclipse-cs.sourceforge.net/update

 

5. 安裝後重啓便可

 

方法二：

 

1.下載eclipse插件

 

http://sourceforge.net/projects/eclipse-cs/

 

下載後，把裏面的兩個文件夾plugins和 features下面的文件分別拷貝到eclipse目錄下面對應的plugins和features目錄

 

2.若是你就這樣直接啓動eclipse可能會出現ClassNotFoundExceptions 等錯誤（通常不會出現此類錯誤），因此必須在啓動eclipse的時候加上一個參數 -clean. 這樣eclipse就能夠更新它當前安裝的許多插件信息

好比你得eclipse在d盤，那麼就是 d:\eclipse\eclipse.exe -clean 

 

2、CheckStyle 使用

 

安裝成功後，選中工程，右鍵選擇checkstyle->check code with checkstyle,檢查錯誤便可

 

 

3、Checkstyle的結果輸出

 

檢查後會發現代碼中出現不少放大鏡圖標，以下圖所示，這就是Checkstyle的輸出，具體含義以下：

 

 

1 Type is missing a javadoc commentClass  
缺乏類型說明

2 「{」 should be on the previous line    
「{」 應該位於前一行。解決方法：把「{」放到上一行去

3 Methos is missing a javadoc comment 
方法前面缺乏javadoc註釋。解決方法：添加javadoc註釋，相似這樣：

/**

* set default mock parameter.（方法說明）

* @param additionalParameters parameter additional(參數名稱)

* @return data manager(返回值說明)

* @throws Exception if has error(異常說明)

*/

4 Expected @throws tag for 「Exception」
在註釋中但願有@throws的說明
解決方法：在方法前得註釋中添加這樣一行：* @throws Exception if has error(異常說明)

5 「.」 Is preceeded with whitespace 「.」 
前面不能有空格。解決方法：把「.」前面的空格去掉

6 「.」 Is followed by whitespace「.」 
後面不能有空格。解決方法：把「.」後面的空格去掉

7 「=」 is not preceeded with whitespace
「=」 前面缺乏空格。解決方法：在「=」前面加個空格

8「=」 is not followed with whitespace「=」 
後面缺乏空格。解決方法：在「=」後面加個空格

9「}」 should be on the same line「}」 
應該與下條語句位於同一行。解決方法：把「}」放到下一行的前面

10 Unused @param tag for 「unused」
沒有參數「unused」，不需註釋
解決方法：「* @param unused parameter additional(參數名稱)」 把這行unused參數的註釋去掉「

11 Variable 「CA」 missing javadoc
變量「CA」缺乏javadoc註釋
解決方法：在「CA「變量前添加javadoc註釋：/** CA. */（注意：必定記得加上「.」）

12 Line longer than 80characters
行長度超過80  。解決方法：把它分紅多行寫。必要時候，能夠ctrl+shift+f

13 Line contains a tab character
行含有」tab」 字符。

14 Redundant 「Public」 modifier
冗餘的「public」 修飾符 。解決方法：去掉「public」修飾符

15 Final modifier out of order with the JSL suggestion
Final modifier的順序錯誤

16 Avoid using the 「.*」 form of import
import格式避免使用「.*」。解決方法：能夠先不添加import，再須要用到時直接「ctrl + o」導入便可。

17 Redundant import from the same package
從同一個包中Import內容，多餘，刪掉便可

18 Unused import-java.util.list
Import進來的java.util.list沒有被使用。解決方法：去掉導入的多餘的類

19 Duplicate import to line 13
重複Import同一個內容。解決方法：去掉導入的多餘的類

20 Import from illegal package
從非法包中 Import內容

21 「while」 construct must use 「{}」 
「while」 語句缺乏「{}」

22 Variable 「sTest1」 must be private and have accessor method
變量「sTest1」應該是private的，而且有調用它的方法

23 Variable 「ABC」 must match pattern 「^[a-z][a-zA-Z0-9]*$」
變量「ABC」不符合命名規則「^[a-z][a-zA-Z0-9]*$」，解決方法：把這個命名改爲符合規則的命名 「aBC」

24 「(」 is followed by whitespace
「(」 後面不能有空格 25「)」is proceeded by whitespace「)」 前面不能有空格。解決方法：把前面或者後面的空格去掉

25 First sentence should end with a period
解決方法：你的註釋的第一行文字結束應該加上一個"."。

26 Redundant throws: 'NameNotFoundException' is subclass of 'NamingException'. 
'NameNotFoundException '是'NamingException'的子類重複拋出異常。
解決方法：若是拋出兩個異常，一個異常類是另外一個的子類，那麼只須要寫父類
去掉NameNotFoundException異常，對應的javadoc註釋異常註釋說明也須要去掉

27 Parameter docType should be final. 
參數docType應該爲final類型， 解決方法：在參數docType前面加個final

28 Line has trailing spaces. 
多餘的空行 ，解決方法：去掉這行空行

29 Must have at least one statement.  
至少一個聲明

解決方法：} catch (NumberFormatException nfe) {

LOG.error("Auto Renews the agreement failed", nfe);//異常捕捉裏面不能爲空，在異常裏面加一句話。如打印等等

30 '>' is not followed by whitespace.而且又有 '(' is preceded with whitespace.
定義集合和枚舉的時候的時候，最後一個「>」後面要有空格，「（」前面不允許有空格。解決方法：去掉泛型

31 Got an exception - java.lang.RuntimeException: Unable to get class information for @throws tag 'SystemException'.
緣由：不合理的throws。

解決方法：要確保某些類型，如某些類、接口不被throws。把聲明的異常去掉。在實現類中拋出異常

網上參考解決方法：

一、這是CheckStyle報的錯。一般須要Refreh, clean/build這個Project. 若是不行，能夠嘗試clean all projects, restart Eclipse.

二、由於編譯好的類沒有在checkstyle的classpath中.因此, 只要將編譯好的class配置到在<checkstyle/>的classpath中就沒有這個問題了.另外, 還發現checkstyle的line length好像也有點問題, 明明沒有超過120個字符, 卻仍是報錯.無奈, 我把Eclipse中java > code style > formatter中的Maximum line with改爲了100, 而後format一下, 基本就沒有問題了

32 File does not end with a newline.
解決方法：刪掉報錯的類，新建一個同名的類，把代碼所有複製過去

33 Utility classes should not have a public or default constructor. 
接口中的內部類中不該該有公共的或者默認的構造方法

解決方法：在內部類中，定義一個私有的構造方法，而後內部類聲明爲final類型。若是前面有static，那麼final還必須放在static以後

34 Variable 'functionCode' must be private and have accessor methods.
變量要改爲private而後提供訪問的方法

解決方法：給這些變量的修飾符改爲private，而後提供set，get方法，並加上對應的方法javadoc註釋、參數註釋。並在返回值和參數類型前添加final。並把調用了這個變量的地方改爲經過方法訪問

35   'X' hides a field.

public class Foo
{
    private int bar;

    public Foo(int bar)
    {
        this.bar = bar;
    }

    public final int getBar()
    {
        return bar;
    }
}

全局private int bar;和局部public Foo(int bar)的bar變量名字重複。
解決方法：把方法裏面的參數名稱改變下就能夠了public Foo(int newBar)
    {
        this.bar = newBar;
    }。

36 Got an exception - Unexpected character 0xfffd in identifier

這是由於CheckStyle不能識別制定的編碼格式。

網上參考解決方法：

一、Eclipse中能夠配置，在Other-->checker中能夠指定

二、能夠修改checkstyle配置文件：

<module name="Checker">

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

<property name="charset" value="UTF-8"/>

<module name="TreeWalker">

若是是UTF-8的話，就添加加粗斜體的那條語句，就能夠了。

37  Got an exception - java.lang.RuntimeException: Unable to get class information for @throws tag *whatever*.
網上參考解決方法：選中CheckSytle的JavaDoc --> Method JavaDoc --> logLoadErrors。若是是CheckStyle本身加載時出錯的，打個Log就能夠了，不要整出Errors嚇人。
還有一處也可能包出一樣的錯誤。Coding Problems --> Redundant Throws --> logLoadErrors選中便可

38 Expected @param tag for 'dataManager'. 
缺乏dataManager參數的註釋   解決方法：在註釋中添加@param dataManager DataManager

39 Parameter X should be final.
public class Foo
{
    private int bar;

    public Foo(int bar)
    {
        this.bar = bar;
    }

    public final int getBar()
    {
        return bar;
    }
}

解釋：public Foo(int bar)的局部變量，被認爲是不可改變的，檢查須要加上final關鍵字定義public Foo(final int bar)此錯誤，能夠忽略不檢查。

40 Redundant 'X' modifier.

public interface CacheHRTreeService extends Manager {

/**
  * Organization Tree
  * @param orgDto
  * @return
  * @throws Exception
  */
public void setOrganization(OrganizationDTO orgDto) throws Exception;

/**
  * Organization Tree
  * @return
  * @throws Exception
  */
public OrganizationDTO getOrganization() throws Exception;
......
}

解釋：多餘的字段。public OrganizationDTO getOrganization() throws Exception;此時public爲多餘的字段，由於interface定義的時候，就是public的。

須要檢查。

41 Class X should be declared as final.

解釋：對於單例設計模式，要求返回惟一的類對象。可是HRFactory和ContextFactory爲優化的兩個類，不需求檢查。
其餘的單例類，依然須要進行檢查。

42 Method 'addChildrenId' is not designed for extension - needs to be abstract, final or empty.

解釋：經過父類繼承的，此類有點特殊能夠忽略此類。

43 Variable 'id' must be private and have accessor methods.

解釋：BaseHRDTO類，爲父類，屬性給子類繼承，比較特殊。可是其餘的類，聲名須要加上範圍'private'關鍵字。須要檢查。

44 Array brackets at illegal position.

解釋：代碼寫法，習慣不同。須要檢查，僅僅提示