Java十大低級錯誤

1. 前言

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

2. Java十大低級錯誤

   1. 不能用"=="比較兩個字符串內容相等。
   2. 對list作foreach循環時，循環代碼中不能修改list的結構。
   3. 日誌和實際狀況不一致；捕獲異常後沒有在日誌中記錄異常棧。
   4. 魔鬼數字。
   5. 空指針異常。
   6. 數組下標越界。
   7. 將字符串轉換爲數字時沒有捕獲NumberFormatException異常。
   8. 對文件、IO、數據庫等資源進行操做後沒有及時、正確進行釋放。
   9. 循環體編碼時不考慮性能，循環體中包含不須要的重複邏輯。
   10. 數據類沒有重載toString()方法。

3. 解讀&案例

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

      1. 解讀

   兩個字符串在比較內容是否相等的時候，若是使用"=="，當兩個字符串不是指向內存中同一地址，那麼即便這兩個字符串內容同樣，可是用"=="比較出來的結果也是false。因此兩個字符串在比較內容是否相等的時候必定要使用"equals"方法。

   1. 示例

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

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.

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

   1. 解讀

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

1. 示例

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

1. 日誌規範性

   1. 解讀

日誌是定位問題時最重要的依據，業務流程中缺乏必要的日誌會給定位問題帶來不少麻煩，甚至可能形成問題徹底沒法定位。

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

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

1. 示例

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

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

}

}

 

1. 魔鬼數字

   1. 解讀

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

將數字定義爲常量的最終目的是爲了使代碼更容易理解，因此並非只要將數字定義爲常量就不是魔鬼數字了。若是常量的名稱沒有意義，沒法幫助理解代碼，一樣是一種魔鬼數字。

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

1. 示例

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

}

}

 

1. 空指針異常

   1. 解讀

空指針異常是編碼過程當中最多見的異常，在使用一個對象的時候，若是對象可能爲空，而且使用次對象可能會形成空指針異常，那麼須要先判斷對象是否爲空，再使用這個對象。

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

1. 示例

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)

{

...

}

}

 

1. 下標越界

   1. 解讀

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

1. 示例

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

}

}

}

 

1. 字符串轉數字

   1. 解讀

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

1. 示例

錯誤例子：

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;

}

}

 

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

1. 資源釋放

   1. 解讀

在使用文件、IO流、數據庫鏈接等不會自動釋放的資源時，應該在使用完畢後立刻將其關閉。關閉資源的代碼應該在try...catch...finally的finally內執行，不然可能形成資源沒法釋放。

1. 示例

錯誤案例以下：

public void writeProduct1(ProductServiceStruct product)

{

try

{

FileWriter fileWriter = new FileWriter("");

fileWriter.append(product.toString());

// 若是append()拋出異常，close()方法就不會執行，形成IO流長時間沒法釋放

fileWriter.close();

}

catch (IOException e)

{

...

}

}

關閉IO流的正確方法以下：

public void writeProduct2(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)

{

...

         //記錄日誌

}

}

}

}

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

 

1. 循環體性能

   1. 解讀

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

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

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

1. 示例

public void addProducts(List<ProductServiceStruct> prodList)

{

for (ProductServiceStruct product : prodList)

{

// prodSrv在每次循環時都會從新獲取，形成沒必要要的資源消耗

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

 

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

try

{

prodSrv.addProduct(product);

}

catch (BMEException e)

{

...

         //記錄日誌

}

}

}

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

1. 數據類重載toString()方法

   1. 解讀

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

1. 示例

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

}

}

}