一、說明

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

二、 Java十大低級錯誤

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

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

3、日誌和實際情況不一致；捕獲異常後沒有在日誌中記錄異常棧。

4、魔鬼數字。

5、空指針異常。

6、數組下標越界。

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

8、對文件、IO、數據庫等資源進行操作後沒有及時、正確進行釋放。

9、循環體編碼時不考慮性能，循環體中包含不需要的重複邏輯。

10、數據類沒有重載toString方法。

三、解讀&案例

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

3.1.1解讀

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

3.1.2示例

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

public class Test {

public static void 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 == a2return false.");

}

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.

3.2不能在foreach循環中修改list結構

3.2.1解讀

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

3.2.2示例

public class Test {

public static void main(String args){

List<person> list = new ArrayList<person>;/<person>/<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); //不能在此時刪除對象。

}

else if("李四".equals(p.getName)){

list.remove(p); //不能在此時刪除對象。

}

}

System.out.println(list.size);

}

}

class Person{

private String name;

private int age;

public Person(String name, int age){

this.name = name;

this.age = age;

}

public String getName{

return name;

}

public void setName(String name){

this.name = name;

}

public int getAge{

return age;

}

public void setAge(int age){

this.age = age;

}

}

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

List<person> list = new ArrayList<person>;/<person>/<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;

}else if("李四".equals(p.getName)){

lisi = p;

}

}

list.remove(wangwu);

list.remove(lisi);

3.3日誌規範性

3.3.1解讀

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

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

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

3.3.2示例

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

public voidsaveProduct1(ProductServiceStruct product){

log.debug("enter method: addProduct");

log.debug("check product status");

if(product.getProduct.getProductStatus != ProductFieldEnum.ProductStatus.RELEASE){

thrownewPMSException(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);

thrownew

PMSException(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);

}

}

3.4魔鬼數字

3.4.1解讀

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

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

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

3.4.2示例

public voidaddProduct(ProductServiceStruct product){

//魔鬼數字，無法理解3具體代表產品的什麼狀態

if(product.getProduct.getProductStatus != 3){

thrownewPMSException(PMSErrorCode.Product.ADD_ERROR);

}

BooleanResult result =checkTariff(product.getTariffs);

if(!result.getResult){

throw newPMSException(PMSErrorCode.Product.ADD_ERROR);

}

}

/**

*產品未激活狀態

*/

private static final int

UNACTIVATED = 0;

/**

*產品已激活狀態

*/

private static final int ACTIVATED = 1;

public voidaddProduct2(ProductServiceStruct product){

if(product.getProduct.getProductStatus != ACTIVATED){

thrownewPMSException(PMSErrorCode.Product.ADD_ERROR);

}

BooleanResult result =checkTariff(product.getTariffs);

if(!result.getResult){

thrownew PMSException(PMSErrorCode.Product.ADD_ERROR);

}

}

3.5空指針異常

3.5.1解讀

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

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

3.5.2示例

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，仍然可以正確執行，減少額外的判空語句

if(RESULT_CODE_OK.equals(resultCode)){

returnRESULT_OK;

}

returnnull;

}

publicvoid print(Result result){

...

}

}

3.6下標越界

3.6.1解讀

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

3.6.2示例

public class ArrayOver{

public void checkArray(String name){

//獲取一個數組對象

String cIds = ContentService.queryByName(name);

if(null != cIds){

//只是考慮到cids有可能為null的情況，但是cids完全有可能是個0長度的數組，因此cIds[0]有可能數組下標越界

String cid=cIds[0];

cid.toCharArray;

}

}

}

3.7字符串轉數字

3.7.1解讀

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

3.7.2示例

錯誤例子：

public Integer getInteger1(String number){

//如果number格式非法，會拋出NumberFormatException

return

Integer.valueOf(number);

}

正確的處理方法如下：

public Integer getInteger2(String number){

try{

returnInteger.valueOf(number);

}

catch(NumberFormatException e){

...

//記錄日誌異常信息

returnnull;

}

}

注意：在捕獲異常後一定要記錄日誌。

3.8資源釋放

3.8.1解讀

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

3.8.2示例

錯誤案例如下：

public voidwriteProduct1(ProductServiceStruct product){

try{

FileWriter fileWriter = new FileWriter("");

fileWriter.append(product.toString);

//如果append拋出異常，close方法就不會執行，造成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{

//不管前面是否發生異常，finally中的代碼一定會執行

if(fileWriter != null){

try{

fileWriter.close;

}catch(IOException e){

...

//記錄日誌

}

}

}

}

注意：在捕獲異常後一定要記錄日誌。

3.9循環體性能

3.9.1解讀

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

在循環體內重複使用且不會變化的資源（如變量、文件對象、數據庫連接等），應該在循環體開始前構造並初始化，避免在循環體內重複和構造初始化造成CPU資源的浪費。

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

3.9.2示例

public voidaddProducts(List<productservicestruct> prodList){/<productservicestruct>

for(ProductServiceStruct product : prodList){

// prodSrv在每次循環時都會重新獲取，造成不必要的資源消耗

ProductService prodSrv = (ProductService)ServiceLocator.findService(ProductService.

class);

//避免在循環體內try...catch，放在循環體之外可以節省執行時間

try{

prodSrv.addProduct(product);

}catch(BMEException e){

...

//記錄日誌

}

}

}

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

3.10數據類重載toString方法

3.10.1解讀

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

3.10.2示例

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);

}}}

---