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中各種常用的檢查項。在第五部分中,我會介紹如何依據檢查的需求來定制檢查文件。