Java程式設計常見低階錯誤（整理）
阿新 • • 發佈：2019-02-03
前言
本文件根據java開發人員在編碼過程中容易忽視或經常出錯的地方進行了整理，總結了十個比較常見的低階錯誤點，方便大家學習。
一：使用“ == ”比較兩個String物件是否相等
兩個字串在比較內容是否相等的時候，如果使用“==”，當兩個字串不是指向記憶體中同一地址，那麼即使這兩個字串內容一樣，但是用“==”比較出來的結果也是false。所以兩個字串在比較內容是否相等的時候一定要使用“equals”方法。
輸出結果：public class Test { public static void main(String[] args) { String a = new String("a"); String a2 = "a"; if(a == a2) { System.out.println("a == a2 return true."); } else { System.out.println("a == a2 return 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.
二：迴圈結構體中修改List資料結構
在jdk1.5版以上的foreach迴圈寫法中，不能在迴圈程式碼中對正在迴圈的list的結構進行修改，即對list做add、remove等操作，如果做了這些操作，必須立即退出迴圈，否則會丟擲異常。
public class Test { public static void 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); // 不能在此時刪除物件。 } 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 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);
三：日誌使用不規範
日誌是定位問題時最重要的依據，業務流程中缺少必要的日誌會給定位問題帶來很多麻煩，甚至可能造成問題完全無法定位。
異常產生後，必須在日誌中以ERROR或以上級別記錄異常棧，否則會導致異常棧丟失，無法確認異常產生的位置。並不需要在每次捕獲異常時都記錄異常日誌，這樣可能導致異常被多次重複記錄，影響問題的定位。但異常發生後其異常棧必須至少被記錄一次。
和註釋一樣，日誌也不是越多越好。無用的冗餘日誌不但不能幫助定位問題，還會干擾問題的定位。而錯誤的日誌更是會誤導問題，必須杜絕。
下面的例子雖然列印了很多日誌，但基本上都是無用的日誌，難以幫助定位問題。甚至還有錯誤的日誌會干擾問題的定位：
public void saveProduct1(ProductServiceStruct product)
{
log.debug("enter method: addProduct()");
log.debug("check product status");
if (product.getProduct().getProductStatus() != ProductFieldEnum.ProductStatus.RELEASE)
{
throw new PMSException(PMSErrorCode.Product.ADD_ERROR);
}
log.debug("check tariff");
BooleanResult result = checkTariff(product.getTariffs());
if (!result.getResult())
{
throw new PMSException(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 void saveProduct2(ProductServiceStruct product)
{
if (product.getProduct().getProductStatus() != ProductFieldEnum.ProductStatus.RELEASE)
{
log.error(
"product status "
+ product.getProduct().getProductStatus()
+ " error, expect " + ProductFieldEnum.ProductStatus.RELEASE);
throw new PMSException(PMSErrorCode.Product.ADD_ERROR);
}
BooleanResult result = checkTariff(product.getTariffs());
if (!result.getResult())
{
log.error(
"check product tariff error "
+ result.getResultCode()
+ ": "
+ result.getResultDesc());
throw new 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);
throw new PMSException(PMSErrorCode.Product.ADD_ERROR, e);
}
}
四：魔鬼數字
在程式碼中使用魔鬼數字（沒有具體含義的數字、字串等）將會導致程式碼難以理解，應該將數字定義為名稱有意義的常量。
將數字定義為常量的最終目的是為了使程式碼更容易理解，所以並不是只要將數字定義為常量就不是魔鬼數字了。如果常量的名稱沒有意義，無法幫助理解程式碼，同樣是一種魔鬼數字。
在個別特殊情況下，將數字定義為常量反而會導致程式碼更難以理解，此時就不應該強求將數字定義為常量。
public void addProduct(ProductServiceStruct product)
{
// 魔鬼數字，無法理解3具體代表產品的什麼狀態
if (product.getProduct().getProductStatus() != 3)
{
throw new PMSException(PMSErrorCode.Product.ADD_ERROR);
}
BooleanResult result = checkTariff(product.getTariffs());
if (!result.getResult())
{
throw new PMSException(PMSErrorCode.Product.ADD_ERROR);
}
}
/**
*產品未啟用狀態
*/
private static final int UNACTIVATED = 0;
/**
*產品已啟用狀態
*/
private static final int ACTIVATED = 1;
public void addProduct2(ProductServiceStruct product)
{
if (product.getProduct().getProductStatus() != ACTIVATED)
{
throw new PMSException(PMSErrorCode.Product.ADD_ERROR);
}
BooleanResult result = checkTariff(product.getTariffs());
if (!result.getResult())
{
throw new PMSException(PMSErrorCode.Product.ADD_ERROR);
}
}
五：空指標異常
空指標異常是編碼過程中最常見的異常，在使用一個物件的時候，如果物件可能為空，並且使用次物件可能會造成空指標異常，那麼需要先判斷物件是否為空，再使用這個物件。
在進行常量和變數的相等判斷時，建議將常量定義為Java物件封裝型別（如將int型別的常量定義為Integer型別），這樣在比較時可以將常量放在左邊，呼叫equals方法進行比較，可以省去不必要的判空。
public class NullPointer
{
static final Integer RESULT_CODE_OK = 0;
static final Result RESULT_OK = new Result();
public void printResult(Integer resultCode)
{
Result result = getResult(resultCode);
// result可能為null，造成空指標異常
if (result.isValid())
{
print(result);
}
}
public Result getResult(Integer resultCode)
{
// 即使resultCode為null，仍然可以正確執行，減少額外的判空語句
if (RESULT_CODE_OK.equals(resultCode))
{
return RESULT_OK;
}
return null;
}
public void print(Result result)
{
...
}
}
六：下標越界
訪問陣列、List等容器內的元素時，必須首先檢查下標是否越界，杜絕下標越界異常的發生。
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();
}
}
}
七：字串轉數字
呼叫Java方法將字串轉換為數字時，如果字串的格式非法，會丟擲執行時異常NumberFormatException。錯誤例子：
public Integer getInteger1(String number)
{
// 如果number格式非法，會丟擲NumberFormatException
return Integer.valueOf(number);
}
public Integer getInteger2(String number)
{
try
{
return Integer.valueOf(number);
}
catch (NumberFormatException e)
{
...
//記錄日誌異常資訊
return null;
}
}
注意：在捕獲異常後一定要記錄日誌。
八：資源釋放
在使用檔案、IO流、資料庫連線等不會自動釋放的資源時，應該在使用完畢後馬上將其關閉。關閉資源的程式碼應該在try...catch...finally的finally內執行，否則可能造成資源無法釋放。九：資料類重寫toString()方法
資料類如果沒有過載toString()方法，在記錄日誌的時候會無法記錄資料物件的屬性值，給定位問題帶來困難。public class MdspProductExt
{
private String key;
private String value;
public String getKey()
{
return key;
}
public void setKey(String key)
{
this.key = key;
}
public String getValue()
{
return value;
}
public void setValue(String value)
{
this.value = value;
}
}
class BusinessProcess
{
private DebugLog log = LogFactory.getDebugLog(BusinessProcess.class);
public void doBusiness(MdspProductExt prodExt)
{
try
{
...
}
catch (PMSException e)
{
// MdspProductExt未過載toString()方法，日誌中無法記錄物件內屬性的值，只能記錄物件地址
log.error("error while process prodExt " + prodExt);
}
}
}