【STM32F407開發板使用者手冊】第15章 STM32F407的GPIO基礎知識(重要)
1. 需要 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(); ... }
2. 應該使用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()
4. 集合初始化儘量指定大小
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); }
5. 字串拼接使用 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 }
6. List 的隨機訪問
大家都知道陣列和連結串列的區別:陣列的隨機訪問效率更高。當呼叫方法獲取到 List 後,如果想隨機訪問其中的資料,並不知道該陣列內部實現是連結串列還是陣列,怎麼辦呢?可以判斷它是否實現* RandomAccess *介面。
正例: // 呼叫別人的服務獲取到list List<Integer> list = otherService.getList(); if (list instanceof RandomAccess) { // 內部陣列實現,可以隨機訪問 System.out.println(list.get(list.size() - 1)); } else { // 內部可能是連結串列實現,隨機訪問效率低 }
7. 頻繁呼叫 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); }
8. 長整型常量後新增大寫 L
在使用長整型常量值時,後面需要新增 L ,必須是大寫的 L ,不能是小寫的 l ,小寫 l 容易跟數字 1 混淆而造成誤解。
反例: long value = 1l; long max = Math.max(1L, 5); 正例: long value = 1L; long max = Math.max(1L, 5L);
9. 不要使用魔法值
當你編寫一段程式碼時,使用魔法值可能看起來很明確,但在除錯時它們卻不顯得那麼明確了。這就是為什麼需要把魔法值定義為可讀取常量的原因。但是,-1、0 和 1不被視為魔法值。
反例: for (int i = 0; i < 100; i++){ ... } if (a == 100) { ... } 正例: private static final int MAX_COUNT = 100; for (int i = 0; i < MAX_COUNT; i++){ ... } if (count == MAX_COUNT) { ... }
10. 不要使用集合實現來賦值靜態成員變數
對於集合型別的靜態成員變數,不要使用集合實現來賦值,應該使用靜態程式碼塊賦值。
反例: private static Map<String, Integer> map = new HashMap<String, Integer>() { { put("a", 1); put("b", 2); } }; private static List<String> list = new ArrayList<String>() { { add("a"); add("b"); } }; 正例: 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"); };
11. 建議使用 try-with-resources 語句
Java 7 中引入了 try-with-resources 語句,該語句能保證將相關資源關閉,優於原來的 try-catch-finally 語句,並且使程式程式碼更安全更簡潔。
反例: private void handle(String fileName) { BufferedReader reader = null; try { String line; reader = new BufferedReader(new FileReader(fileName)); while ((line = reader.readLine()) != null) { ... } } catch (Exception e) { ... } finally { if (reader != null) { try { reader.close(); } catch (IOException e) { ... } } } } 正例: private void handle(String fileName) { try (BufferedReader reader = new BufferedReader(new FileReader(fileName))) { String line; while ((line = reader.readLine()) != null) { ... } } catch (Exception e) { ... } }
12. 刪除未使用的私有方法和欄位
刪除未使用的私有方法和欄位,使程式碼更簡潔更易維護。若有需要再使用,可以從歷史提交中找回。
反例: 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; } }
13. 刪除未使用的區域性變數
刪除未使用的區域性變數,使程式碼更簡潔更易維護。
反例: public int sum(int a, int b) { int c = 100; return a + b; } 正例: public int sum(int a, int b) { return a + b; }
14. 刪除未使用的方法引數
未使用的方法引數具有誤導性,刪除未使用的方法引數,使程式碼更簡潔更易維護。但是,由於重寫方法是基於父類或介面的方法定義,即便有未使用的方法引數,也是不能刪除的。
反例: public int sum(int a, int b, int c) { return a + b; } 正例: public int sum(int a, int b) { return a + b; }
15. 刪除表示式的多餘括號
對應表示式中的多餘括號,有人認為有助於程式碼閱讀,也有人認為完全沒有必要。對於一個熟悉 Java 語法的人來說,表示式中的多餘括號反而會讓程式碼顯得更繁瑣。
反例: return (x); return (x + 2); int x = (y * 3) + 1; int m = (n * 4 + 2); 正例: return x; return x + 2; int x = y * 3 + 1; int m = n * 4 + 2;
16. 工具類應該遮蔽建構函式
工具類是一堆靜態欄位和函式的集合,不應該被例項化。但是,Java 為每個沒有明確定義建構函式的類添加了一個隱式公有建構函式。所以,為了避免 java "小白"使用有誤,應該顯式定義私有建構函式來遮蔽這個隱式公有建構函式。
反例: public class MathUtils { public static final double PI = 3.1415926D; public static int sum(int a, int b) { return a + b; } } 正例: public class MathUtils { public static final double PI = 3.1415926D; private MathUtils() {} public static int sum(int a, int b) { return a + b; } }
17. 刪除多餘的異常捕獲並丟擲
用 catch 語句捕獲異常後,什麼也不進行處理,就讓異常重新丟擲,這跟不捕獲異常的效果一樣,可以刪除這塊程式碼或新增別的處理。
反例: private static String readFile(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 readFile(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(); } }
18. 公有靜態常量應該通過類訪問
雖然通過類的例項訪問公有靜態常量是允許的,但是容易讓人它誤認為每個類的例項都有一個公有靜態常量。所以,公有靜態常量應該直接通過類訪問。
反例: public class User { public static final String CONST_NAME = "name"; ... } User user = new User(); String nameKey = user.CONST_NAME; 正例: public class User { public static final String CONST_NAME = "name"; ... } String nameKey = User.CONST_NAME;
19. 不要用NullPointerException判斷空
空指標異常應該用程式碼規避(比如檢測不為空),而不是用捕獲異常的方式處理。
反例: public String getUserName(User user) { try { return user.getName(); } catch (NullPointerException e) { return null; } } 正例: public String getUserName(User user) { if (Objects.isNull(user)) { return null; } return user.getName(); }
20. 使用String.valueOf(value)代替""+value
當要把其它物件或型別轉化為字串時,使用 String.valueOf(value) 比""+value 的效率更高。
反例: int i = 1; String s = "" + i; 正例: int i = 1; String s = String.valueOf(i);
21. 過時程式碼新增 @Deprecated 註解
當一段程式碼過時,但為了相容又無法直接刪除,不希望以後有人再使用它時,可以新增 @Deprecated 註解進行標記。在文件註釋中新增 @deprecated 來進行解釋,並提供可替代方案
正例: /** * 儲存 * * @deprecated 此方法效率較低,請使用{@link newSave()}方法替換它 */ @Deprecated public void save(){ // do something }
22.禁止使用構造方法 BigDecimal(double)
BigDecimal(double) 存在精度損失風險,在精確計算或值比較的場景中可能會導致業務邏輯異常。
反例: BigDecimal value = new BigDecimal(0.1D); // 0.100000000000000005551115... 正例: BigDecimal value = BigDecimal.valueOf(0.1D);; // 0.1
23. 返回空陣列和空集合而不是 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) { ... } }
24. 優先使用常量或確定值來呼叫 equals 方法
物件的 equals 方法容易拋空指標異常,應使用常量或確定有值的物件來呼叫 equals 方法。當然,使用 java.util.Objects.equals() 方法是最佳實踐。
反例: public void isFinished(OrderStatus status) { return status.equals(OrderStatus.FINISHED); // 可能拋空指標異常 } 正例: public void isFinished(OrderStatus status) { return OrderStatus.FINISHED.equals(status); } public void isFinished(OrderStatus status) { return Objects.equals(status, OrderStatus.FINISHED); }
25. 列舉的屬性欄位必須是私有不可變
列舉通常被當做常量使用,如果列舉中存在公共屬性欄位或設定欄位方法,那麼這些列舉常量的屬性很容易被修改。理想情況下,列舉中的屬性欄位是私有的,並在私有建構函式中賦值,沒有對應的 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; } }
26. 小心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"]
這篇文章,可以說是從事 Java 開發的經驗總結,分享出來以供大家參考。希望能幫大家避免踩坑,讓程式碼更加高效優雅。
來源: 程式設計師DD, 程式設計師小灰, macrozheng