代碼規範工具-Checkstyle使用手冊

      前段時間中心需要對外包的項目進行代碼質量管理,所以在此對前段時間的工作做下總結。

      現在很多開源工具都可以對代碼進行規範審覈,比較流行的有以下幾款,大致給個簡單介紹。

     PMD:是一款採用BSD協議發佈的Java程序代碼檢查工具,可以做到檢查Java代碼中是否含有未使用的變量、是否含有空的抓取塊、是否含有不必要的對象等。
     FindBugs:是一個靜態分析工具,它檢查類或者 JAR 文件,將字節碼與一組缺陷模式進行對比以發現可能的問題。
     Checkstyle:是一個靜態分析工具,檢查Java程序代碼。
     Cppcheck是一種C/C++代碼缺陷靜態檢查工具。
   PC-Lint也是一種靜態代碼檢測工具,檢查C或C++。

      目前,中心使用的是Checkstyle工具。我個人覺得PMD和Checkstyle很類似,都可以以插件的形式集成到Eclipse或是MyEclipse開發環境中。下面就Checkstyle在Eclipse中的使用詳細介紹下,同時,也歡迎大家繼續補充。

1        Checkstyle的下載和安裝

1.1  Checkstyle的下載

      Checkstyle可以從其官網http://checkstyle.sourceforge.net/中下載。官網中還提供了Checkstyle的相關文檔,如配置文件、代碼檢查項等,內容比較豐富,覆蓋面也較齊全。可依據自身需要,參考官網上的相關資料。進入Checkstyle的官網後,進入Download頁面,可以下載Checkstyle。目前,大多數開發項目使用Eclipse或是MyEclipse的集成開發環境,因此我推薦進入http://en.sourceforge.jp/projects/sfnet_eclipse-cs/releases/下載,該網站上有EclipseCheckstyle Plug-in的各種版本。下文的介紹中,我採用的是net.sf.eclipsecs-updatesite_5.5.0.201111092104-bin.zip版本的Checkstyle插件。

1.2  Checkstyle的安裝

    以下的安裝過程,基於Eclipse SDK-3.7.2。

   (1)打開eclipse,在help中選擇install software。

(2)點擊add, 選擇中Checkstyle安裝包net.sf.eclipsecs-updatesite_5.5.0.201111092104-bin.zip;

   

(3)點擊OK,進入下一步;

(4)重啓Eclipse。

        確認安裝成功的步驟:

     打開eclipse,選擇window->preferences->左邊導航欄中Checkstyle,如果出現checkstyle說明你安裝成功。


2  Checkstyle的配置

     Checkstyle默認提供的配置文件有兩個:一是Sun Checks,對應的配置文件是sun_checks.xml文件,含義是Checkstyle configuration that checks the sun coding conventions;一般Checkstyle默認的設置就是sun_checks.xml配置文件。另一個是Sun Checks(Eclipse),對應的配置文件是sun_checks_eclipse.xml,含義是Slightly modified version of Sun Checks that better matches the default code formatter setting of Eclipse.

     一般Sun Checks的檢查項限定得較爲嚴格,我們實際項目中並不要求那麼完美的編程規範,那麼可以自己定義檢查的配置文件,最後將Checkstyle的配置文件設定爲我們自定義的文件即可。關於檢查項的設定,我會是下面章節中講解。先來看看Checkstyle如何快速使用吧。

3  Checkstyle的快速入門使用

   Checkstyle安裝好之後,就可以使用它來檢查我們的代碼啦。

3.1 使用Checkstyle檢查單個java文件

   選中文件,右擊選擇Checkstyle,選擇Check Code with Checkstyle。



        此時,看看原文件的變化吧。原文件上會在不符合規範的地方出現黃顏色!號,鼠標停留在歎號處,可以看到信息提示。或者,在Console控制檯一欄,可以看到Checkstyle violations 的視圖,裏面會有信息提示。



     選擇Checksty violations chart視圖,會把每種不規範的信息做下統計,繪製成圖表,夠人性化吧,哈哈哈。



3.2 使用Checkstyle檢查整個項目

    在項目名上,右擊選擇Checkstyle,選擇Check Code with Checkstyle。


   查看不規範的信息,方法同3.1節一樣。


  Checkstyle 也可以檢查整個包的文件,或者某一代碼段的文件。具體的,大家可以依據需要,我不再一一介紹。

4、Checkstyle的各種檢查項

      前面說到用戶可以自定義各種檢查項,下面給大家介紹下Checkstyle中各種常用的檢查項。在第五部分中,我會介紹如何依據檢查的需求來定製檢查文件。

      因篇幅侷限,爲了讓大家不至於看得太累,也爲講得更透徹,我把Checkstyle的檢查項配置內容單獨寫爲一篇博客。有興趣的讀者可瀏覽《Checkstyle的檢查項配置詳解
》一文。

     歡迎大家參與討論,以期待繼續改進。





    



發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章