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

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

EsbResultModel

validRule(HashMap

orderInfo,ArrayList

orderItems,StringRole);Stringrole要小寫(xiě)類(lèi)、public方法和常量javadoc的缺失

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

我們代碼中常見(jiàn)幾類(lèi)問(wèn)題錯(cuò)誤的使用/***/和/**/

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

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

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

我們代碼中常見(jiàn)幾類(lèi)問(wèn)題有些代碼的寫(xiě)法不容易理解不一致的代碼風(fēng)格

例如，Stringoneitems[]vsString[]oneitems

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

NO

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

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

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

；

FindBugs

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

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

JAR

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

1.

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

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

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

(壞的實(shí)踐)HE：

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

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

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

（一般的正確性問(wèn)題）NP：

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

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

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