帶你走進Java代碼之優化篇

1.需要 Map 的主鍵和取值時，應該迭代 entrySet()
當循環中只需要 Map 的主鍵時，迭代 keySet() 是正確的。但是，當需要主鍵和取值時，迭代 entrySet() 纔是更高效的做法，比先迭代 keySet() 後再去 get 取值性能更佳。

Map<String,String> map = ...;
for (Map.Entry<String, String> entry : map.entrySet()) {
    String key = entry.getKey();
    String value = entry.getValue();
    ...
}

2.應該使用Collection.isEmpty()檢測空
使用 Collection.size() 來檢測空邏輯上沒有問題，但是使用 Collection.isEmpty()使得代碼更易讀，並且可以獲得更好的性能。任何 Collection.isEmpty() 實現的時間複雜度都是 O(1) ，但是某些 Collection.size() 實現的時間複雜度可能是 O(n) 。

if (collection.isEmpty()) {
    ...
}

3.集合初始化儘量指定大小
java 的集合類用起來十分方便，但是看源碼可知，集合也是有大小限制的。每次擴容的時間複雜度很有可能是 O(n) ，所以儘量指定可預知的集合大小，能減少集合的擴容次數。

int[] arr = new int[]{1, 2, 3};
List<Integer> list = new ArrayList<>(arr.length);
for (int i : arr) {
    list.add(i);
}

4.字符串拼接使用 StringBuilder
一般的字符串拼接在編譯期 java 會進行優化，但是在循環中字符串拼接， java 編譯期無法做到優化，所以需要使用 StringBuilder 進行替換。

String a = "a";
String b = "b";
String c = "c";
String s = a + b + c; // 沒問題，java編譯器會進行優化
StringBuilder sb = new StringBuilder();
for (int i = 0; i < 10; i++) {
    sb.append(i);  // 循環中，java編譯器無法進行優化，所以要手動使用StringBuilder
}

5.List 的隨機訪問
數組和鏈表的區別：數組的隨機訪問效率更高。當調用方法獲取到 List 後，如果想隨機訪問其中的數據，並不知道該數組內部實現是鏈表還是數組，怎麼辦呢？可以判斷它是否實現 RandomAccess 接口。

// 調用服務獲取到list
List<Integer> list = otherService.getList();
if (list instanceof RandomAccess) {
    // 內部數組實現，可以隨機訪問
    System.out.println(list.get(list.size() - 1));
} else {
    // 內部可能是鏈表實現，隨機訪問效率低
}

6.頻繁調用 Collection.contains 方法請使用 Set
在 java 集合類庫中，List 的 contains 方法普遍時間複雜度是 O(n) ，如果在代碼中需要頻繁調用 contains 方法查找數據，可以先將 list 轉換成 HashSet 實現，將 O(n) 的時間複雜度降爲 O(1) 。

ArrayList<Integer> list = otherService.getList();
Set<Integer> set = new HashSet(list);
for (int i = 0; i <= Integer.MAX_VALUE; i++) {
    // 時間複雜度O(1)
    set.contains(i);
}

7.不要使用集合實現來賦值靜態成員變量
對於集合類型的靜態成員變量，不要使用集合實現來賦值，應該使用靜態代碼塊賦值。

private static Map<String, Integer> map = new HashMap<>();
static {
    map.put("a", 1);
    map.put("b", 2);
};

private static List<String> list = new ArrayList<>();
static {
    list.add("a");
    list.add("b");
};

8.刪除未使用的私有方法和字段
錯誤實例：

public class DoubleDemo1 {
    private int unusedField = 100;
    private void unusedMethod() {
        ...
    }
    public int sum(int a, int b) {
        return a + b;
    }
}

正確實例：

public class DoubleDemo1 {
    public int sum(int a, int b) {
        return a + b;
    }
}

9.工具類應該屏蔽構造函數
工具類是一堆靜態字段和函數的集合，不應該被實例化。但是，Java 爲每個沒有明確定義構造函數的類添加了一個隱式公有構造函數。所以，爲了避免 java "小白"使用有誤，應該顯式定義私有構造函數來屏蔽這個隱式公有構造函數。

public class MathUtils {
    public static final double PI = 3.1415926D;
    private MathUtils() {}
    public static int sum(int a, int b) {
        return a + b;
    }
}

10.公有靜態常量應該通過類訪問
雖然通過類的實例訪問公有靜態常量是允許的，但是容易讓人它誤認爲每個類的實例都有一個公有靜態常量。所以，公有靜態常量應該直接通過類訪問。

public class User {
    public static final String CONST_NAME = "name";
    ...
}
String nameKey = User.CONST_NAME;

11.過時代碼添加 @Deprecated 註解
當一段代碼過時，但爲了兼容又無法直接刪除，不希望以後有人再使用它時，可以添加 @Deprecated 註解進行標記。在文檔註釋中添加 @deprecated 來進行解釋，並提供可替代方案。

/**
 * 保存
 *
 * @deprecated 此方法效率較低，請使用{@link newSave()}方法替換它
 */
@Deprecated
public void save(){
    // do something
}

12.禁止使用構造方法 BigDecimal(double)
BigDecimal(double) 存在精度損失風險，在精確計算或值比較的場景中可能會導致業務邏輯異常。

BigDecimal value = BigDecimal.valueOf(0.1D); // 0.1

13.返回空數組和空集合而不是 null
返回 null ，需要調用方強制檢測 null ，否則就會拋出空指針異常。返回空數組或空集合，有效地避免了調用方因爲未檢測 null 而拋出空指針異常，還可以刪除調用方檢測 null 的語句使代碼更簡潔。

錯誤實例：

public static Result[] getResults() {
    return null;
}


public static List<Result> getResultList() {
    return null;
}


public static Map<String, Result> getResultMap() {
    return null;
}


public static void main(String[] args) {
    Result[] results = getResults();
    if (results != null) {
        for (Result result : results) {
            ...
        }
    }


    List<Result> resultList = getResultList();
    if (resultList != null) {
        for (Result result : resultList) {
            ...
        }
    }


    Map<String, Result> resultMap = getResultMap();
    if (resultMap != null) {
        for (Map.Entry<String, Result> resultEntry : resultMap) {
            ...
        }
    }
}

正確實例：

public static Result[] getResults() {
    return new Result[0];
}


public static List<Result> getResultList() {
    return Collections.emptyList();
}


public static Map<String, Result> getResultMap() {
    return Collections.emptyMap();
}


public static void main(String[] args) {
    Result[] results = getResults();
    for (Result result : results) {
        ...
    }


    List<Result> resultList = getResultList();
    for (Result result : resultList) {
        ...
    }


    Map<String, Result> resultMap = getResultMap();
    for (Map.Entry<String, Result> resultEntry : resultMap) {
        ...
    }
}

14.優先使用常量或確定值來調用 equals 方法
對象的 equals 方法容易拋空指針異常，應使用常量或確定有值的對象來調用 equals 方法。當然，使用 java.util.Objects.equals() 方法是最佳實踐。

public void isFinished(OrderStatus status) {
    return OrderStatus.FINISHED.equals(status);
}


public void isFinished(OrderStatus status) {
    return Objects.equals(status, OrderStatus.FINISHED);
}

15.枚舉的屬性字段必須是私有不可變
枚舉通常被當做常量使用，如果枚舉中存在公共屬性字段或設置字段方法，那麼這些枚舉常量的屬性很容易被修改。理想情況下，枚舉中的屬性字段是私有的，並在私有構造函數中賦值，沒有對應的 Setter 方法，最好加上final修飾符。

錯誤實例：

public enum UserStatus {
    DISABLED(0, "禁用"),
    ENABLED(1, "啓用");


    public int value;
    private String description;


    private UserStatus(int value, String description) {
        this.value = value;
        this.description = description;
    }


    public String getDescription() {
        return description;
    }


    public void setDescription(String description) {
        this.description = description;
    }
}

正確實例：

public enum UserStatus {
    DISABLED(0, "禁用"),
    ENABLED(1, "啓用");


    private final int value;
    private final String description;


    private UserStatus(int value, String description) {
        this.value = value;
        this.description = description;
    }


    public int getValue() {
        return value;
    }


    public String getDescription() {
        return description;
    }
}

16.謹慎String.split(String regex)方法
字符串 String 的 split 方法，傳入的分隔字符串是正則表達式！部分關鍵字（比如.| 等）需要轉義。

錯誤實例：

"a.ab.abc".split("."); // 結果爲[]
"a|ab|abc".split("|"); // 結果爲["a", "|", "a", "b", "|", "a", "b", "c"]

正確實例：

"a.ab.abc".split("\\."); // 結果爲["a", "ab", "abc"]
"a|ab|abc".split("\\|"); // 結果爲["a", "ab", "abc"]