這篇文章給大家介紹常見的Java不規(guī)范代碼有哪幾種,內(nèi)容非常詳細(xì),感興趣的小伙伴們可以參考借鑒,希望對(duì)大家能有所幫助。
創(chuàng)新互聯(lián)主要從事網(wǎng)站設(shè)計(jì)、成都網(wǎng)站設(shè)計(jì)、網(wǎng)頁設(shè)計(jì)、企業(yè)做網(wǎng)站、公司建網(wǎng)站等業(yè)務(wù)。立足成都服務(wù)吉州,10多年網(wǎng)站建設(shè)經(jīng)驗(yàn),價(jià)格優(yōu)惠、服務(wù)專業(yè),歡迎來電咨詢建站服務(wù):18980820575
在工作上,我最近對(duì)一個(gè)現(xiàn)有的Java項(xiàng)目代碼進(jìn)行了清理。完成之后,我發(fā)現(xiàn)了一些反復(fù)出現(xiàn)的不規(guī)范代碼。所以,我把它們整理成了一個(gè)列表出來分享給我的同行希望能引起注意并改善代碼的質(zhì)量和可維護(hù)性。
這個(gè)列表不區(qū)分順序,全部來自一些代碼質(zhì)量檢查工具,如 CheckStyle, FindBugs 和 PMD。
在Eclipse中格式化源代碼并管理import語句
Eclipse提供了自動(dòng)格式化源代碼和管理import語句的功能(并移除未使用的語句)。你可以使用下面的快捷鍵來使用這些功能。
Ctrl + Shift + F – 格式化源代碼。
Ctrl + Shift + O – 管理import語句并移除未使用的語句。
除了手動(dòng)執(zhí)行這兩個(gè)功能外,你還可以讓Eclipse在保存文件的時(shí)候自動(dòng)格式化源代碼并自動(dòng)管理import語句。要做到這個(gè),在Eclipse中,到 Window -> Preferences -> Java -> Editor -> Save Actions并啟用 Perform the selected actions on save,選中 Format source code和 organize imports。
避免在方法中出現(xiàn)多個(gè)return語句(退出點(diǎn)):
在你的方法中,確保只有一個(gè) 退出點(diǎn)。不要在一個(gè)方法中使用多于一個(gè)return語句。
如,下面的代碼是 不推薦的,因?yàn)樗卸鄠€(gè)退出點(diǎn)(return語句)。
private boolean isEligible(int age){ if(age > 18){ return true; }else{ return false; } }
上面的代碼可以這么寫(當(dāng)然,下面的代碼還可以改進(jìn),后面再說)。
private boolean isEligible(int age){ boolean result; if(age > 18){ result = true; }else{ result = false; } return result; }
簡化if-else方法:
我們寫了一些只要一個(gè)參數(shù)的工具方法,檢查一些條件并根據(jù)條件返回一個(gè)值。如,在上面見到的 isEligible方法。
private boolean isEligible(int age){ boolean result; if(age > 18){ result = true; }else{ result = false; } return result; }
可以只使用一個(gè)return語句來重寫此方法。
private boolean isEligible(int age){ return age > 18; }
不要為Boolean,Integer或String創(chuàng)建新的實(shí)例:
避免創(chuàng)建新的Boolean,Integer,String等實(shí)例。使用Boolean.valueOf(true)代替new Boolean(true)。兩種寫法效果差不多但卻可以改善性能。
在代碼塊周圍使用大括號(hào):
永遠(yuǎn)不要忘記在塊類型語句(如:if,for,while)周圍使用大括號(hào)。這可以減少代碼歧義并且避免在你修改代碼塊的時(shí)候產(chǎn)生新的bug。
不推薦
if(age > 18) return true; else return false;
推薦
if(age > 18){ return true; }else{ return false; }
把方法的參數(shù)聲明為final類型:
總是在所有兼容的地方把把方法的參數(shù)聲明為final。這樣做的話,當(dāng)你無意中修改了參數(shù)的值,編譯時(shí)會(huì)得到警告,并且編譯生成的字節(jié)碼也會(huì)得到優(yōu)化。
推薦
private boolean isEligible(final int age){ ... }
用大寫命名public static final類型成員變量:
總是使用大寫命名用public static final類型變量。這樣可以讓你很容易區(qū)分常量和本地變量。
不推薦
public static final String testAccountNo = "12345678";
推薦
public static final String TEST_ACCOUNT_NO = "12345678";
把多個(gè)if語句合并成一個(gè):
下面的代碼
if(age > 18){ if( voted == false){ // eligible to vote. } }
可以使用一個(gè)if語句改寫為:
if(age > 18 && !voted){ // eligible to vote }
別忘了給switch添加default語句:
總是給switch添加一個(gè)default語句。
避免重復(fù)使用同樣的字符串,創(chuàng)建一個(gè)常量吧:
如果你需要在多個(gè)地方使用同一個(gè)字符串,那就創(chuàng)建一個(gè)字符串常量來使用吧。
下面的代碼:
private void someMethod(){ logger.log("My Application" + e); .... .... logger.log("My Application" + f); }
可以創(chuàng)建一個(gè)常量代替字符串"My Application":
public static final String MY_APP = "My Application"; private void someMethod(){ logger.log(MY_APP + e); .... .... logger.log(MY_APP + f); }
其它資源:Java***實(shí)踐 , 代碼規(guī)范檢查 , PMD規(guī)則列表
關(guān)于常見的Java不規(guī)范代碼有哪幾種就分享到這里了,希望以上內(nèi)容可以對(duì)大家有一定的幫助,可以學(xué)到更多知識(shí)。如果覺得文章不錯(cuò),可以把它分享出去讓更多的人看到。