主頁 > 後端開發 > 16 條 yyds 的代碼規范

16 條 yyds 的代碼規范

2021-07-30 07:35:51 後端開發

(上一篇) 16個Redis常見使用場景總結

42 張圖帶你擼完 MySQL 優化

40 個 SpringBoot 常用注解

別慌,在Java面試的時候,面試官會這樣問關于框架的問題?


如何更規范化撰寫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?

忘川如斯,擁有一切的人才更怕失去,

鏈接 | cnblogs.com/taojietaoge/p/11575376.html

背景:如何更規范化撰寫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 取值性能更佳,

反例:

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

三、使用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";
 String strConcat = str1 + str2;  //Java 編譯器會對該普通模式的字串拼接進行優化
  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);

圖1. 失去精度

圖片

十三、回傳空陣列和集合而非 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"]

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

圖片



(上一篇) 16個Redis常見使用場景總結

42 張圖帶你擼完 MySQL 優化

40 個 SpringBoot 常用注解

別慌,在Java面試的時候,面試官會這樣問關于框架的問題?

轉載請註明出處,本文鏈接:https://www.uj5u.com/houduan/290870.html

標籤:java

上一篇:Java崗大廠面試百日沖刺 - 榷訓月累,每日三題【Day29】—— RPC框架

下一篇:簡單的Python小游戲制作

標籤雲
其他(157675) Python(38076) JavaScript(25376) Java(17977) C(15215) 區塊鏈(8255) C#(7972) AI(7469) 爪哇(7425) MySQL(7132) html(6777) 基礎類(6313) sql(6102) 熊猫(6058) PHP(5869) 数组(5741) R(5409) Linux(5327) 反应(5209) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4554) 数据框(4311) css(4259) 节点.js(4032) C語言(3288) json(3245) 列表(3129) 扑(3119) C++語言(3117) 安卓(2998) 打字稿(2995) VBA(2789) Java相關(2746) 疑難問題(2699) 细绳(2522) 單片機工控(2479) iOS(2429) ASP.NET(2402) MongoDB(2323) 麻木的(2285) 正则表达式(2254) 字典(2211) 循环(2198) 迅速(2185) 擅长(2169) 镖(2155) 功能(1967) .NET技术(1958) Web開發(1951) python-3.x(1918) HtmlCss(1915) 弹簧靴(1913) C++(1909) xml(1889) PostgreSQL(1872) .NETCore(1853) 谷歌表格(1846) Unity3D(1843) for循环(1842)

熱門瀏覽
  • 【C++】Microsoft C++、C 和匯編程式檔案

    ......

    uj5u.com 2020-09-10 00:57:23 more
  • 例外宣告

    相比于斷言適用于排除邏輯上不可能存在的狀態,例外通常是用于邏輯上可能發生的錯誤。 例外宣告 Item 1:當函式不可能拋出例外或不能接受拋出例外時,使用noexcept 理由 如果不打算拋出例外的話,程式就會認為無法處理這種錯誤,并且應當盡早終止,如此可以有效地阻止例外的傳播與擴散。 示例 //不可 ......

    uj5u.com 2020-09-10 00:57:27 more
  • Codeforces 1400E Clear the Multiset(貪心 + 分治)

    鏈接:https://codeforces.com/problemset/problem/1400/E 來源:Codeforces 思路:給你一個陣列,現在你可以進行兩種操作,操作1:將一段沒有 0 的區間進行減一的操作,操作2:將 i 位置上的元素歸零。最終問:將這個陣列的全部元素歸零后操作的最少 ......

    uj5u.com 2020-09-10 00:57:30 more
  • UVA11610 【Reverse Prime】

    本人看到此題沒有翻譯,就附帶了一個自己的翻譯版本 思考 這一題,它的第一個要求是找出所有 $7$ 位反向質數及其質因數的個數。 我們應該需要質數篩篩選1~$10^{7}$的所有數,這里就不慢慢介紹了。但是,重讀題,我們突然發現反向質數都是 $7$ 位,而將它反過來后的數字卻是 $6$ 位數,這就說明 ......

    uj5u.com 2020-09-10 00:57:36 more
  • 統計區間素數數量

    1 #pragma GCC optimize(2) 2 #include <bits/stdc++.h> 3 using namespace std; 4 bool isprime[1000000010]; 5 vector<int> prime; 6 inline int getlist(int ......

    uj5u.com 2020-09-10 00:57:47 more
  • C/C++編程筆記:C++中的 const 變數詳解,教你正確認識const用法

    1、C中的const 1、區域const變數存放在堆疊區中,會分配記憶體(也就是說可以通過地址間接修改變數的值)。測驗代碼如下: 運行結果: 2、全域const變數存放在只讀資料段(不能通過地址修改,會發生寫入錯誤), 默認為外部聯編,可以給其他源檔案使用(需要用extern關鍵字修飾) 運行結果: ......

    uj5u.com 2020-09-10 00:58:04 more
  • 【C++犯錯記錄】VS2019 MFC添加資源不懂如何修改資源宏ID

    1. 首先在資源視圖中,添加資源 2. 點擊新添加的資源,復制自動生成的ID 3. 在解決方案資源管理器中找到Resource.h檔案,編輯,使用整個專案搜索和替換的方式快速替換 宏宣告 4. Ctrl+Shift+F 全域搜索,點擊查找全部,然后逐個替換 5. 為什么使用搜索替換而不使用屬性視窗直 ......

    uj5u.com 2020-09-10 00:59:11 more
  • 【C++犯錯記錄】VS2019 MFC不懂的批量添加資源

    1. 打開資源頭檔案Resource.h,在其中預先定義好宏 ID(不清楚其實ID值應該設定多少,可以先新建一個相同的資源項,再在這個資源的ID值的基礎上遞增即可) 2. 在資源視圖中選中專案資源,按F7編輯資源檔案,按 ID 型別 相對路徑的形式添加 資源。(別忘了先把檔案拷貝到專案中的res檔案 ......

    uj5u.com 2020-09-10 01:00:19 more
  • C/C++編程筆記:關于C++的參考型別,專供新手入門使用

    今天要講的是C++中我最喜歡的一個用法——參考,也叫別名。 參考就是給一個變數名取一個變數名,方便我們間接地使用這個變數。我們可以給一個變數創建N個參考,這N + 1個變數共享了同一塊記憶體區域。(參考型別的變數會占用記憶體空間,占用的記憶體空間的大小和指標型別的大小是相同的。雖然參考是一個物件的別名,但 ......

    uj5u.com 2020-09-10 01:00:22 more
  • 【C/C++編程筆記】從頭開始學習C ++:初學者完整指南

    眾所周知,C ++的學習曲線陡峭,但是花時間學習這種語言將為您的職業帶來奇跡,并使您與其他開發人員區分開。您會更輕松地學習新語言,形成真正的解決問題的技能,并在編程的基礎上打下堅實的基礎。 C ++將幫助您養成良好的編程習慣(即清晰一致的編碼風格,在撰寫代碼時注釋代碼,并限制類內部的可見性),并且由 ......

    uj5u.com 2020-09-10 01:00:41 more
最新发布
  • Rust中的智能指標:Box<T> Rc<T> Arc<T> Cell<T> RefCell<T> Weak

    Rust中的智能指標是什么 智能指標(smart pointers)是一類資料結構,是擁有資料所有權和額外功能的指標。是指標的進一步發展 指標(pointer)是一個包含記憶體地址的變數的通用概念。這個地址參考,或 ” 指向”(points at)一些其 他資料 。參考以 & 符號為標志并借用了他們所 ......

    uj5u.com 2023-04-20 07:24:10 more
  • Java的值傳遞和參考傳遞

    值傳遞不會改變本身,參考傳遞(如果傳遞的值需要實體化到堆里)如果發生修改了會改變本身。 1.基本資料型別都是值傳遞 package com.example.basic; public class Test { public static void main(String[] args) { int ......

    uj5u.com 2023-04-20 07:24:04 more
  • [2]SpinalHDL教程——Scala簡單入門

    第一個 Scala 程式 shell里面輸入 $ scala scala> 1 + 1 res0: Int = 2 scala> println("Hello World!") Hello World! 檔案形式 object HelloWorld { /* 這是我的第一個 Scala 程式 * 以 ......

    uj5u.com 2023-04-20 07:23:58 more
  • 理解函式指標和回呼函式

    理解 函式指標 指向函式的指標。比如: 理解函式指標的偽代碼 void (*p)(int type, char *data); // 定義一個函式指標p void func(int type, char *data); // 宣告一個函式func p = func; // 將指標p指向函式func ......

    uj5u.com 2023-04-20 07:23:52 more
  • Django筆記二十五之資料庫函式之日期函式

    本文首發于公眾號:Hunter后端 原文鏈接:Django筆記二十五之資料庫函式之日期函式 日期函式主要介紹兩個大類,Extract() 和 Trunc() Extract() 函式作用是提取日期,比如我們可以提取一個日期欄位的年份,月份,日等資料 Trunc() 的作用則是截取,比如 2022-0 ......

    uj5u.com 2023-04-20 07:23:45 more
  • 一天吃透JVM面試八股文

    什么是JVM? JVM,全稱Java Virtual Machine(Java虛擬機),是通過在實際的計算機上仿真模擬各種計算機功能來實作的。由一套位元組碼指令集、一組暫存器、一個堆疊、一個垃圾回收堆和一個存盤方法域等組成。JVM屏蔽了與作業系統平臺相關的資訊,使得Java程式只需要生成在Java虛擬機 ......

    uj5u.com 2023-04-20 07:23:31 more
  • 使用Java接入小程式訂閱訊息!

    更新完微信服務號的模板訊息之后,我又趕緊把微信小程式的訂閱訊息給實作了!之前我一直以為微信小程式也是要企業才能申請,沒想到小程式個人就能申請。 訊息推送平臺🔥推送下發【郵件】【短信】【微信服務號】【微信小程式】【企業微信】【釘釘】等訊息型別。 https://gitee.com/zhongfuch ......

    uj5u.com 2023-04-20 07:22:59 more
  • java -- 緩沖流、轉換流、序列化流

    緩沖流 緩沖流, 也叫高效流, 按照資料型別分類: 位元組緩沖流:BufferedInputStream,BufferedOutputStream 字符緩沖流:BufferedReader,BufferedWriter 緩沖流的基本原理,是在創建流物件時,會創建一個內置的默認大小的緩沖區陣列,通過緩沖 ......

    uj5u.com 2023-04-20 07:22:49 more
  • Java-SpringBoot-Range請求頭設定實作視頻分段傳輸

    老實說,人太懶了,現在基本都不喜歡寫筆記了,但是網上有關Range請求頭的文章都太水了 下面是抄的一段StackOverflow的代碼...自己大修改過的,寫的注釋挺全的,應該直接看得懂,就不解釋了 寫的不好...只是希望能給視頻網站開發的新手一點點幫助吧. 業務場景:視頻分段傳輸、視頻多段傳輸(理 ......

    uj5u.com 2023-04-20 07:22:42 more
  • Windows 10開發教程_編程入門自學教程_菜鳥教程-免費教程分享

    教程簡介 Windows 10開發入門教程 - 從簡單的步驟了解Windows 10開發,從基本到高級概念,包括簡介,UWP,第一個應用程式,商店,XAML控制元件,資料系結,XAML性能,自適應設計,自適應UI,自適應代碼,檔案管理,SQLite資料庫,應用程式到應用程式通信,應用程式本地化,應用程式 ......

    uj5u.com 2023-04-20 07:22:35 more