這樣規(guī)范寫代碼，同事直呼“666”
來源：cnblogs.com/taojietaoge/p/11575376.html
一、MyBatis 不要為了多個查詢條件而寫 1 = 1
當(dāng)遇到多個查詢條件，使用where 1=1 可以很方便的解決我們的問題，但是這樣很可能會造成非常大的性能損失，因為添加了 “where 1=1 ”的過濾條件之后，數(shù)據(jù)庫系統(tǒng)就無法使用索引等查詢優(yōu)化策略，數(shù)據(jù)庫系統(tǒng)將會被迫對每行數(shù)據(jù)進行掃描（即全表掃描） 以比較此行是否滿足過濾條件，當(dāng)表中的數(shù)據(jù)量較大時查詢速度會非常慢；此外，還會存在SQL 注入的風(fēng)險。
反例：
"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>?
正例：
"queryBookInfo"?parameterType="com.tjt.platform.entity.BookInfo"?resultType="java.lang.Integer">
?select?count(*)?from?t_rule_BookInfo?t
<if?test
?title?=?#{title}?
if>
<if?test="author?!=null?and?author?!=''?">?
?AND?author?=?#{author}
if>
?
UPDATE 操作也一樣，可以用
二、迭代entrySet() 獲取Map 的key 和value
當(dāng)循環(huán)中只需要獲取Map 的主鍵key時，迭代keySet() 是正確的；但是，當(dāng)需要主鍵key 和取值value 時，迭代entrySet() 才是更高效的做法，其比先迭代keySet() 后再去通過get 取值性能更佳。
反例：
//Map?獲取value?反例:
HashMap?map?=?new?HashMap<>();
for?(String?key?:?map.keySet()){
????String?value?=?map.get(key);
}
正例：
//Map?獲取key?&?value?正例:
HashMap?map?=?new?HashMap<>();
for?(Map.Entry?entry?:?map.entrySet()){
?String?key?=?entry.getKey();
?String?value?=?entry.getValue();
}
三、使用Collection.isEmpty() 檢測空
使用Collection.size() 來檢測是否為空在邏輯上沒有問題，但是使用Collection.isEmpty() 使得代碼更易讀，并且可以獲得更好的性能；除此之外，任何Collection.isEmpty() 實現(xiàn)的時間復(fù)雜度都是O(1) ，不需要多次循環(huán)遍歷，但是某些通過Collection.size() 方法實現(xiàn)的時間復(fù)雜度可能是O(n)
反例：
LinkedList正例：
LinkedList四、初始化集合時盡量指定其大小
盡量在初始化時指定集合的大小，能有效減少集合的擴容次數(shù)，因為集合每次擴容的時間復(fù)雜度很可能時O(n)，耗費時間和性能。
反例：
//初始化list，往list 中添加元素反例：
int[]?arr?=?new?int[]{1,2,3,4};
List?list?=?new?ArrayList<>();
for?(int?i?:?arr){
?list.add(i);
}
正例：
//初始化list，往list 中添加元素正例：
int[]?arr?=?new?int[]{1,2,3,4};
//指定集合list?的容量大小
List?list?=?new?ArrayList<>(arr.length);
for?(int?i?:?arr){
????list.add(i);
}
五、使用StringBuilder 拼接字符串
一般的字符串拼接在編譯期Java 會對其進行優(yōu)化，但是在循環(huán)中字符串的拼接Java 編譯期無法執(zhí)行優(yōu)化，所以需要使用StringBuilder 進行替換。
反例：
//在循環(huán)中拼接字符串反例
String?str?=?"";
for?(int?i?=?0;?i?10;?i++){
????//在循環(huán)中字符串拼接Java?不會對其進行優(yōu)化
????str?+=?i;
}
正例：
//在循環(huán)中拼接字符串正例
String?str1?=?"Love";
String?str2?=?"Courage";
String?strConcat?=?str1?+?str2;??//Java?編譯器會對該普通模式的字符串拼接進行優(yōu)化
StringBuilder?sb?=?new?StringBuilder();
for?(int?i?=?0;?i?10;?i++){
???//在循環(huán)中，Java?編譯器無法進行優(yōu)化，所以要手動使用StringBuilder
????sb.append(i);
}
六、若需頻繁調(diào)用Collection.contains 方法則使用Set
在Java 集合類庫中，List的contains 方法普遍時間復(fù)雜度為O(n)，若代碼中需要頻繁調(diào)用contains 方法查找數(shù)據(jù)則先將集合list 轉(zhuǎn)換成HashSet 實現(xiàn)，將O(n) 的時間復(fù)雜度將為O(1)。
反例：
//頻繁調(diào)用Collection.contains()?反例
List正例:
//頻繁調(diào)用Collection.contains()?正例
List七、使用靜態(tài)代碼塊實現(xiàn)賦值靜態(tài)成員變量
對于集合類型的靜態(tài)成員變量，應(yīng)該使用靜態(tài)代碼塊賦值，而不是使用集合實現(xiàn)來賦值。
反例：
//賦值靜態(tài)成員變量反例
private?static?Map?map?=?new?HashMap(){
????{
????????map.put("Leo",1);
????????map.put("Family-loving",2);
????????map.put("Cold?on?the?out?side?passionate?on?the?inside",3);
????}
};
private?static?List?list?=?new?ArrayList<>(){
????{
????????list.add("Sagittarius");
????????list.add("Charming");
????????list.add("Perfectionist");
????}
};
正例：
//賦值靜態(tài)成員變量正例
private?static?Map?map?=?new?HashMap();
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?list?=?new?ArrayList<>();
static?{
????list.add("Sagittarius");
????list.add("Charming");
????list.add("Perfectionist");
}
八、刪除未使用的局部變量、方法參數(shù)、私有方法、字段和多余的括號。
九、工具類中屏蔽構(gòu)造函數(shù)
工具類是一堆靜態(tài)字段和函數(shù)的集合，其不應(yīng)該被實例化；但是，Java 為每個沒有明確定義構(gòu)造函數(shù)的類添加了一個隱式公有構(gòu)造函數(shù)，為了避免不必要的實例化，應(yīng)該顯式定義私有構(gòu)造函數(shù)來屏蔽這個隱式公有構(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ò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 語句捕獲異常后，若什么也不進行處理，就只是讓異常重新拋出，這跟不捕獲異常的效果一樣，可以刪除這塊代碼或添加別的處理。
反例：
//多余異常反例
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
把其它對象或類型轉(zhuǎn)化為字符串時，使用String.valueOf(value) 比 ""+value 的效率更高。
反例：
//把其它對象或類型轉(zhuǎn)化為字符串反例：
int?num?=?520;
//?""?+?value
String?strLove?=?""?+?num;
正例：
//把其它對象或類型轉(zhuǎn)化為字符串正例：
int?num?=?520;
//?String.valueOf()?效率更高
String?strLove?=?String.valueOf(num);
十二、避免使用BigDecimal(double)
BigDecimal(double) 存在精度損失風(fēng)險，在精確計算或值比較的場景中可能會導(dǎo)致業(yè)務(wù)邏輯異常。
反例：
//?BigDecimal?反例????
BigDecimal?bigDecimal?=?new?BigDecimal(0.11D);
正例：
//?BigDecimal?正例
BigDecimal?bigDecimal1?=?bigDecimal.valueOf(0.11D);
十三、返回空數(shù)組和集合而非 null
若程序運行返回null，需要調(diào)用方強制檢測null，否則就會拋出空指針異常；返回空數(shù)組或空集合，有效地避免了調(diào)用方因為未檢測null 而拋出空指針異常的情況，還可以刪除調(diào)用方檢測null 的語句使代碼更簡潔。
反例：
//返回null?反例
public?static?Result[]?getResults()?{
????return?null;
}
public?static?List?getResultList()? {
????return?null;
}
public?static?Map?getResultMap()? {
????return?null;
}
正例：
//返回空數(shù)組和空集正例
public?static?Result[]?getResults()?{
????return?new?Result[0];
}
public?static?List?getResultList()? {
????return?Collections.emptyList();
}
public?static?Map?getResultMap()? {
????return?Collections.emptyMap();
}
十四、優(yōu)先使用常量或確定值調(diào)用equals 方法
對象的equals 方法容易拋空指針異常，應(yīng)使用常量或確定有值的對象來調(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{
????//?使用常量或確定有值的對象來調(diào)用?equals?方法
????return?"Charming".equals(fileName);
????//或使用：java.util.Objects.equals()?方法
???return?Objects.equals("Charming",fileName);
}
十五、枚舉的屬性字段必須是私有且不可變
枚舉通常被當(dāng)做常量使用，如果枚舉中存在公共屬性字段或設(shè)置字段方法，那么這些枚舉常量的屬性很容易被修改；理想情況下，枚舉中的屬性字段是私有的，并在私有構(gòu)造函數(shù)中賦值，沒有對應(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 方法時，傳入的分隔字符串是正則表達式，則部分關(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"]
推薦閱讀
