常用JAVA代碼質(zhì)量靜態(tài)檢查工具

常用JAVA代碼質(zhì)量靜態(tài)檢查工具目錄軟件開發(fā)經(jīng)歷反省我們代碼中常見幾類問題QualityMetricsToolsCheckStylePMDFindBugs我們代碼中常見幾類問題使用了不規(guī)范的變量和方法名

EsbResultModel

validRule(HashMap

orderInfo,ArrayList

orderItems,StringRole);Stringrole要小寫類、public方法和常量javadoc的缺失

javadoc中的聲明跟實際的方法不一致，例如方法實際只有1個參數(shù)，而javadoc里@param定義了多個（估計是方法簽名的時候沒有同步的修改javadoc）

我們代碼中常見幾類問題錯誤的使用/***/和/**/

很多public方法和常量使用了/**/來注釋，導(dǎo)致注釋內(nèi)容不能被寫入javadoc。而另一方面是錯誤使用/***/導(dǎo)致錯誤的內(nèi)容被寫入javadoc存在未被使用的方法和變量

這些不被使用方法和變量名會增加日后bug修改、代碼維護(hù)的成本\方法超長 一個方法超過150行，是不是太長太復(fù)雜了。我們代碼中常見幾類問題代碼中有不少magic-number和magic-string

劉謙的魔術(shù)不好看，所以如果你維護(hù)的代碼跟劉謙的一樣，估計你也會抓狂的！Strings=“0000”+Integer.toString(ch,16);0000是什么，16是啥東東，就算是作者3個禮拜也不記得當(dāng)初寫這段代碼的用意了。Import了一些不需要的類 提交代碼以前請務(wù)必OrganizeImports。

我們代碼中常見幾類問題有些代碼的寫法不容易理解不一致的代碼風(fēng)格

例如，Stringoneitems[]vsString[]oneitems

前者是C/C++的編碼風(fēng)格；咱們寫的是java，就統(tǒng)一用String[]oneitems吧。

NO

EXCUTABLEWhyusingQualityMetricsTools一個軟件的生命周期中，80%的花費在于維護(hù)幾乎沒有任何一個軟件，在其整個生命周期中，均由最初的開發(fā)人員來維護(hù)編碼規(guī)范可以改善軟件的可讀性，可以讓程序員盡快而徹底地理解新的代碼……CheckStyleCheckStyle用來檢查代碼格式、規(guī)范、風(fēng)格檢查并強(qiáng)制執(zhí)行統(tǒng)一的代碼風(fēng)格檢查Javadoc檢查類、變量、方法的命名檢查類和方法的大小檢查編碼錯誤，例如magicnumber……Checkstyle-安裝Eclipse插件地址

http://eclipse-/updateCheckstyle-啟用Checkstyle—配置規(guī)范Checkstyle使用效果黃色的區(qū)域就是checkstyle檢查出有問題的地方（紅色表示錯誤，黃色表示警告）。Checkstyle-注意事項修改EclipseJavaCodeStyleFormatter配置，由于Eclipse默認(rèn)設(shè)置換行后的縮進(jìn)符號為tab，而Java規(guī)范不允許代碼中有tab，因為tab在不同的操作系統(tǒng)下的長度占位不同，有的是4個空格，有的是8個空格，因此我們要修改這個配置為空格。

Checkstyle-注意事項PMDPMD提供了一些開發(fā)過程中的最佳實踐。Possiblebugs-emptytry/catch/finally/switchstatementsDeadcode-unusedlocalvariables,parametersandprivatemethodsSuboptimalcode-wastefulString/StringBufferusageOvercomplicatedexpressions-unnecessaryifstatements,forloopsthatcouldbewhileloopsDuplicatecode-copied/pastedcodemeanscopied/pastedbugsPMD-Exception規(guī)則AvoidCatchingThrowableSignatureDeclareThrowsExceptionExceptionAsFlowControlAvoidThrowingRawExceptionTypesAvoidThrowingNullPointerExceptionAvoidRethrowingExceptionDoNotExtendJavaLangErrorDoNotThrowExceptionInFinallyAvoidThrowingNewInstanceOfSameExceptionhttp:///rules/strictexception.htmlPMDPMD中的很多規(guī)則會比較有爭議，或者跟大家現(xiàn)有的技術(shù)框架、代碼結(jié)構(gòu)有沖突。大家可以通過自定義的這些規(guī)則的級別（Error，Warning）來把握對這些規(guī)則的使用程度。FindBugsFindBugs是一個專門分析JAVA代碼問題的靜態(tài)代碼掃描工具，它是由一位馬里蘭大學(xué)的博士寫的；FindBugs可以發(fā)現(xiàn)的問題包括：多線程競爭問題，性能問題，安全問題，代碼規(guī)范......官方網(wǎng)站是：http:///index.html

；

FindBugs

當(dāng)前版本為：1.3.9;FindBugs能做什么Findbugs

是一個靜態(tài)分析工具，它檢查類或者

JAR

文件，將字節(jié)碼與一組缺陷模式進(jìn)行對比以發(fā)現(xiàn)可能的問題。利用這個工具，就可以在不實際運行程序的情況對軟件進(jìn)行分析。它可以幫助改進(jìn)代碼的質(zhì)量。Findbugs提供了方便操作的可視化界面，同時也可以作為Eclipse的一個插件來使用，而我們使用得最多的還是作為Eclipse的插件來使用。FindBugs的使用方法Ant/Maven工具；通過Ant提供的Swing操作界面；作為Eclipse的一個插件來使用。FindBugs的Eclipse插件Eclipse的Findbugs插件，可以將Findbugs集成到Eclipse中使用。Findbugs的Eclipse插件安裝方法

1.

在線安裝安裝地址：http:///eclipse2.

離線安裝下載Findbugs插件，將它放入Eclipse下的plusin文件夾，然后重啟EclipseFindbugs的Eclipse插件使用安裝了Findbugs插件后。右擊點擊你要檢查的項目選擇【FindBugs】->【FindBugs】進(jìn)行檢查。要查看Findbugs檢查出了哪些Bug，可以選擇Windows菜單->ShowView->BugExplorer，打開BugExplorer面板。

如果想要查看某個Bug詳細(xì)的信息，則可以選擇Windows菜單->OpenPerspective，然后選擇FindBugs就可以打開FindBugs的Properties面板，在這個面板里面可以看到最詳盡的Bugs信息。FindBugs的規(guī)則檢測器（1）Badpractice

(壞的實踐)HE：

類定義了equals()，卻沒有hashCode()；或類定義了equals()，卻使用Object.hashCode()；或類定義了hashCode()，卻沒有equals()；或類定義了hashCode()，卻使用Object.equals()；類繼承了equals()，卻使用Object.hashCode()。SQL：Statement

的execute方法調(diào)用了非常量的字符串；或PreparedStatement是由一個非常量的字符串產(chǎn)生。DE：

方法終止或不處理異常，一般情況下，異常應(yīng)該被處理或報告，或被方法拋出。FindBugs的規(guī)則檢測器（2）Correctness

（一般的正確性問題）NP：

空指針被引用；在方法的異常路徑里，空指針被引用；方法沒有檢查參數(shù)是否null；null值產(chǎn)生并被引用；null值產(chǎn)生并在方法的異常路徑被引用；傳給方法一個聲明為@NonNull的null參數(shù)；方法的返回值聲明為@NonNull實際是null。Nm：

類定義了hashcode()方法，但實際上并未覆蓋父類Object的hashCode()；類定義了tostring()方法，但實際上并未覆蓋父類Object的toString()；很明顯的方法和構(gòu)造器混淆；方法名容易混淆。SQL：方法嘗試訪問一個PreparedStatement的0索引；方法嘗試訪問一個ResultSet的0索引。UwF：所有的write都把屬性置成null，這樣所有的讀取都是null，這樣這個屬性是否有必要存在；或?qū)傩詮臎]有被write。FindBugs的規(guī)則檢測器（3）Multithreadedcorrectness

（多線程的正確性）多線程編程時，可能導(dǎo)致錯誤的代碼，下面列舉幾個：ESync：空的同步塊，很難被正確使用。MWN：錯誤使用notify()，可能導(dǎo)致IllegalMonitorState