Java開發優質代碼養成

目錄

集合容器Collection

迭代entrySet()

使用Collection.isEmpty() 檢測空

初始化集合時儘量指定其大小

使用靜態代碼塊賦值靜態成員變量

頻繁調用Collection.contains

toArray

字符串

使用StringBuilder拼接字符串

工具類中屏蔽構造函數

避免 " " + value

String.split(String regex)部分符號轉義

類與對象

equals

避免使用BigDecimal(double)

枚舉字段

返回非null

優先使用常量equals

---

集合容器Collection

迭代entrySet()

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

反例：

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

正例：

HashMap<String, String> map = new HashMap<>();
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)

反例：

LinkedList<Object> collection = new LinkedList<>();
if (collection.size() == 0) {
    System.out.println("collection is empty.");
}

正例：

LinkedList<Object> collection = new LinkedList<>();
if (collection.isEmpty()) {
    System.out.println("collection is empty.");
}

if (CollectionUtils.isEmpty(collection)) {
    System.out.println("collection is null.");
}

初始化集合時儘量指定其大小

儘量在初始化時指定集合的大小，能有效減少集合的擴容次數，因爲集合每次擴容的時間複雜度很可能時O(n)，耗費時間和性能。

反例：

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

正例：

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

使用靜態代碼塊賦值靜態成員變量

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

反例：

private static Map<String, Integer> map = new HashMap<String, Integer>() {
    {
        map.put("Leo", 1);
        map.put("Family-loving", 2);
        map.put("Cold on the out side passionate on the inside", 3);
    }
};

正例：

private static Map<String, Integer> map = new HashMap<String, Integer>();
static {
    map.put("Leo", 1);
    map.put("Family-loving", 2);
    map.put("Cold on the out side passionate on the inside", 3);
}

頻繁調用Collection.contains

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

反例：

List<Object> list = new ArrayList<>();
for (int i = 0; i <= Integer.MAX_VALUE; i++) {
    if (list.contains(i))
        System.out.println("list contains " + i);
}

正例:

List<Object> list = new ArrayList<>();
Set<Object> set = new HashSet<>();
for (int i = 0; i <= Integer.MAX_VALUE; i++) {
    if (set.contains(i)) {
        System.out.println("list contains " + i);
    }
}

toArray

使用集合轉數組的方法，必須使用集合的toArray(T[] array)，傳入的是類型完全一樣的數組，大小就是list.size()。

反例：

List<String> list = new ArrayList<String>(2);
list.add("我是");
list.add("好人");
String[] strings = new String[2];
strings = list.toArray();

正例：

List<String> list = new ArrayList<String>(2);
list.add("我是");
list.add("好人");
String[] strings = new String[2];
strings = list.toArray(strings);

 

字符串

使用StringBuilder拼接字符串

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

反例：

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

正例：

StringBuilder sb = new StringBuilder();
for (int i = 0; i < 10; i++) {
    sb.append(i);
}

工具類中屏蔽構造函數

工具類是一堆靜態字段和函數的集合，其不應該被實例化；但是，Java 類有隱藏的無參構造，爲了避免不必要的實例化，應該顯式定義私有構造函數來屏蔽這個隱式公有構造函數。

避免 " " + value

把其它對象或類型轉化爲字符串時，使用String.valueOf(value) 比 ""+value 的效率更高。

反例：

int num = 520;
String strLove = "" + num;

正例：

int num = 520;
String strLove = String.valueOf(num);

String.split(String regex)部分符號轉義

使用字符串String 的plit 方法時，傳入的分隔字符串是正則表達式，則部分關鍵字（比如 .[]()| 等）需要轉義。

反例：

String[] split = "a.ab.abc".split(".");
System.out.println(Arrays.toString(split));   // 結果爲[]

String[] split1 = "a|ab|abc".split("|");
System.out.println(Arrays.toString(split1));  // 結果爲["a", "|", "a", "b", "|", "a", "b", "c"]

正例：

String[] split2 = "a.ab.abc".split("\\.");
System.out.println(Arrays.toString(split2));  // 結果爲["a", "ab", "abc"]

String[] split3 = "a|ab|abc".split("\\|");
System.out.println(Arrays.toString(split3));  // 結果爲["a", "ab", "abc"]

 

類與對象

equals

所有的相同類型的包裝類對象之間值的比較，全部使用equals方法比較。例如在-128至127範圍內的賦值，Integer對象是在IntegerCache.cache產生，可以用==比較，超出範圍就是堆上產生，只能用equals方法

避免使用BigDecimal(double)

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

反例：

// BigDecimal 反例    
BigDecimal bigDecimal = new BigDecimal(0.11D);

正例：

// BigDecimal 正例
BigDecimal bigDecimal1 = bigDecimal.valueOf(0.11D);

 

枚舉字段

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

反例：

public enum ProdType {

    public int value;

    private SwitchStatus(int value) {
        this.value = value;
    }

    public String getValue() {
        return value;
    }

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

正例：

public enum ProdType {

    public final int value;

    private SwitchStatus(int value) {
        this.value = value;
    }

    public String getValue() {
        return value;
    }
}

返回非null

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

優先使用常量equals

對象的equals 方法容易拋空指針異常，應使用常量或確定有值的對象來調用equals 方法。

反例：

//調用equals方法反例
private static boolean fileReader(String fileName)throws IOException{

    //可能拋空指針異常
    return fileName.equals("我是好人");
}

正例：

//調用 equals 方法正例
private static boolean fileReader(String fileName)throws IOException{

    // 使用常量或確定有值的對象來調用 equals 方法
    return "我是好人".equals(fileName);

    //或使用：java.util.Objects.equals() 方法
   return Objects.equals("我是好人",fileName);
}