java規範之checkstyle

1. 概述

隨着中心的代碼規範的創建和實施，項目組對代碼規範要求，以及軟件工程師們對自身代碼的編寫規範重要性的認知，「代碼規範」已經成爲了中心的一個「熱詞」。而後怎麼才能寫出有規範的代碼，怎麼才能養成編碼規範習慣？相信不少人都知道Checkstyle這個編碼規範工具，本文講述了Checkstyle在eclipse中的安裝過程，以及使用方法。但願經過本文，讓你們能簡單快速的掌握Checkstyle。

2. 認識Checkstyle

CheckStyle是SourceForge下的一個項目，提供了一個幫助Java開發人員遵照某些編碼規範的工具。它可以自動化代碼規範檢查過程，從而使得開發人員從這項重要但枯燥的任務中解脫出來。它能夠根據設置好的編碼規則來檢查代碼。好比符合規範的變量命名，方法體的最大行數，重複代碼檢查等等。

若是你的項目經理開會時說：「我但願咱們寫出來的代碼就象一我的寫的!」，那麼用Checkstyle絕對是正確選擇！

3. 資源說明

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

 

本篇是在eclipse4.4.2上面安裝最新版的checkstyle插件爲例。

Eclipse的位置在D:\java\eclipse，checkstyle下載後在D:\java\plugin\checkstyle\net.sf.eclipsecs-updatesite_5.7.0.201402131929-bin.zip，其中

使用的checkstyle規則文件在D:\java\plugin\checkstyle\style_template.xml

資源下載地址：

http://download.csdn.net/detail/ccboy2009/7521353

4. Checkstyle插件安裝

下面講解checkstyle在eclipse上的兩種安裝方式。

 離線安裝

①　下載checkstyle離線安裝包；

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

 

 

②　下載完成後將壓縮包中features文件夾和plugins文件夾的複製到eclipse中的根目錄中進行覆蓋；

 

③　打開eclipse，Window-->Preferences,若是列表中出現了checkstyle的菜單，則表示安裝成功了。

 

 

注意：若是啓動eclipse時，提示ClassNotFoundException等異常信息，則啓動時加上一個「-clean」參數啓動便可。

 

Ø 在線安裝

注意在安裝過程當中保持網絡暢通，若是網絡不穩定可能會致使安裝失敗。

Help --> Install New Software

CheckStyle插件地址：http://eclipse-cs.sourceforge.net/update

 

Next-->next-->選擇 I accept... Finish。Checkstyle插件就開始安裝。

在安裝過程當中，可能會出現警告提示，選擇ok便可。

 

安裝完成後，根據提示重啓eclipse，checkstyle即安裝完成。

5. Checkstyle全局配置

Window -->Preferences,選擇checkstyle菜單，增長項目組統一的規則文件，並設置爲默認規則。以下圖：

 

 

到此全局配置已經完成。

6. Checkstyle項目配置

項目 --> 右鍵Properties

 

到此項目配置已經完成。成功的話，checkstyle已經開始工做了。

 

這次發現項目上有不少紅叉叉，說明是代碼符合規範形成的。

 

根據提示信息修改後，則沒有有紅色的提示。

 

 

7. 其它操做

在項目右鍵菜單中，checkstyle還有一些快捷操做，以下圖所示：

 

8. 結語

經過本文的閱讀和學習，相信你對Checkstyle這個編碼規範工具備了必定的認識和熟悉。但要想規範本身的代碼編寫規則，項目組要統一組內代碼規範，只依靠這個工具是不行的，須要你們堅持使用這個工具，逐漸的就會造成一種習慣，最終拋棄Checkstyle照樣能寫出規範的代碼。