在eclipse上Checkstyle的安裝和使用

1. 概述

隨著中心的代碼規範的建立和實施，項目組對代碼規範要求，以及軟體工程師們對自身代碼的編寫規範重要性的認知，“代碼規範”已經成為了中心的一個“熱詞”。然後怎麼才能寫出有規範的代碼，怎麼才能養成編碼規範習慣。相信很多人都知道Checkstyle這個編碼規範工具，本文講述了Checkstyle在eclipse中的安裝過程，以及使用方法。希望通過本文，讓大家能簡單快速的掌握Checkstyle。 2. 認識Checkstyle

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

如果你的專案經理開會時說：“我希望我們寫出來的代碼就象一個人寫的!”，那麼用Checkstyle絕對是正確選擇。 3. 資源說明

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

本篇是在eclipse4.2上面安裝最新版的checkstyle外掛程式為例。Eclipse的位置在D:\Program Files\eclipse，checkstyle下載後在D:\Sdk\checkstyle\net.sf.eclipsecs-updatesite_5.7.0.201402131929-bin.zip，其中使用的checkstyle規則檔案在D:\Sdk\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照樣能寫出規範的代碼。