Java中16條的代碼規(guī)范
背景:如何更規(guī)范化編寫Java 代碼的重要性想必毋需多言,其中最重要的幾點(diǎn)當(dāng)屬提高代碼性能、使代碼遠(yuǎn)離Bug、令代碼更優(yōu)雅。
一、MyBatis 不要為了多個(gè)查詢條件而寫 1 = 1
當(dāng)遇到多個(gè)查詢條件,使用where 1=1 可以很方便的解決我們的問題,但是這樣很可能會(huì)造成非常大的性能損失,因?yàn)樘砑恿?“where 1=1 ”的過濾條件之后,數(shù)據(jù)庫系統(tǒng)就無法使用索引等查詢優(yōu)化策略,數(shù)據(jù)庫系統(tǒng)將會(huì)被迫對(duì)每行數(shù)據(jù)進(jìn)行掃描(即全表掃描) 以比較此行是否滿足過濾條件,當(dāng)表中的數(shù)據(jù)量較大時(shí)查詢速度會(huì)非常慢;此外,還會(huì)存在SQL 注入的風(fēng)險(xiǎn)。
反例:
<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> 標(biāo)記代替 1=1。
二、 迭代entrySet() 獲取Map 的key 和value
當(dāng)循環(huán)中只需要獲取Map 的主鍵key時(shí),迭代keySet() 是正確的;但是,當(dāng)需要主鍵key 和取值value 時(shí),迭代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() 檢測(cè)空
使用Collection.size() 來檢測(cè)是否為空在邏輯上沒有問題,但是使用Collection.isEmpty() 使得代碼更易讀,并且可以獲得更好的性能;除此之外,任何Collection.isEmpty() 實(shí)現(xiàn)的時(shí)間復(fù)雜度都是O(1) ,不需要多次循環(huán)遍歷,但是某些通過Collection.size() 方法實(shí)現(xiàn)的時(shí)間復(fù)雜度可能是O(n)。O(1)緯度減少循環(huán)次數(shù) 例子
反例:
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."); } //檢測(cè)是否為null 可以使用CollectionUtils.isEmpty() if (CollectionUtils.isEmpty(collection)){ System.out.println("collection is null."); }
四、初始化集合時(shí)盡量指定其大小
盡量在初始化時(shí)指定集合的大小,能有效減少集合的擴(kuò)容次數(shù),因?yàn)榧厦看螖U(kuò)容的時(shí)間復(fù)雜度很可能時(shí)O(n),耗費(fèi)時(shí)間和性能。
反例:
//初始化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 會(huì)對(duì)其進(jìn)行優(yōu)化,但是在循環(huán)中字符串的拼接Java 編譯期無法執(zhí)行優(yōu)化,所以需要使用StringBuilder 進(jìn)行替換。
反例:
//在循環(huán)中拼接字符串反例 String str = ""; for (int i = 0; i < 10; i++){ //在循環(huán)中字符串拼接Java 不會(huì)對(duì)其進(jìn)行優(yōu)化 str += i; }
正例:
//在循環(huán)中拼接字符串正例 String str1 = "Love"; String str2 = "Courage"; String strConcat = str1 + str2; //Java 編譯器會(huì)對(duì)該普通模式的字符串拼接進(jìn)行優(yōu)化 StringBuilder sb = new StringBuilder(); for (int i = 0; i < 10; i++){ //在循環(huán)中,Java 編譯器無法進(jìn)行優(yōu)化,所以要手動(dòng)使用StringBuilder sb.append(i); }
六、若需頻繁調(diào)用Collection.contains 方法則使用Set
在Java 集合類庫中,List的contains 方法普遍時(shí)間復(fù)雜度為O(n),若代碼中需要頻繁調(diào)用contains 方法查找數(shù)據(jù)則先將集合list 轉(zhuǎn)換成HashSet 實(shí)現(xiàn),將O(n) 的時(shí)間復(fù)雜度將為O(1)。
反例:
//頻繁調(diào)用Collection.contains() 反例 List<Object> list = new ArrayList<>(); for (int i = 0; i <= Integer.MAX_VALUE; i++){ //時(shí)間復(fù)雜度為O(n) if (list.contains(i)) System.out.println("list contains "+ i); }
正例:
//頻繁調(diào)用Collection.contains() 正例 List<Object> list = new ArrayList<>(); Set<Object> set = new HashSet<>(); for (int i = 0; i <= Integer.MAX_VALUE; i++){ //時(shí)間復(fù)雜度為O(1) if (set.contains(i)){ System.out.println("list contains "+ i); } }
七、使用靜態(tài)代碼塊實(shí)現(xiàn)賦值靜態(tài)成員變量
對(duì)于集合類型的靜態(tài)成員變量,應(yīng)該使用靜態(tài)代碼塊賦值,而不是使用集合實(shí)現(xiàn)來賦值。
反例:
//賦值靜態(tà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"); } };
正例:
//賦值靜態(tài)成員變量正例 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"); }
八、刪除未使用的局部變量、方法參數(shù)、私有方法、字段和多余的括號(hào)。
九、工具類中屏蔽構(gòu)造函數(shù)
工具類是一堆靜態(tài)字段和函數(shù)的集合,其不應(yīng)該被實(shí)例化;但是,Java 為每個(gè)沒有明確定義構(gòu)造函數(shù)的類添加了一個(gè)隱式公有構(gòu)造函數(shù),為了避免不必要的實(shí)例化,應(yīng)該顯式定義私有構(gòu)造函數(shù)來屏蔽這個(gè)隱式公有構(gòu)造函數(shù)。
反例:
public class PasswordUtils { //工具類構(gòu)造函數(shù)反例 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 { //工具類構(gòu)造函數(shù)正例 private static final Logger LOG = LoggerFactory.getLogger(PasswordUtils.class); //定義私有構(gòu)造函數(shù)來屏蔽這個(gè)隱式公有構(gòu)造函數(shù) private PasswordUtils(){} public static final String DEFAULT_CRYPT_ALGO = "PBEWithMD5AndDES"; public static String encryptPassword(String aPassword) throws IOException { return new PasswordUtils(aPassword).encrypt(); }
十、刪除多余的異常捕獲并拋出
用catch 語句捕獲異常后,若什么也不進(jìn)行處理,就只是讓異常重新拋出,這跟不捕獲異常的效果一樣,可以刪除這塊代碼或添加別的處理。
反例:
//多余異常反例 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) { //僅僅是重復(fù)拋異常 未作任何處理 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"; }*/ } }
十一、字符串轉(zhuǎn)化使用String.valueOf(value) 代替 " " + value
把其它對(duì)象或類型轉(zhuǎn)化為字符串時(shí),使用String.valueOf(value) 比 ""+value 的效率更高。
反例:
//把其它對(duì)象或類型轉(zhuǎn)化為字符串反例: int num = 520; // "" + value String strLove = "" + num;
正例:
//把其它對(duì)象或類型轉(zhuǎn)化為字符串正例: int num = 520; // String.valueOf() 效率更高 String strLove = String.valueOf(num);
十二、避免使用BigDecimal(double)
BigDecimal(double) 存在精度損失風(fēng)險(xiǎn),在精確計(jì)算或值比較的場(chǎng)景中可能會(huì)導(dǎo)致業(yè)務(wù)邏輯異常。
反例:
// BigDecimal 反例 BigDecimal bigDecimal = new BigDecimal(0.11D);
正例:
// BigDecimal 正例 BigDecimal bigDecimal1 = bigDecimal.valueOf(0.11D);
圖1. 失去精度
十三、返回空數(shù)組和集合而非 null
若程序運(yùn)行返回null,需要調(diào)用方強(qiáng)制檢測(cè)null,否則就會(huì)拋出空指針異常;返回空數(shù)組或空集合,有效地避免了調(diào)用方因?yàn)槲礄z測(cè)null 而拋出空指針異常的情況,還可以刪除調(diào)用方檢測(cè)null 的語句使代碼更簡(jiǎn)潔。
反例:
//返回null 反例 public static Result[] getResults() { return null; } public static List<Result> getResultList() { return null; } public static Map<String, Result> getResultMap() { return null; }
正例:
//返回空數(shù)組和空集正例 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(); }
十四、優(yōu)先使用常量或確定值調(diào)用equals 方法
對(duì)象的equals 方法容易拋空指針異常,應(yīng)使用常量或確定有值的對(duì)象來調(diào)用equals 方法。
反例:
//調(diào)用 equals 方法反例 private static boolean fileReader(String fileName)throws IOException{ // 可能拋空指針異常 return fileName.equals("Charming"); }
正例:
//調(diào)用 equals 方法正例 private static boolean fileReader(String fileName)throws IOException{ // 使用常量或確定有值的對(duì)象來調(diào)用 equals 方法 return "Charming".equals(fileName); //或使用:java.util.Objects.equals() 方法 return Objects.equals("Charming",fileName); }
十五、枚舉的屬性字段必須是私有且不可變
枚舉通常被當(dāng)做常量使用,如果枚舉中存在公共屬性字段或設(shè)置字段方法,那么這些枚舉常量的屬性很容易被修改;理想情況下,枚舉中的屬性字段是私有的,并在私有構(gòu)造函數(shù)中賦值,沒有對(duì)應(yīng)的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)部分關(guān)鍵字需要轉(zhuǎn)譯
使用字符串String 的plit 方法時(shí),傳入的分隔字符串是正則表達(dá)式,則部分關(guān)鍵字(比如 .[]()\| 等)需要轉(zhuǎn)義。
反例:
// String.split(String regex) 反例 String[] split = "a.ab.abc".split("."); System.out.println(Arrays.toString(split)); // 結(jié)果為[] String[] split1 = "a|ab|abc".split("|"); System.out.println(Arrays.toString(split1)); // 結(jié)果為["a", "|", "a", "b", "|", "a", "b", "c"]
正例:
// String.split(String regex) 正例 // . 需要轉(zhuǎn)譯 String[] split2 = "a.ab.abc".split("\\."); System.out.println(Arrays.toString(split2)); // 結(jié)果為["a", "ab", "abc"] // | 需要轉(zhuǎn)譯 String[] split3 = "a|ab|abc".split("\\|"); System.out.println(Arrays.toString(split3)); // 結(jié)果為["a", "ab", "abc"]
圖2. String.split(String regex) 正反例
到此這篇關(guān)于Java中16條的代碼規(guī)范的文章就介紹到這了,更多相關(guān)Java 代碼規(guī)范內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
SpringCloud-Spring?Boot?Starter使用測(cè)試及問題小結(jié)
Spring?Boot?Starter?是在?SpringBoot?組件中被提出來的一種概念、簡(jiǎn)化了很多煩瑣的配置、通過引入各種?Spring?Boot?Starter?包可以快速搭建出一個(gè)項(xiàng)目的腳手架,這篇文章主要介紹了SpringCloud-Spring?Boot?Starter使用測(cè)試,需要的朋友可以參考下2022-07-07Java防止頻繁請(qǐng)求、重復(fù)提交的操作代碼(后端防抖操作)
在客戶端網(wǎng)絡(luò)慢或者服務(wù)器響應(yīng)慢時(shí),用戶有時(shí)是會(huì)頻繁刷新頁面或重復(fù)提交表單的,這樣是會(huì)給服務(wù)器造成不小的負(fù)擔(dān)的,同時(shí)在添加數(shù)據(jù)時(shí)有可能造成不必要的麻煩,今天通過本文給大家介紹下Java防止頻繁請(qǐng)求、重復(fù)提交的操作代碼,一起看看吧2022-04-04java數(shù)據(jù)結(jié)構(gòu)之樹基本概念解析及代碼示例
這篇文章主要介紹了java數(shù)據(jù)結(jié)構(gòu)之樹基本概念解析及代碼示例,介紹了樹的定義,基本術(shù)語,主要操作及實(shí)現(xiàn)等相關(guān)內(nèi)容,具有一定參考價(jià)值,需要的朋友可了解下。2017-11-11Java基于字符流形式讀寫數(shù)據(jù)的兩種實(shí)現(xiàn)方法示例
這篇文章主要介紹了Java基于字符流形式讀寫數(shù)據(jù)的兩種實(shí)現(xiàn)方法示,結(jié)合實(shí)例形式分析了java逐個(gè)字符讀寫及使用緩沖區(qū)進(jìn)行讀寫操作的具體實(shí)現(xiàn)技巧,需要的朋友可以參考下2018-01-01解決Springboot項(xiàng)目中很多頁面出現(xiàn)Whitelabel Error Page(404)的問題
最近在接手的前后端項(xiàng)目中發(fā)現(xiàn)其默認(rèn)路徑不是主機(jī)+端口(如:http://localhost:3453/)的形式,很多頁面的訪問是加了一個(gè)層級(jí),只要訪問頁面就會(huì)出現(xiàn)Whitelabel Error Page(404),所以本文給大家提供了解決方案,需要的朋友可以參考下2024-02-02spring boot補(bǔ)習(xí)系列之幾種scope詳解
這篇文章主要給大家介紹了關(guān)于spring boot補(bǔ)習(xí)系列之幾種scope的相關(guān)資料,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家學(xué)習(xí)或者使用spring boot具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2018-07-07項(xiàng)目為什么引入log4j而不是logback代碼
這篇文章主要介紹了項(xiàng)目為什么引入log4j而不是logback代碼,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-10-10使用java實(shí)現(xiàn)http多線程斷點(diǎn)下載文件(二)
下載工具我想沒有幾個(gè)人不會(huì)用的吧,前段時(shí)間比較無聊,花了點(diǎn)時(shí)間用java寫了個(gè)簡(jiǎn)單的http多線程下載程序,我實(shí)現(xiàn)的這個(gè)http下載工具功能很簡(jiǎn)單,就是一個(gè)多線程以及一個(gè)斷點(diǎn)恢復(fù),當(dāng)然下載是必不可少的,需要的朋友可以參考下2012-12-12