摘要：作者Veera Sundar在清理代碼工作時(shí)發(fā)現(xiàn)一些常見的違規(guī)編碼，因此，Veera Sundar把針對(duì)常見的一些違規(guī)編碼總結(jié)成一份列表，以便幫助Java愛好者提高代碼的質(zhì)量和可維護(hù)性。
最近，我給Java項(xiàng)目做了一次代碼清理工作。經(jīng)過清理后，我發(fā)現(xiàn)一組常見的違規(guī)代碼（指不規(guī)范的代碼并不表示代碼錯(cuò)誤）重復(fù)出現(xiàn)在代碼中。因此，我把常見的這些違規(guī)編碼總結(jié)成一份列表，分享給大家以幫助Java愛好者提高代碼的質(zhì)量和可維護(hù)性。
這份列表沒有依據(jù)任何規(guī)則或順序，所有的這些都是通過代碼質(zhì)量工具包括CheckStyle，F(xiàn)indBugs和PMD檢查出。一起來看下：
一、Eclipse編譯器提供源代碼格式輸入
Eclipse提供自動(dòng)源碼格式選項(xiàng)，并且組織輸入（刪除未使用的代碼）。你可以使用下面的這些快捷鍵進(jìn)行操作。
Ctrl + Shift + F——源代碼格式
Ctrl + Shift + O——組織輸入并刪除未使用的代碼
代替手動(dòng)調(diào)用這兩個(gè)函數(shù)，只需根據(jù)Eclipse自動(dòng)格式和自動(dòng)組織選項(xiàng)，可以隨時(shí)保存文件。
操作步驟，在Eclipse中進(jìn)入Window -> Preferences -> Java -> Editor -> Save Actions，然后以選定的方式保存，最后檢查Format source code + Organize imports。
二、避免多個(gè)返回（退出點(diǎn)）
依照你的方法，確保只有一個(gè)退出點(diǎn)。不要在同一個(gè)地方或多個(gè)地方使用返回。比如，下面的代碼，NOT RECOMMENDED（不建議），這是因?yàn)橛卸鄠€(gè)退出點(diǎn)（返回語句）。
- private boolean isEligible(int age){
- if(age > 18){
- return true;
- }else{
- return false;
- }
- }
|
下面的代碼有所提升，這是更高版本的。
- private boolean isEligible(int age){
- boolean result;
- if(age > 18){
- result = true;
- }else{
- result = false;
- }
- return result;
- }
|
三、簡化if-else
我寫了幾個(gè)實(shí)用的方法作為參考，檢查語句條件并且基于該條件返回值。比如，考慮到isEligible方法，正如你之前所看到的：
- private boolean isEligible(int age){
- boolean result;
- if(age > 18){
- result = true;
- }else{
- result = false;
- }
- return result;
- }
|
整個(gè)方法以一個(gè)單一的return語句重新編寫：
- private boolean isEligible(int age){
- return age > 18;
- }
|
四、不要給Boolean, Integer或者String創(chuàng)建新的實(shí)例
避免給Boolean，Integer，String創(chuàng)建新的實(shí)例。比如，使用new Boolean(true)，Boolean，valueOf(true)。修改后的語句與之前的效果基本相同，除了在性能上有所提升。
五、使用大括號(hào)模塊語句
永遠(yuǎn)別忘了使用大括號(hào)模塊語句比如if、for、while。這樣做的好處是當(dāng)你在修改模塊級(jí)語句時(shí)減少了模糊代碼并且避免引進(jìn)bug的機(jī)會(huì)。
不建議：
- if(age > 18)
- result = true;
- else
- result = false;
|
建議：
- if(age > 18){
- result = true;
- }else{
- result = false;
- }
|
六、以final類型標(biāo)記方法參數(shù)，任何時(shí)候都適用
請(qǐng)記住，以final類型標(biāo)記方法參數(shù)，任何時(shí)候都適用。這樣做的好處在于當(dāng)你不小心修改參數(shù)值時(shí)，編譯器會(huì)給你警告，同時(shí)它還能以更好的方式優(yōu)化編譯器代碼字節(jié)。
建議：
| private boolean isEligible(final int age){ ... } |
七、在UPPERCASE中命名public static final字段
在UPPERCASE中命名public static final字段（通常也被稱之為常量）。這個(gè)可以讓你輕松區(qū)分常量字段和局部變量之間的不同。
不建議：
| public static final String testAccountNo = "12345678"; |
建議：
| public static final String TEST_ACCOUNT_NO = "12345678";, |
八、組合成單一的if語句
在盡可能多的情況下，把多個(gè)if語句組合成單一的if語句，比如下面的代碼：
- if(age > 18){
- if( voted == false){
- // eligible to vote.
- }
- }
|
合并成單一的if語句：
- if(age > 18 && !voted){
- // eligible to vote
- }
|
九、Switch應(yīng)該有default
始終給Switch語句添加default。
十、使用常量來避免重復(fù)定義相同的字符串值
如果你在多個(gè)地方必須使用字符串，那么使用常量來避免重復(fù)定義擁有相同值的字符串。
比如，看下面的代碼：
- private void someMethod(){
- logger.log("My Application" + e);
- ....
- ....
- logger.log("My Application" + f);
- }
|
string literal“我的應(yīng)用”可以作為常量并且能在代碼中使用。
- public static final String MY_APP = "My Application";
-
- private void someMethod(){
- logger.log(MY_APP + e);
- ....
- ....
- logger.log(MY_APP + f);
- }
|