注意 | Java程序員容易犯的10大低級錯誤

作者：交大全棧智能工程師 2018-09-29 16:10:02

開發(fā) 后端

本文根據(jù)java開發(fā)人員在編碼過程中容易忽視或經(jīng)常出錯的地方進行了整理，總結了十個比較常見的低級錯誤點，方便大家學習。

1、不能用“==”比較兩個字符串內容相等。

2、對list做foreach循環(huán)時，循環(huán)代碼中不能修改list的結構。

3、日志和實際情況不一致;捕獲異常后沒有在日志中記錄異常棧。

4、魔鬼數(shù)字。

5、空指針異常。

6、數(shù)組下標越界。

7、將字符串轉換為數(shù)字時沒有捕獲NumberFormatException異常。

8、對文件、IO、數(shù)據(jù)庫等資源進行操作后沒有及時、正確進行釋放。

9、循環(huán)體編碼時不考慮性能，循環(huán)體中包含不需要的重復邏輯。

10、數(shù)據(jù)類沒有重載toString()方法。

1不能用“==”比較兩個字符串內容相等。

解讀

兩個字符串在比較內容是否相等的時候，如果使用“==”，當兩個字符串不是指向內存中同一地址，那么即使這兩個字符串內容一樣，但是用“==”比較出來的結果也是false。所以兩個字符串在比較內容是否相等的時候一定要使用“equals”方法。

示例

下面就是一個字符串比較的例子：

publicclass Test {  
publicstaticvoid main(String[] args)  
{  
String a = new String("a");  
String a2 = "a";  
if(a == a2)  
{  
System.out.println("a == a2return true.");  
}  
else  
{  
System.out.println("a == a2 returnfalse.");  
}  
if(a.equals(a2))  
{ 
 System.out.println("a.equals(a2)return true.");  
}  
else  
{  
System.out.println("a.equals(a2)return false.");  
}  
}  
}

最終輸出的結果為：

a == a2 return false.  
a.equals(a2) return true.

2 不能在foreach循環(huán)中修改list結構

解讀

在jdk1.5版以上的foreach循環(huán)寫法中，不能在循環(huán)代碼中對正在循環(huán)的list的結構進行修改，即對list做add、remove等操作，如果做了這些操作，必須立即退出循環(huán)，否則會拋出異常。

示例

publicclass Test { 
 publicstaticvoid main(String[] args) 
 { 
 List<Person> list = new ArrayList<Person>(); 
 Person p1 = new Person("張三", 23); 
 Person p2 = new Person("李四", 26); 
 Person p3 = new Person("王五", 34); 
 Person p4 = new Person("劉二", 15); 
 Person p5 = new Person("朱六", 40); 
  
 list.add(p1); 
 list.add(p2); 
 list.add(p3); 
 list.add(p4); 
 list.add(p5); 
 for(Person p : list) 
 { 
 if("王五".equals(p.getName())) 
 { 
 list.remove(p); // 不能在此時刪除對象。 
 } 
elseif("李四".equals(p.getName())) 
 { 
 list.remove(p); // 不能在此時刪除對象。 
 } 
 } 
 System.out.println(list.size()); 
 } 
} 
  
class Person 
{ 
 private String name; 
 privateintage; 
  
 public Person(String name, int age) 
 { 
 this.name = name; 
 this.age = age; 
 } 
  
 public String getName() 
 { 
 returnname; 
 } 
  
 publicvoid setName(String name) 
 { 
 this.name = name; 
 } 
  
 publicint getAge() 
 { 
 returnage; 
 } 
  
 publicvoid setAge(int age) 
 { 
 this.age = age; 
 } 
}

解決上面代碼紅色部分的問題，可以通過循環(huán)取出對象，然后再循環(huán)結束后再進行刪除。

List<Person> list = new ArrayList<Person>(); 
 Person p1 = new Person(new String("張三"), 23); 
 Person p2 = new Person(new String("李四"), 26); 
 Person p3 = new Person(new String("王五"), 34); 
 Person p4 = new Person(new String("劉二"), 15); 
 Person p5 = new Person(new String("朱六"), 40); 
  
 list.add(p1); 
 list.add(p2); 
 list.add(p3); 
 list.add(p4); 
 list.add(p5); 
  
 Person wangwu = null; 
 Person lisi = null; 
 for(Person p : list) 
 { 
 if("王五".equals(p.getName())) 
 { 
 wangwu = p; 
 } 
 elseif("李四".equals(p.getName())) 
 { 
 lisi = p; 
 } 
 } 
  
 list.remove(wangwu); 
 list.remove(lisi);

3 日志規(guī)范性

解讀

日志是定位問題時最重要的依據(jù)，業(yè)務流程中缺少必要的日志會給定位問題帶來很多麻煩，甚至可能造成問題完全無法定位。

異常產(chǎn)生后，必須在日志中以ERROR或以上級別記錄異常棧，否則會導致異常棧丟失，無法確認異常產(chǎn)生的位置。并不需要在每次捕獲異常時都記錄異常日志，這樣可能導致異常被多次重復記錄，影響問題的定位。但異常發(fā)生后其異常棧必須至少被記錄一次。

和注釋一樣，日志也不是越多越好。無用的冗余日志不但不能幫助定位問題，還會干擾問題的定位。而錯誤的日志更是會誤導問題，必須杜絕。

示例

下面的例子雖然打印了很多日志，但基本上都是無用的日志，難以幫助定位問題。甚至還有錯誤的日志會干擾問題的定位：

public voidsaveProduct1(ProductServiceStruct product) 
{ 
 log.debug("enter method: addProduct()"); 
  
 log.debug("check product status"); 
 if(product.getProduct().getProductStatus() != ProductFieldEnum.ProductStatus.RELEASE) 
 { 
 thrownew PMSException(PMSErrorCode.Product.ADD_ERROR); 
 } 
  
 log.debug("check tariff"); 
 BooleanResult result =checkTariff(product.getTariffs()); 
 if(!result.getResult()) 
 { 
 thrownewPMSException(PMSErrorCode.Product.ADD_ERROR); 
 } 
  
 log.debug("before add product"); 
 ProductService prodSrv = (ProductService)ServiceLocator.findService(ProductService.class); 
 try 
 { 
 prodSrv.addProduct(product); 
 } 
 catch(BMEException e) 
 { 
 // 未記錄異常棧，無法定位問題根源 
 } 
  
 log.debug("after add product"); 
 log.debug("exit method: updateProduct()"); // 錯誤的日志 
}

而下面的例子日志打印的不多，但都是關鍵信息，可以很好的幫助定位問題：

public voidsaveProduct2(ProductServiceStruct product) 
{ 
 if(product.getProduct().getProductStatus() != ProductFieldEnum.ProductStatus.RELEASE) 
 { 
 log.error( 
 "productstatus " 
 +product.getProduct().getProductStatus() 
 + "error, expect " + ProductFieldEnum.ProductStatus.RELEASE); 
 thrownewPMSException(PMSErrorCode.Product.ADD_ERROR); 
 } 
  
 BooleanResult result =checkTariff(product.getTariffs()); 
 if(!result.getResult()) 
 { 
 log.error( 
 "checkproduct tariff error " 
 + result.getResultCode() 
 + ":" 
 + result.getResultDesc()); 
 thrownewPMSException(PMSErrorCode.Product.ADD_ERROR); 
 } 
  
 ProductService prodSrv = (ProductService)ServiceLocator.findService(ProductService.class); 
 try 
 { 
 prodSrv.addProduct(product); 
 } 
 catch(BMEException e) 
 { 
 log.error("add product error", e); 
 thrownewPMSException(PMSErrorCode.Product.ADD_ERROR,e); 
 } 
}

4 魔鬼數(shù)字

解讀

在代碼中使用魔鬼數(shù)字(沒有具體含義的數(shù)字、字符串等)將會導致代碼難以理解，應該將數(shù)字定義為名稱有意義的常量。

將數(shù)字定義為常量的最終目的是為了使代碼更容易理解，所以并不是只要將數(shù)字定義為常量就不是魔鬼數(shù)字了。如果常量的名稱沒有意義，無法幫助理解代碼，同樣是一種魔鬼數(shù)字。

在個別特殊情況下，將數(shù)字定義為常量反而會導致代碼更難以理解，此時就不應該強求將數(shù)字定義為常量。

示例

public void addProduct(ProductServiceStruct product) 
{ 
 // 魔鬼數(shù)字，無法理解3具體代表產(chǎn)品的什么狀態(tài) 
 if(product.getProduct().getProductStatus() != 3) 
 { 
 thrownewPMSException(PMSErrorCode.Product.ADD_ERROR); 
 } 
  
 BooleanResult result =checkTariff(product.getTariffs()); 
 if(!result.getResult()) 
 { 
 thrownew PMSException(PMSErrorCode.Product.ADD_ERROR); 
 } 
} 
  
/** 
*產(chǎn)品未激活狀態(tài) 
*/ 
privatestaticfinalintUNACTIVATED = 0; 
/** 
*產(chǎn)品已激活狀態(tài) 
*/ 
privatestaticfinalintACTIVATED = 1; 
  
public voidaddProduct2(ProductServiceStruct product) 
{ 
 if(product.getProduct().getProductStatus() != ACTIVATED) 
 { 
 thrownewPMSException(PMSErrorCode.Product.ADD_ERROR); 
 } 
  
 BooleanResult result =checkTariff(product.getTariffs()); 
 if(!result.getResult()) 
 { 
 thrownewPMSException(PMSErrorCode.Product.ADD_ERROR); 
 } 
}

5 空指針異常

解讀

空指針異常是編碼過程中最常見的異常，在使用一個對象的時候，如果對象可能為空，并且使用次對象可能會造成空指針異常，那么需要先判斷對象是否為空，再使用這個對象。

在進行常量和變量的相等判斷時，建議將常量定義為Java對象封裝類型(如將int類型的常量定義為Integer類型)，這樣在比較時可以將常量放在左邊，調用equals方法進行比較，可以省去不必要的判空。

示例

public classNullPointer 
{ 
 staticfinal Integer RESULT_CODE_OK = 0; 
 staticfinal Result RESULT_OK = newResult(); 
  
 publicvoid printResult(Integer resultCode) 
 { 
 Result result = getResult(resultCode); 
  
 // result可能為null，造成空指針異常 
 if(result.isValid()) 
 { 
 print(result); 
 } 
 } 
  
 publicResult getResult(Integer resultCode) 
 { 
 // 即使resultCode為null，仍然可以正確執(zhí)行，減少額外的判空語句 
 if(RESULT_CODE_OK.equals(resultCode)) 
 { 
 returnRESULT_OK; 
 } 
 returnnull; 
 } 
  
 publicvoid print(Result result) 
 { 
 ... 
 } 
}

6 下標越界

解讀

訪問數(shù)組、List等容器內的元素時，必須首先檢查下標是否越界，杜絕下標越界異常的發(fā)生。

示例

publicclass ArrayOver 
{ 
 publicvoid checkArray(String name) 
 { 
 // 獲取一個數(shù)組對象 
 String[] cIds = ContentService.queryByName(name); 
 if(null != cIds) 
 { 
 // 只是考慮到cids有可能為null的情況，但是cids完全有可能是個0長度的數(shù)組，因此cIds[0]有可能數(shù)組下標越界 
 String cid=cIds[0]; 
 cid.toCharArray(); 
 } 
 } 
}

7 字符串轉數(shù)字

解讀

調用Java方法將字符串轉換為數(shù)字時，如果字符串的格式非法，會拋出運行時異常NumberFormatException。

示例

錯誤例子：

public Integer getInteger1(String number) 
{ 
 // 如果number格式非法，會拋出NumberFormatException 
 returnInteger.valueOf(number); 
}

正確的處理方法如下：

public Integer getInteger2(String number) 
{ 
 try 
 { 
 returnInteger.valueOf(number); 
 } 
 catch(NumberFormatException e) 
 { 
 ... 
 //記錄日志異常信息 
 returnnull; 
 } 
}

注意：在捕獲異常后一定要記錄日志。

8 資源釋放

解讀

在使用文件、IO流、數(shù)據(jù)庫連接等不會自動釋放的資源時，應該在使用完畢后馬上將其關閉。關閉資源的代碼應該在try...catch...finally的finally內執(zhí)行，否則可能造成資源無法釋放。

示例

錯誤案例如下：

public voidwriteProduct1(ProductServiceStruct product) 
{ 
 try 
 { 
 FileWriter fileWriter = new FileWriter(""); 
 fileWriter.append(product.toString()); 
 // 如果append()拋出異常，close()方法就不會執(zhí)行，造成IO流長時間無法釋放 
 fileWriter.close(); 
 } 
 catch(IOException e) 
 { 
 ... 
 } 
} 
關閉IO流的正確方法如下： 
public voidwriteProduct2(ProductServiceStruct product) 
{ 
 FileWriter fileWriter = null; 
 try 
 { 
 fileWriter = new FileWriter(""); 
 fileWriter.append(product.toString()); 
 } 
 catch(IOException e) 
 { 
 ... 
 //記錄日志 
 } 
 finally 
 { 
 // 不管前面是否發(fā)生異常，finally中的代碼一定會執(zhí)行 
 if(fileWriter != null) 
 { 
 try 
 { 
 fileWriter.close(); 
 } 
 catch(IOException e) 
 { 
 ... 
 //記錄日志 
 } 
 } 
 } 
}

注意：在捕獲異常后一定要記錄日志。

9 循環(huán)體性能

解讀

循環(huán)體是軟件中最容易造成性能問題的地方，所以在進行循環(huán)體編碼時務必考慮性能問題。

在循環(huán)體內重復使用且不會變化的資源(如變量、文件對象、數(shù)據(jù)庫連接等)，應該在循環(huán)體開始前構造并初始化，避免在循環(huán)體內重復和構造初始化造成CPU資源的浪費。

除非業(yè)務場景需要，避免在循環(huán)體內構造try...catch塊，因為每次進入、退出try...catch塊都會消耗一定的CPU資源，將try...catch塊放在循環(huán)體之外可以節(jié)省大量的執(zhí)行時間。

示例

public voidaddProducts(List<ProductServiceStruct> prodList) 
{ 
 for(ProductServiceStruct product : prodList) 
 { 
 // prodSrv在每次循環(huán)時都會重新獲取，造成不必要的資源消耗 
 ProductService prodSrv =(ProductService) ServiceLocator.findService(ProductService.class); 
  
 // 避免在循環(huán)體內try...catch，放在循環(huán)體之外可以節(jié)省執(zhí)行時間 
 try 
 { 
 prodSrv.addProduct(product); 
 } 
 catch(BMEException e) 
 { 
 ... 
 //記錄日志 
 } 
 } 
}

在循環(huán)體中遇到字符串相加，一定要使用StringBuffer這個類。

10 數(shù)據(jù)類重載toString()方法

解讀

數(shù)據(jù)類如果沒有重載toString()方法，在記錄日志的時候會無法記錄數(shù)據(jù)對象的屬性值，給定位問題帶來困難。

示例

public classMdspProductExt 
{ 
 privateString key; 
  
 privateString value; 
  
 publicString getKey() 
 { 
 returnkey; 
 } 
  
 publicvoid setKey(String key) 
 { 
 this.key = key; 
 } 
  
 publicString getValue() 
 { 
 returnvalue; 
 } 
  
 publicvoid setValue(String value) 
 { 
 this.value = value; 
 } 
} 
  
class BusinessProcess 
{ 
 privateDebugLog log = LogFactory.getDebugLog(BusinessProcess.class); 
  
 publicvoid doBusiness(MdspProductExtprodExt) 
 { 
 try 
 { 
 ... 
 } 
 catch(PMSException e) 
 { 
 // MdspProductExt未重載toString()方法，日志中無法記錄對象內屬性的值，只能記錄對象地址 
 log.error("error while process prodExt " +prodExt); 
 } 
 } 
}

這10個低級錯誤你有沒有犯過呢?

責任編輯：龐桂玉來源：今日頭條