如何更規範化編寫Java 代碼

来源:https://www.cnblogs.com/taojietaoge/archive/2019/09/26/11575376.html
-Advertisement-
Play Games

如何更規範化編寫Java 代碼 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 代碼

 

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 id="queryBookInfo" 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 id="queryBookInfo" 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 取值性能更佳。

反例：

1 //Map 獲取value 反例:
2         HashMap<String, String> map = new HashMap<>();
3         for (String key : map.keySet()){
4             String value = map.get(key);
5         }

正例：

1  //Map 獲取key & value 正例:
2         HashMap<String, String> map = new HashMap<>();
3         for (Map.Entry<String,String> entry : map.entrySet()){
4             String key = entry.getKey();
5             String value = entry.getValue();
6         }

三、使用Collection.isEmpty() 檢測空

      使用Collection.size() 來檢測是否為空在邏輯上沒有問題，但是使用Collection.isEmpty() 使得代碼更易讀，並且可以獲得更好的性能；除此之外，任何Collection.isEmpty() 實現的時間複雜度都是O(1) ，不需要多次迴圈遍歷，但是某些通過Collection.size() 方法實現的時間複雜度可能是O(n)。O(1)緯度減少迴圈次數 例子

反例：

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

正例：

 1  LinkedList<Object> collection = new LinkedList<>();
 2         if (collection.isEmpty()){
 3             System.out.println("collection is empty.");
 4         }
 5         
 6         //檢測是否為null 可以使用CollectionUtils.isEmpty()
 7         if (CollectionUtils.isEmpty(collection)){
 8             System.out.println("collection is null.");
 9 
10         }

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

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

反例：

1 //初始化list，往list 中添加元素反例：
2         int[] arr = new int[]{1,2,3,4};
3         List<Integer> list = new ArrayList<>();
4         for (int i : arr){
5             list.add(i);
6         }

正例：

1  //初始化list，往list 中添加元素正例：
2         int[] arr = new int[]{1,2,3,4};
3         //指定集合list 的容量大小
4         List<Integer> list = new ArrayList<>(arr.length);
5         for (int i : arr){
6             list.add(i);
7         }

五、使用StringBuilder 拼接字元串

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

反例：

1  //在迴圈中拼接字元串反例
2        String str = "";
3        for (int i = 0; i < 10; i++){
4            //在迴圈中字元串拼接Java 不會對其進行優化
5            str += i;
6        }

正例：

1   //在迴圈中拼接字元串正例
2        String str1 = "Love";
3        String str2 = "Courage";
4        String strConcat = str1 + str2;  //Java 編譯器會對該普通模式的字元串拼接進行優化
5         StringBuilder sb = new StringBuilder();
6         for (int i = 0; i < 10; i++){
7            //在迴圈中，Java 編譯器無法進行優化，所以要手動使用StringBuilder
8             sb.append(i);
9         }

 六、若需頻繁調用Collection.contains 方法則使用Set

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

反例：

1 //頻繁調用Collection.contains() 反例
2         List<Object> list = new ArrayList<>();
3         for (int i = 0; i <= Integer.MAX_VALUE; i++){
4             //時間複雜度為O(n)
5             if (list.contains(i))
6             System.out.println("list contains "+ i);
7         }

正例：

1 //頻繁調用Collection.contains() 正例
2         List<Object> list = new ArrayList<>();
3         Set<Object> set = new HashSet<>();
4         for (int i = 0; i <= Integer.MAX_VALUE; i++){
5             //時間複雜度為O(1)
6             if (set.contains(i)){
7                 System.out.println("list contains "+ i);
8             }
9         }

七、使用靜態代碼塊實現賦值靜態成員變數

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

反例：

 1 //賦值靜態成員變數反例
 2     private static Map<String, Integer> map = new HashMap<String, Integer>(){
 3         {
 4             map.put("Leo",1);
 5             map.put("Family-loving",2);
 6             map.put("Cold on the out side passionate on the inside",3);
 7         }
 8     };
 9     private static List<String> list = new ArrayList<>(){
10         {
11             list.add("Sagittarius");
12             list.add("Charming");
13             list.add("Perfectionist");
14         }
15     };

正例：

 1  //賦值靜態成員變數正例
 2     private static Map<String, Integer> map = new HashMap<String, Integer>();
 3         static {
 4             map.put("Leo",1);
 5             map.put("Family-loving",2);
 6             map.put("Cold on the out side passionate on the inside",3);
 7         }
 8         
 9     private static List<String> list = new ArrayList<>();
10         static {
11             list.add("Sagittarius");
12             list.add("Charming");
13             list.add("Perfectionist");
14         }

八、刪除未使用的局部變數、方法參數、私有方法、欄位和多餘的括弧。

九、工具類中屏蔽構造函數

      工具類是一堆靜態欄位和函數的集合，其不應該被實例化；但是，Java 為每個沒有明確定義構造函數的類添加了一個隱式公有構造函數，為了避免不必要的實例化，應該顯式定義私有構造函數來屏蔽這個隱式公有構造函數。

反例：

1 public class PasswordUtils {
2     //工具類構造函數反例
3     private static final Logger LOG = LoggerFactory.getLogger(PasswordUtils.class);
4 
5     public static final String DEFAULT_CRYPT_ALGO = "PBEWithMD5AndDES";
6 
7     public static String encryptPassword(String aPassword) throws IOException {
8         return new PasswordUtils(aPassword).encrypt();
9     }

正例：

 1 public class PasswordUtils {
 2     //工具類構造函數正例
 3     private static final Logger LOG = LoggerFactory.getLogger(PasswordUtils.class);
 4 
 5     //定義私有構造函數來屏蔽這個隱式公有構造函數
 6     private PasswordUtils(){}
 7     
 8     public static final String DEFAULT_CRYPT_ALGO = "PBEWithMD5AndDES";
 9 
10     public static String encryptPassword(String aPassword) throws IOException {
11         return new PasswordUtils(aPassword).encrypt();
12     }

十、刪除多餘的異常捕獲並跑出

      用catch 語句捕獲異常後，若什麼也不進行處理，就只是讓異常重新拋出，這跟不捕獲異常的效果一樣，可以刪除這塊代碼或添加別的處理。

反例：

 1 //多餘異常反例
 2     private static String fileReader(String fileName)throws IOException{
 3 
 4         try (BufferedReader reader = new BufferedReader(new FileReader(fileName))) {
 5             String line;
 6             StringBuilder builder = new StringBuilder();
 7             while ((line = reader.readLine()) != null) {
 8                 builder.append(line);
 9             }
10             return builder.toString();
11         } catch (Exception e) {
12             //僅僅是重覆拋異常 未作任何處理
13             throw e;
14         }
15     }

正例：

 1 //多餘異常正例
 2     private static String fileReader(String fileName)throws IOException{
 3 
 4         try (BufferedReader reader = new BufferedReader(new FileReader(fileName))) {
 5             String line;
 6             StringBuilder builder = new StringBuilder();
 7             while ((line = reader.readLine()) != null) {
 8                 builder.append(line);
 9             }
10             return builder.toString();
11             //刪除多餘的拋異常，或增加其他處理：
12             /*catch (Exception e) {
13                 return "fileReader exception";
14             }*/
15         }
16     }

十一、字元串轉化使用String.valueOf(value) 代替 " " + value

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

反例：

1 //把其它對象或類型轉化為字元串反例：
2             int num = 520;
3             // "" + value
4             String strLove = "" + num;

正例：

1 //把其它對象或類型轉化為字元串正例：
2             int num = 520;
3             // String.valueOf() 效率更高
4             String strLove = String.valueOf(num);

十二、避免使用BigDecimal(double)

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

反例：

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

正例：

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

圖1. BigDecimal 精度丟失

十三、返回空數組和集合而非 null

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

反例：

 1  //返回null 反例
 2     public static Result[] getResults() {
 3         return null;
 4     }
 5 
 6     public static List<Result> getResultList() {
 7         return null;
 8     }
 9 
10     public static Map<String, Result> getResultMap() {
11         return null;
12     }

正例：

 1  //返回空數組和空集正例
 2     public static Result[] getResults() {
 3         return new Result[0];
 4     }
 5 
 6     public static List<Result> getResultList() {
 7         return Collections.emptyList();
 8     }
 9 
10     public static Map<String, Result> getResultMap() {
11         return Collections.emptyMap();
12     }

十四、優先使用常量或確定值調用equals 方法

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

反例：

1 //調用 equals 方法反例
2     private static boolean fileReader(String fileName)throws IOException{
3 
4         // 可能拋空指針異常
5         return fileName.equals("Charming");
6  }

正例：

1 //調用 equals 方法正例
2     private static boolean fileReader(String fileName)throws IOException{
3 
4         // 使用常量或確定有值的對象來調用 equals 方法
5         return "Charming".equals(fileName);
6         
7         //或使用： java.util.Objects.equals() 方法
8        return Objects.equals("Charming",fileName);
9  }

十五、枚舉的屬性欄位必須是私有且不可變

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

反例：

 1 public enum SwitchStatus {
 2     // 枚舉的屬性欄位反例
 3     DISABLED(0, "禁用"),
 4     ENABLED(1, "啟用");
 5 
 6     public int value;
 7     private String description;
 8 
 9     private SwitchStatus(int value, String description) {
10         this.value = value;
11         this.description = description;
12     }
13 
14     public String getDescription() {
15         return description;
16     }
17 
18     public void setDescription(String description) {
19         this.description = description;
20     }
21 }

正例：

 1 public enum SwitchStatus {
 2     // 枚舉的屬性欄位正例
 3     DISABLED(0, "禁用"),
 4     ENABLED(1, "啟用");
 5 
 6     // final 修飾
 7     private final int value;
 8     private final String description;
 9 
10     private SwitchStatus(int value, String description) {
11         this.value = value;
12         this.description = description;
13     }
14 
15     // 沒有Setter 方法
16     public int getValue() {
17         return value;
18     }
19 
20     public String getDescription() {
21         return description;
22     }
23 }

十六、tring.split(String regex)部分關鍵字需要轉譯

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

反例：

1 // String.split(String regex) 反例
2         String[] split = "a.ab.abc".split(".");
3         System.out.println(Arrays.toString(split));   // 結果為[]
4 
5         String[] split1 = "a|ab|abc".split("|");
6         System.out.println(Arrays.toString(split1));  // 結果為["a", "|", "a", "b", "|", "a", "b", "c"]

正例：

1  // String.split(String regex) 正例
2         // . 需要轉譯
3         String[] split2 = "a.ab.abc".split("\\.");
4         System.out.println(Arrays.toString(split2));  // 結果為["a", "ab", "abc"]
5 
6         // | 需要轉譯
7         String[] split3 = "a|ab|abc".split("\\|");
8         System.out.println(Arrays.toString(split3));  // 結果為["a", "ab", "abc"]

圖2. String.split(String regex) 正反例

 

 

擁有一切的人才更怕失去

 

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 括弧匹配（c語言實現）
    " ⭐ 我的網站: www.mengyingjie.com ⭐ " 1要求 編寫程式檢查該字元串的括弧是否成對出現，而且不能交叉出現。 輸入： 一個字元串，裡邊可能包含“()”、"{}"、“[]”三種括弧，“ ”結束 輸出： 成功：代表括弧成對出現並且嵌套正確 失敗：未正確使用括弧字元。 2分析 用 ...
  • 嚴蔚敏數據結構源碼及習題解析
    " ⭐ 我的網站: www.mengyingjie.com ⭐ " 嚴蔚敏數據結構源碼及習題解析 習題解析未更新完整，以後更新 內容已上傳到github,歡迎star和fork： "https://github.com/MengYingjie/YanWeimin DataStructure Sour ...
  • ZOJ 1095. Humble Numbers
    如果一個數的所有質數因數都來自於 { 2, 3, 5, 7 } 這個集合，就把這個數字叫做“謙虛數”（Humber Number），現在給出一個數字 i （1 <= i <= 5842），要求輸出第 i 個 humber number。 ...
  • Hive sampling 語法之TABLESAMPLE用法理解
    官網關於 "LanguageManual Sampling" 的教程，部分截圖如下，這裡主要分享對TABLESAMPLE(BUCKET 3 OUT OF 16 ON id)子句的理解 ​ 官網中假設創建表時設置了 即分成了32個文件（雖然這裡用的是bucket，為了避免混淆和方便理解下麵的解釋，個人 ...
  • rocketmq學習(二) rocketmq集群部署與圖形化控制台安裝
    1.rocketmq圖形化控制台安裝 雖然rocketmq為用戶提供了使用命令行管理主題、消費組以及broker配置的功能，但對於不夠熟練的非運維人員來說，命令行的管理界面還是較難使用的。為此，我們可以使用圖形化的管理界面來簡化管理操作。 rocketmq官方推薦的圖形化控制台目前還處在不成熟的孵化 ...
  • Java連載35-類總結、空指針異常
    一、總結 1.棧記憶體中主要存儲的是方法體中的局部變數 2.對象內部有實例變數，實例變數存儲在堆記憶體中 3.變數分類：局部變數（方法體中聲明）；成員變數（方法體外聲明） 實例變數（前邊修飾符沒有static）靜態變數（前邊的修飾符中有static） 4.靜態變數存儲在方法區記憶體中。 5.三塊記憶體中變化 ...
  • Python基礎（一）程式的輸入與輸出與關鍵字
    一、程式的輸入與輸出 程式的輸出是print方法程式的輸入是input方法 1、第一個程式 2、Print函數 （1）直接列印指定的東西，如字元、字母 （2）輸出變數 （3）格式化輸入 （4）不換行輸出 （5）一次性輸出多個值——直接使用逗號“，”隔開 3、格式化輸入-輸出——使用“%” 主要是字元 ...
  • 夯實Java基礎系列5：Java文件和Java包結構
    目錄 "Java中的包概念" "包的作用" "package 的目錄結構" "設置 CLASSPATH 系統變數" "常用jar包" "java軟體包的類型" "dt.jar" "rt.jar" " .java文件的奧秘" " .Java文件簡介" "為什麼一個java源文件中只能有一個public ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類