如何更規範化編寫 Java 程式碼
- 2019 年 10 月 8 日
- 筆記
Many of the happiest people are those who own the least. But are we really so happy with our IPhones, our big houses, our fancy cars?
忘川如斯，擁有一切的人才更怕失去。
背景
如何更規範化編寫 Java 程式碼的重要性想必毋需多言，其中最重要的幾點當屬提高程式碼性能、使程式碼遠離 Bug、令程式碼更優雅。
一、MyBatis 不要為了多個查詢條件而寫 1 = 1
當遇到多個查詢條件，使用 where 1=1 可以很方便的解決我們的問題，但是這樣很可能會造成非常大的性能損失，因為添加了 「where 1=1」 的過濾條件之後，資料庫系統就無法使用索引等查詢優化策略，資料庫系統將會被迫對每行數據進行掃描（即全表掃描） 以比較此行是否滿足過濾條件，當表中的數據量較大時查詢速度會非常慢；此外，還會存在 SQL 注入的風險。
反例：
<select parameterType="com.tjt.platform.entity.BookInfo" resultType="java.lang.Integer"> select count(*) from t_rule_BookInfo t where 1=1 <if test="title !=null and title !='' "> AND title = #{title} </if> <if test="author !=null and author !='' "> AND author = #{author} </if> </select>正例：
<select parameterType="com.tjt.platform.entity.BookInfo" resultType="java.lang.Integer"> select count(*) from t_rule_BookInfo t <where> <if test="title !=null and title !='' "> title = #{title} </if> <if test="author !=null and author !='' "> AND author = #{author} </if> </where> </select>UPDATE 操作也一樣，可以用 <set> 標記代替 1=1。
二、 迭代 entrySet() 獲取 Map 的 key 和 value
當循環中只需要獲取 Map 的主鍵 key 時，迭代 keySet() 是正確的；但是，當需要主鍵 key 和取值 value 時，迭代 entrySet() 才是更高效的做法，其比先迭代 keySet() 後再去通過 get 取值性能更佳。
反例：
//Map 獲取value 反例: HashMap<String, String> map = new HashMap<>(); for (String key : map.keySet()){ String value = map.get(key); }正例：
//Map 獲取key & value 正例: HashMap<String, String> map = new HashMap<>(); for (Map.Entry<String,String> entry : map.entrySet()){ String key = entry.getKey(); String value = entry.getValue(); }正是金九銀十跳槽季，為大家收集了2019年最新的面試資料，有文檔、有攻略、有影片。有需要的同學可以在公眾號【Java知己】，發送【面試】領取最新面試資料攻略！暗號【1024】千萬不要發，否則.....
三、使用Collection.isEmpty() 檢測空
使用 Collection.size() 來檢測是否為空在邏輯上沒有問題，但是使用 Collection.isEmpty() 使得程式碼更易讀，並且可以獲得更好的性能；除此之外，任何 Collection.isEmpty() 實現的時間複雜度都是 O(1) ，不需要多次循環遍歷，但是某些通過 Collection.size() 方法實現的時間複雜度可能是 O(n)。O(1) 緯度減少循環次數 例子
反例：
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."); } //檢測是否為null 可以使用CollectionUtils.isEmpty() if (CollectionUtils.isEmpty(collection)){ System.out.println("collection is null."); }四、初始化集合時盡量指定其大小
盡量在初始化時指定集合的大小，能有效減少集合的擴容次數，因為集合每次擴容的時間複雜度很可能時 O(n)，耗費時間和性能。
反例：
//初始化list，往list 中添加元素反例： int[] arr = new int[]{1,2,3,4}; List<Integer> list = new ArrayList<>(); for (int i : arr){ list.add(i); }正例：
//初始化list，往list 中添加元素正例： int[] arr = new int[]{1,2,3,4}; //指定集合list 的容量大小 List<Integer> list = new ArrayList<>(arr.length); for (int i : arr){ list.add(i); }五、使用 StringBuilder 拼接字元串
一般的字元串拼接在編譯期 Java 會對其進行優化，但是在循環中字元串的拼接 Java 編譯期無法執行優化，所以需要使用 StringBuilder 進行替換。
反例：
//在循環中拼接字元串反例 String str = ""; for (int i = 0; i < 10; i++){ //在循環中字元串拼接Java 不會對其進行優化 str += i; }正例：
//在循環中拼接字元串正例 String str1 = "Love"; String str2 = "Courage"; //Java 編譯器會對該普通模式的字元串拼接進行優化 String strConcat = str1 + str2; StringBuilder sb = new StringBuilder(); for (int i = 0; i < 10; i++){ //在循環中，Java 編譯器無法進行優化，所以要手動使用StringBuilder sb.append(i); }### 六、若需頻繁調用 Collection.contains 方法則使用 Set
在 Java 集合類庫中，List 的 contains 方法普遍時間複雜度為 O(n)，若程式碼中需要頻繁調用 contains 方法查找數據則先將集合 list 轉換成 HashSet 實現，將 O(n) 的時間複雜度將為 O(1)。
反例：
//頻繁調用Collection.contains() 反例 List<Object> list = new ArrayList<>(); for (int i = 0; i <= Integer.MAX_VALUE; i++){ //時間複雜度為O(n) if (list.contains(i)) System.out.println("list contains "+ i); }正例：
//頻繁調用Collection.contains() 正例 List<Object> list = new ArrayList<>(); Set<Object> set = new HashSet<>(); for (int i = 0; i <= Integer.MAX_VALUE; i++){ //時間複雜度為O(1) if (set.contains(i)){ System.out.println("list contains "+ 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 List<String> list = new ArrayList<>(){ { list.add("Sagittarius"); list.add("Charming"); list.add("Perfectionist"); } };正例：
//賦值靜態成員變數正例 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); } private static List<String> list = new ArrayList<>(); static { list.add("Sagittarius"); list.add("Charming"); list.add("Perfectionist"); }八、刪除未使用的局部變數、方法參數、私有方法、欄位和多餘的括弧
九、工具類中屏蔽構造函數
工具類是一堆靜態欄位和函數的集合，其不應該被實例化；但是，Java 為每個沒有明確定義構造函數的類添加了一個隱式公有構造函數，為了避免不必要的實例化，應該顯式定義私有構造函數來屏蔽這個隱式公有構造函數。
反例：
public class PasswordUtils { //工具類構造函數反例 private static final Logger LOG = LoggerFactory.getLogger(PasswordUtils.class); public static final String DEFAULT_CRYPT_ALGO = "PBEWithMD5AndDES"; public static String encryptPassword(String aPassword) throws IOException { return new PasswordUtils(aPassword).encrypt(); }正例：
public class PasswordUtils { //工具類構造函數正例 private static final Logger LOG = LoggerFactory.getLogger(PasswordUtils.class); //定義私有構造函數來屏蔽這個隱式公有構造函數 private PasswordUtils(){} public static final String DEFAULT_CRYPT_ALGO = "PBEWithMD5AndDES"; public static String encryptPassword(String aPassword) throws IOException { return new PasswordUtils(aPassword).encrypt(); }十、刪除多餘的異常捕獲並跑出
用 catch 語句捕獲異常後，若什麼也不進行處理，就只是讓異常重新拋出，這跟不捕獲異常的效果一樣，可以刪除這塊程式碼或添加別的處理。
反例：
//多餘異常反例 private static String fileReader(String fileName)throws IOException{ try (BufferedReader reader = new BufferedReader(new FileReader(fileName))) { String line; StringBuilder builder = new StringBuilder(); while ((line = reader.readLine()) != null) { builder.append(line); } return builder.toString(); } catch (Exception e) { //僅僅是重複拋異常 未作任何處理 throw e; } }正例：
//多餘異常正例 private static String fileReader(String fileName)throws IOException{ try (BufferedReader reader = new BufferedReader(new FileReader(fileName))) { String line; StringBuilder builder = new StringBuilder(); while ((line = reader.readLine()) != null) { builder.append(line); } return builder.toString(); //刪除多餘的拋異常，或增加其他處理： /*catch (Exception e) { return "fileReader exception"; }*/ } }十一、字元串轉化使用 String.valueOf(value) 代替 " " + value
把其它對象或類型轉化為字元串時，使用 String.valueOf(value) 比 ""+value 的效率更高。
反例：
//把其它對象或類型轉化為字元串反例： int num = 520; // "" + value String strLove = "" + num;
正例：
//把其它對象或類型轉化為字元串正例： int num = 520; // String.valueOf() 效率更高 String strLove = String.valueOf(num);
十二、避免使用 BigDecimal(double)
BigDecimal(double) 存在精度損失風險，在精確計算或值比較的場景中可能會導致業務邏輯異常。
反例：
// BigDecimal 反例 BigDecimal bigDecimal = new BigDecimal(0.11D);
正例：
// BigDecimal 正例 BigDecimal bigDecimal1 = bigDecimal.valueOf(0.11D);
十三、返回空數組和集合而非 null
若程式運行返回 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 Result[] getResults() { return new Result[0]; } public static List<Result> getResultList() { return Collections.emptyList(); } public static Map<String, Result> getResultMap() { return Collections.emptyMap(); }十四、優先使用常量或確定值調用 equals 方法
對象的 equals 方法容易拋空指針異常，應使用常量或確定有值的對象來調用 equals 方法。
反例：
//調用 equals 方法反例 private static boolean fileReader(String fileName)throws IOException{ // 可能拋空指針異常 return fileName.equals("Charming"); }正例：
//調用 equals 方法正例 private static boolean fileReader(String fileName)throws IOException{ // 使用常量或確定有值的對象來調用 equals 方法 return "Charming".equals(fileName); //或使用： java.util.Objects.equals() 方法 return Objects.equals("Charming",fileName); }十五、枚舉的屬性欄位必須是私有且不可變
枚舉通常被當做常量使用，如果枚舉中存在公共屬性欄位或設置欄位方法，那麼這些枚舉常量的屬性很容易被修改；理想情況下，枚舉中的屬性欄位是私有的，並在私有構造函數中賦值，沒有對應的 Setter 方法，最好加上 final 修飾符。
反例：
public enum SwitchStatus { // 枚舉的屬性欄位反例 DISABLED(0, "禁用"), ENABLED(1, "啟用"); public int value; private String description; private SwitchStatus(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 SwitchStatus { // 枚舉的屬性欄位正例 DISABLED(0, "禁用"), ENABLED(1, "啟用"); // final 修飾 private final int value; private final String description; private SwitchStatus(int value, String description) { this.value = value; this.description = description; } // 沒有Setter 方法 public int getValue() { return value; } public String getDescription() { return description; } }十六、tring.split(String regex) 部分關鍵字需要轉譯
使用字元串 String 的 plit 方法時，傳入的分隔字元串是正則表達式，則部分關鍵字（比如 .| 等）需要轉義。
反例：
// String.split(String regex) 反例 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.split(String regex) 正例 // . 需要轉譯 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"]「不積跬步，無以至千里」，希望未來的你能：有夢為馬 隨處可棲！加油，少年！ 「不積跬步，無以至千里」，希望未來的你能：有夢為馬 隨處可棲！加油，少年！