16 條 yyds 的代碼規(guī)范
點(diǎn)擊關(guān)注公眾號(hào),Java干貨及時(shí)送達(dá)
牛逼!又發(fā)現(xiàn)了一款面試題庫,太全了??!
(點(diǎn)擊查看)
作者 | 濤姐濤哥
鏈接 | cnblogs.com/taojietaoge/p/11575376.html
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?
忘川如斯,擁有一切的人才更怕失去。
背景:如何更規(guī)范化編寫Java 代碼的重要性想必毋需多言,其中最重要的幾點(diǎn)當(dāng)屬提高代碼性能、使代碼遠(yuǎn)離Bug、令代碼更優(yōu)雅。
一、MyBatis 不要為了多個(gè)查詢條件而寫 1 = 1
反例:
<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
反例:
//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() 檢測空
反例:
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.");}
四、初始化集合時(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 拼接字符串
//在循環(huán)中拼接字符串反例String str = "";for (int i = 0; i < 10; i++){不會(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)使用StringBuildersb.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;// "" + valueString strLove = "" + num;
正例:
//把其它對(duì)象或類型轉(zhuǎn)化為字符串正例:int num = 520;// String.valueOf() 效率更高String strLove = String.valueOf(num);
十二、避免使用BigDecimal(double)
BigDecimal(double) 存在精度損失風(fēng)險(xiǎn),在精確計(jì)算或值比較的場景中可能會(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)制檢測null,否則就會(huì)拋出空指針異常;返回空數(shù)組或空集合,有效地避免了調(diào)用方因?yàn)槲礄z測null 而拋出空指針異常的情況,還可以刪除調(diào)用方檢測null 的語句使代碼更簡潔。
反例:
//返回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) 正反例

如有文章對(duì)你有幫助,
歡迎關(guān)注??、點(diǎn)贊??、轉(zhuǎn)發(fā)??!
推薦, Java面試題庫,詳情點(diǎn)擊: 牛逼!又發(fā)現(xiàn)了一款牛逼的Java面試題庫,史上最強(qiáng)! 點(diǎn)擊文末“閱讀原文”可直達(dá)


