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

常用JAVA代碼質(zhì)量靜態(tài)檢查工具開發(fā)一部-胡偉軍2009年6月1a目錄軟件開發(fā)經(jīng)歷反省我們代碼中常見幾類問題QualityMetricsToolsCheckStylePMDFindBugsJSLink2a我們代碼中常見幾類問題使用了不規(guī)范的變量和方法名

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

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

3a我們代碼中常見幾類問題錯(cuò)誤的使用/***/和/**/

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

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

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

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

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

6aNO

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

10aCheckstyle-啟用11aCheckstyle—配置規(guī)范12aCheckstyle使用效果黃色的區(qū)域就是checkstyle檢查出有問題的地方（紅色表示錯(cuò)誤，黃色表示警告）。13aCheckstyle-編寫javadoc注意點(diǎn)/**{@inheritDoc}*/publicintcheckReturnTag(finalintaTagIndex,JavadocTag[]aTags,intaLineNo)14aPMDPMD提供了一些開發(fā)過程中的最佳實(shí)踐。Possiblebugs-emptytry/catch/finally/switchstatementsDeadcode-unusedlocalvariables,parametersandprivatemethodsSuboptimalcode-wastefulString/StringBufferusageOvercomplicatedexpressions-unnecessaryifstatements,forloopsthatcouldbewhileloopsDuplicatecode-copied/pastedcodemeanscopied/pastedbugs15aPMD-Exception規(guī)則AvoidCatchingThrowableSignatureDeclareThrowsExceptionExceptionAsFlowControlAvoidThrowingRawExceptionTypesAvoidThrowingNullPointerExceptionAvoidRethrowingExceptionDoNotExtendJavaLangErrorDoNotThrowExceptionInFinallyAvoidThrowingNewInstanceOfSameException16aPMDPMD中的很多規(guī)則會(huì)比較有爭(zhēng)議，或者跟大家現(xiàn)有的技術(shù)框架、代碼結(jié)構(gòu)有沖突。大家可以通過自定義的這些規(guī)則的級(jí)別（Error，Warning）來把握對(duì)這些規(guī)則的使用程度。17aFindBugsFindBugs是一個(gè)java代碼的靜態(tài)代碼分析工具，用來發(fā)現(xiàn)那些潛在的、常見的、很難被發(fā)現(xiàn)的bug.18a其他的工具Jslint-TheJavaScriptCo