代碼中的"壞味道",如"私欲"如"灰塵",每天都在增加,一日不去清除,便會(huì)越累越多。如果用功去清除這些"壞味道",不僅能提高自己的編碼水平,也能使代碼變得"精白無一毫不徹"。這里,一直從事Java研發(fā)相關(guān)工作的阿里高級地圖技術(shù)工程師王超,整理了日常工作中的一些"壞味道",及清理方法,供大家參考。
讓代碼性能更高
需要 Map 的主鍵和取值時(shí),應(yīng)該迭代 entrySet()
當(dāng)循環(huán)中只需要 Map 的主鍵時(shí),迭代 keySet() 是正確的。但是,當(dāng)需要主鍵和取值時(shí),迭代 entrySet() 才是更高效的做法,比先迭代 keySet() 后再去 get 取值性能更佳。
反例:
正例:
應(yīng)該使用Collection.isEmpty()檢測空
使用 Collection.size() 來檢測空邏輯上沒有問題,但是使用 Collection.isEmpty()使得代碼更易讀,并且可以獲得更好的性能。任何 Collection.isEmpty() 實(shí)現(xiàn)的時(shí)間復(fù)雜度都是 O(1) ,但是某些 Collection.size() 實(shí)現(xiàn)的時(shí)間復(fù)雜度可能是 O(n) 。
反例:
正例:
如果需要還需要檢測 null ,可采用CollectionUtils.isEmpty(collection)和CollectionUtils.isNotEmpty(collection)。
不要把集合對象傳給自己
此外,由于某些方法要求參數(shù)在執(zhí)行期間保持不變,因此將集合傳遞給自身可能會(huì)導(dǎo)致異常行為。
反例:
集合初始化盡量指定大小
java 的集合類用起來十分方便,但是看源碼可知,集合也是有大小限制的。每次擴(kuò)容的時(shí)間復(fù)雜度很有可能是 O(n) ,所以盡量指定可預(yù)知的集合大小,能減少集合的擴(kuò)容次數(shù)。
反例:
正例:
字符串拼接使用 StringBuilder
一般的字符串拼接在編譯期 java 會(huì)進(jìn)行優(yōu)化,但是在循環(huán)中字符串拼接, java 編譯期無法做到優(yōu)化,所以需要使用 StringBuilder 進(jìn)行替換。
反例:
正例:
List 的隨機(jī)訪問
大家都知道數(shù)組和鏈表的區(qū)別:數(shù)組的隨機(jī)訪問效率更高。當(dāng)調(diào)用方法獲取到 List 后,如果想隨機(jī)訪問其中的數(shù)據(jù),并不知道該數(shù)組內(nèi)部實(shí)現(xiàn)是鏈表還是數(shù)組,怎么辦呢?可以判斷它是否實(shí)現(xiàn)* RandomAccess *接口。
正例:
頻繁調(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) 。
反例:
正例:
讓代碼更優(yōu)雅
長整型常量后添加大寫 L
在使用長整型常量值時(shí),后面需要添加 L ,必須是大寫的 L ,不能是小寫的 l ,小寫 l 容易跟數(shù)字 1 混淆而造成誤解。
反例:
正例:
不要使用魔法值
當(dāng)你編寫一段代碼時(shí),使用魔法值可能看起來很明確,但在調(diào)試時(shí)它們卻不顯得那么明確了。這就是為什么需要把魔法值定義為可讀取常量的原因。但是,-1、0 和 1不被視為魔法值。
反例:
正例:
不要使用集合實(shí)現(xiàn)來賦值靜態(tài)成員變量
對于集合類型的靜態(tài)成員變量,不要使用集合實(shí)現(xiàn)來賦值,應(yīng)該使用靜態(tài)代碼塊賦值。
反例:
正例:
建議使用 try-with-resources 語句
Java 7 中引入了 try-with-resources 語句,該語句能保證將相關(guān)資源關(guān)閉,優(yōu)于原來的 try-catch-finally 語句,并且使程序代碼更安全更簡潔。
反例:
正例:
刪除未使用的私有方法和字段
刪除未使用的私有方法和字段,使代碼更簡潔更易維護(hù)。若有需要再使用,可以從歷史提交中找回。
反例:
正例:
刪除未使用的局部變量
刪除未使用的局部變量,使代碼更簡潔更易維護(hù)。
反例:
正例:
刪除未使用的方法參數(shù)
未使用的方法參數(shù)具有誤導(dǎo)性,刪除未使用的方法參數(shù),使代碼更簡潔更易維護(hù)。但是,由于重寫方法是基于父類或接口的方法定義,即便有未使用的方法參數(shù),也是不能刪除的。
反例:
正例:
刪除表達(dá)式的多余括號
對應(yīng)表達(dá)式中的多余括號,有人認(rèn)為有助于代碼閱讀,也有人認(rèn)為完全沒有必要。對于一個(gè)熟悉 Java 語法的人來說,表達(dá)式中的多余括號反而會(huì)讓代碼顯得更繁瑣。
反例:
正例:
工具類應(yīng)該屏蔽構(gòu)造函數(shù)
工具類是一堆靜態(tài)字段和函數(shù)的集合,不應(yīng)該被實(shí)例化。但是,Java 為每個(gè)沒有明確定義構(gòu)造函數(shù)的類添加了一個(gè)隱式公有構(gòu)造函數(shù)。所以,為了避免 java "小白"使用有誤,應(yīng)該顯式定義私有構(gòu)造函數(shù)來屏蔽這個(gè)隱式公有構(gòu)造函數(shù)。
反例:
正例:
刪除多余的異常捕獲并拋出
用 catch 語句捕獲異常后,什么也不進(jìn)行處理,就讓異常重新拋出,這跟不捕獲異常的效果一樣,可以刪除這塊代碼或添加別的處理。
反例:
正例:
公有靜態(tài)常量應(yīng)該通過類訪問
雖然通過類的實(shí)例訪問公有靜態(tài)常量是允許的,但是容易讓人它誤認(rèn)為每個(gè)類的實(shí)例都有一個(gè)公有靜態(tài)常量。所以,公有靜態(tài)常量應(yīng)該直接通過類訪問。
反例:
正例:
不要用NullPointerException判斷空
空指針異常應(yīng)該用代碼規(guī)避(比如檢測不為空),而不是用捕獲異常的方式處理。
反例:
正例:
使用String.valueOf(value)代替""+value
當(dāng)要把其它對象或類型轉(zhuǎn)化為字符串時(shí),使用 String.valueOf(value) 比""+value 的效率更高。
反例:
正例:
過時(shí)代碼添加 @Deprecated 注解
當(dāng)一段代碼過時(shí),但為了兼容又無法直接刪除,不希望以后有人再使用它時(shí),可以添加 @Deprecated 注解進(jìn)行標(biāo)記。在文檔注釋中添加 @deprecated 來進(jìn)行解釋,并提供可替代方案。
正例:
讓代碼遠(yuǎn)離 bug
禁止使用構(gòu)造方法 BigDecimal(double)
BigDecimal(double) 存在精度損失風(fēng)險(xiǎn),在精確計(jì)算或值比較的場景中可能會(huì)導(dǎo)致業(yè)務(wù)邏輯異常。
反例:
正例:
返回空數(shù)組和空集合而不是 null
返回 null ,需要調(diào)用方強(qiáng)制檢測 null ,否則就會(huì)拋出空指針異常。返回空數(shù)組或空集合,有效地避免了調(diào)用方因?yàn)槲礄z測 null 而拋出空指針異常,還可以刪除調(diào)用方檢測 null 的語句使代碼更簡潔。
反例:
正例:
優(yōu)先使用常量或確定值來調(diào)用 equals 方法
對象的 equals 方法容易拋空指針異常,應(yīng)使用常量或確定有值的對象來調(diào)用 equals 方法。當(dāng)然,使用 java.util.Objects.equals() 方法是最佳實(shí)踐。
反例:
正例:
枚舉的屬性字段必須是私有不可變
枚舉通常被當(dāng)做常量使用,如果枚舉中存在公共屬性字段或設(shè)置字段方法,那么這些枚舉常量的屬性很容易被修改。理想情況下,枚舉中的屬性字段是私有的,并在私有構(gòu)造函數(shù)中賦值,沒有對應(yīng)的 Setter 方法,最好加上 final 修飾符。
反例:
正例:
小心String.split(String regex)
字符串 String 的 split 方法,傳入的分隔字符串是正則表達(dá)式!部分關(guān)鍵字(比如.[]()/| 等)需要轉(zhuǎn)義。
反例:
正例:
總結(jié)
這篇文章,可以說是從事 Java 開發(fā)的經(jīng)驗(yàn)總結(jié),分享出來以供大家參考。希望能幫大家避免踩坑,讓代碼更加高效優(yōu)雅。
【責(zé)任編輯:武曉燕 TEL:(010)68476606】