eclipse插件之Findbugs、Checkstyle、PMD安裝及使用
一、什么是Findbugs、checkstyle、PMD
Findbugs、checkstyle和PMD都可以作為插件插入eclipse,當然也有單獨的工具可以實現他們的功能,比如Findbugs Tool就可以不必插入eclipse就可以使用。
三者的功能如下表:
工具 |
目的 |
檢查項 |
FindBugs 檢查.class |
基於Bug Patterns概念,查找javabytecode(.class文件)中的潛在bug |
主要檢查bytecode中的bug patterns,如NullPoint空指針檢查、沒有合理關閉資源、字符串相同判斷錯(==,而不是equals)等 |
PMD 檢查源文件 |
檢查Java源文件中的潛在問題 |
主要包括: 空try/catch/finally/switch語句塊 未使用的局部變量、參數和private方法 空if/while語句 過於復雜的表達式,如不必要的if語句等 復雜類 |
CheckStyle 檢查源文件 主要關注格式 |
檢查Java源文件是否與代碼規范相符 |
主要包括: Javadoc注釋 命名規范 多余沒用的Imports Size度量,如過長的方法 缺少必要的空格Whitespace 重復代碼 |
該表轉自:http://blog.csdn.net/ml5271169588/article/details/6975701
三者作為開源的軟件,可以讓我們無所畏懼的使用,而不用考慮版權問題。他們的源代碼保存在http://sourceforge.net/上,下載也可以去這里下載。
二、Findbugs、checkstyle、PMD的安裝
首先要說明的是,我電腦的eclipse是luna版本,JDK是1.8的。
eclipse和JDK的安裝就不多說了,很容易搜到,而且目前JDK都不需要復雜的配置,基本上只要下載好再安裝就好了。
那么接下詳細的介紹Findbugs、checkstyle、PMD的安裝(使用三部分說明:如何安裝eclipse插件->下載插件->安裝插件->查看插件是否安裝成功)
1、如何安裝eclipse插件
目前來說有三種安裝eclipse插件的方式:
(1)在線安裝方式:使用Eclipse的菜單欄 Help -> SoftwareUpdates -> Find and install... -> search for new features... ->輸入軟件安裝地址進行安裝
(2)離線安裝方式一:下載插件文件,將其解壓縮到Eclipse對應的目錄中,即eclipse目錄下對應的features下和plugins下。
(3)離線安裝方式二:links文件方式。
前兩種方式比較簡單,百度經驗http://jingyan.baidu.com/article/15622f2454893cfdfcbea5d1.html上有詳細的圖文教程。
我選擇了第三種方式,因為這樣可以把eclipse插件放在一個獨立的目錄統一管理,多個Eclipse均可以指向這個eclipse插件目錄,后面我會具體介紹如何采用第三鍾方式安裝插件。
2、下載插件
因為Findbugs、checkstyle、PMD都在http://sourceforge.net/這個開源的網站上進行管理,所以直接去該網站下載。
工具 | 下載地址 | 截圖 | 注意事項 |
Findbugs | http://sourceforge.net/projects/findbugs/files/findbugs%20eclipse%20plugin/ | ![]() |
下載的時候要注意紅框里一定是findbugs eclipse plugin,有可能你在這個網站上下載到Findbugs,但他不能用做eclipse插件使用。可能有其他用途吧。 |
Checkstyle | http://sourceforge.net/projects/eclipse-cs/files/?source=navbar | ![]() |
你可能在sourceforge上找到checkstyle,但下載下來同樣不能用做eclpse插件使用,注意要下載eclipse checkstyle plug-in。 |
PMD | http://sourceforge.net/projects/pmd/files/pmd-eclipse/update-site-latest/ | ![]() |
我沒有找到可以一下plugins和features的文件都下載下來,只能一個一個的下載,然后重新創建了features和plugins文件夾,然后把東西放里面。也許有更好的方法吧。同樣注意下載的是pmd-eclipse目錄下的文件 |
下載好后就可以采用上述的安裝方式的一種安裝了。
3、安裝插件
links方法安裝:
我的eclipse的安裝目錄是D:\Application\eclipse。
目標是把插件放在和eclipse文件夾同級的D:\Application\eclipse_plugins下(文件夾名隨意)。
(1)首先在D:\Application\eclipse_plugins文件夾操作。
在eclipse_plugins文件夾下創建D:\Application\eclipse_plugins\lunaeclipse(文件夾名隨意),表示這是lunaeclipse所使用的插件。
分別在D:\Application\eclipse_plugins\lunaeclipse下創建Findbugs、Checkstyle和PMD三個文件夾(文件夾名隨意)。如圖:
然后在Findbugs里面建立一個eclispe文件夾(文件名固定),eclipse文件夾下創建features(文件名固定)和plugins(文件名固定)文件夾。
Checkstyle和PMD進行同樣的操作。
然后將下載好的文件(里面包含plugins和features),按照同樣的結構放入對應文件夾里。例如:
![]() |
![]() |
Checkstyle和PMD進行同樣的操作。
(2)接下來操作eclipse的安裝目錄D:\Application\eclipse。
在該目錄下新建文件夾links(文件夾名固定),然后創建Findbugs.txt、Checkstyle.txt、PMD.txt(文件名隨意)文件,打開該文件並且寫入一句path=D:\\Application\\eclipse_plugins\\lunaeclipse\\Findbugs,該路徑是之前創建Findbugs文件夾的路徑,同樣操作Checkstyle和PMD。在將擴展名.txt改為.link(據說擴展名改不改無所謂)。如圖:
![]() |
![]() |
然后重啟eclipse就可以了。
注意:如果重啟eclipse不可以的話。請嘗試進入eclipse安裝目錄下的D:\Application\eclipse\configuration文件夾,刪除org.eclipse.update文件夾,修改config中的org.eclipse.update.reconcile=false改為true。在重新啟動eclipse。
4、查看插件
可以通過兩種方式查看插件是否安裝成功
(1)依次點擊help—>about eclipse->Installation details->Plug-ins,然后搜索自己安裝的插件,如果能夠搜索到,則說明安裝成功。
(2)更實際一點的方式是創建一個項目,右擊項目名,查看是否存在Findbugs、Checkstyle和PMD。
我采用第二種方式:
出現紅框里的標志之后,就說明安裝插件成功。
三、Findbugs、checkstyle、PMD的使用
打開三個插件的方式大同小異,都是右擊項目,找到插件的選項。當分析完畢之后,同樣需要右擊項目,找到插件選項,點擊clear...選項,清除插件標記。
對Findbugs的設置在Windows->Preferences->java->Find bugs下進行設置;在Windows->Preferences下就能找到Checkstyle和PMD的設置。
關於Finbugs、checkstyle、PMD的使用如下表:
Findbugs | Checkstyle | PMD | |
啟動/清除
|
![]() |
![]() |
![]() |
使用 | 如圖所示:代碼行左側出現小蟲子,說明有bug或 潛藏的bug。BugExplorer會列出所有bug,Bug info有關於bug詳細的信息。(注意:Findbugs檢 查的是.class文件,所以如果無法編譯成.class的程 序是無法使用findbugs找到bug的) |
黃色部分為代碼不符合規范的部分。 |
如圖小三角標記的代碼行,存在不符合規范的代碼。 |
設置 | ![]() |
![]() |
![]() |
關於Findbugs、Checkstyle和PMD的安裝和使用先就介紹到這里。三個插件的使用能夠幫助程序開發者更好的理解自己的代碼,改善自己的代碼風格,對程序員有很大益處。
注:由於圖比較小,如若看不清,可以放大瀏覽器查看或者下載下圖片看。
2015-05-21
------------------------------
只要你是簡單的
這個世界就是簡單的
----冰心