java開發規範-筆記

收集日常java開發規範

參考：
https://blog.csdn.net/csdnnews/article/details/100987866
阿里java開發規範

1.基礎篇

1. if else 不管執行語句是不是隻有一條，都需要加上大括號，提高可讀性；
2. 包裝類比較需要用 equals，而不是直接 == ；如Integer；
3. 所有覆寫的方法，必須加 @Override註解；
4. Object的equals方法，應使用常量或者確定有值的對象來調用equals;
5. SimpleDateFormatUtil 是線程不安全的類，如果定義爲static變量，則需要加鎖，或者使用DateUtils工具類；
6. 常量的命名應全部大寫並以下劃線分隔；
7. 方法名，參數名，成員變量，局部變量都應該統一使用lowerCameCase,必須遵從駝峯形式；類名則使用UpperCamelCase風格；
8. 不允許任何魔法值（即未經定義的常量）直接出現在代碼中；
9. 包名統一使用小寫；
10. 單個方法的總行數不超過80行；
11. 及時清理不再使用的代碼段或配置信息；
12. 所有抽象方法（包括接口中的方法）必須要用javadoc註釋，除了返回值、參數、異常說明外，還必須指出該方法做什麼事情，實現什麼功能；
13. 所有類都必須添加創建者信息 @author註釋；
14. 不要在判斷中執行復雜語句，將複雜邏輯判斷賦值給一個有意義的布爾變量，以提高可讀性；

2.性能篇

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

反例：

Map<String, String> map = ...;
for (String key : map.keySet()) {
    String value = map.get(key);
    ...
}

正例：

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

應該使用Collection.isEmpty()檢測空

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

反例：

if (collection.size() == 0) {
    ...
}

正例：

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

如果需要還需要檢測 null ，可採用CollectionUtils.isEmpty(collection)和CollectionUtils.isNotEmpty(collection)。

不要把集合對象傳給自己
此外，由於某些方法要求參數在執行期間保持不變，因此將集合傳遞給自身可能會導致異常行爲。

反例：

List<String> list = new ArrayList<>();
list.add("Hello");
list.add("World");
if (list.containsAll(list)) { // 無意義,總是返回true
    ...
}

list.removeAll(list); // 性能差, 直接使用clear()

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

反例：

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

正例：

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

字符串拼接使用 StringBuilder

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

反例：

String s = "";
for (int i = 0; i < 10; i++) {
    s += i;
}

正例：

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
}

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

正例：

// 調用別人的服務獲取到list

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

頻繁調用 Collection.contains 方法請使用 Set

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

反例：

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

正例：

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

BigDecimal(double) 存在精度損失風險，在精確計算或值比較的場景中可能會導致業務邏輯異常。

反例：

BigDecimal value = new BigDecimal(0.1D); // 0.100000000000000005551115...

正例：

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

返回空數組和空集合而不是 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) {
        ...
    }
}