避免 Java 代碼中的“壞味道”

1发钝、需要 Map 的主鍵和取值時酗捌,應(yīng)該迭代 entrySet()

當循環(huán)中只需要 Map 的主鍵時煞赢,迭代 keySet() 是正確的烈疚。但是,當需要主鍵和取值時黎休,迭代 entrySet() 才是更高效的做法输钩,比先迭代 keySet() 后再去 get 取值性能更佳床玻。

反例:
Map<String, String> map = new HashMap<>();
for (String key : map.keySet()) {
    String value = map.get(key);
}

=========================================================================================

正例:
Map<String, String> map = new HashMap<>();
for (Map.Entry<String, String> entry : map.entrySet()) {
    String key = entry.getKey();
    String value = entry.getValue();
}

2、 應(yīng)該使用 Collection.isEmpty() 檢測空

使用 Collection.size() 來檢測空邏輯上沒有問題屑柔,但是使用 Collection.isEmpty() 使得代碼更易讀屡萤,并且可以獲得更好的性能。任何 Collection.isEmpty() 實現(xiàn)的時間復(fù)雜度都是 O(1) 掸宛,但是某些 Collection.size() 實現(xiàn)的時間復(fù)雜度可能是 O(n) 死陆。

反例:
List<String> list = new ArrayList<>();
if (list.size() == 0) {
    ...
}

=========================================================================================

正例:    
List<String> list = new ArrayList<>();
if (list.isEmpty()) {
    ...
}

如果需要還需要檢測 null ,可采用 CollectionUtils 工具包的方法唧瘾。

正例:
List<String> list = new ArrayList<>();
if(CollectionUtils.isEmpty(list)){

} 

=========================================================================================

正例:
List<String> list = new ArrayList<>();
if(CollectionUtils.isNotEmpty(list)){

}

3措译、不要把集合對象傳給自己

將集合作為參數(shù)傳遞給集合自己的方法要么是一個錯誤,要么是無意義的代碼饰序。

此外领虹,由于某些方法要求參數(shù)在執(zhí)行期間保持不變,因此將集合傳遞給自身可能會導(dǎo)致異常行為菌羽。

List<String> list = new ArrayList<>();
list.add("Hello");
list.add("World");

if (list.containsAll(list)) {  // 無意義,總是返回true
    ...
}

list.removeAll(list);  // 性能差, 直接使用clear()

4掠械、集合初始化盡量指定大小

Java 的集合類用起來十分方便,但是看源碼可知注祖,集合也是有大小限制的。每次擴容的時間復(fù)雜度很有可能是 O(n) 均唉,所以盡量指定可預(yù)知的集合大小是晨,能減少集合的擴容次數(shù)。

反例:
int[] arr = new int[]{1, 2, 3};
List<Integer> list = new ArrayList<>();
for (int i : arr) {
    list.add(i);
}

=========================================================================================

正例:
int[] arr = new int[]{1, 2, 3};
List<Integer> list = new ArrayList<>(arr.length);
for (int i : arr) {
    list.add(i);
}

5舔箭、字符串拼接使用 StringBuilder

一般的字符串拼接在編譯期 java 會進行優(yōu)化罩缴,但是在循環(huán)中字符串拼接,java 編譯期無法做到優(yōu)化层扶,所以需要使用 StringBuilder 進行替換箫章。

反例:
String s = "";
for (int i = 0; i < 10; i++) {
    s += i;
}

=========================================================================================

正例:
String a = "a";
String b = "b";
String c = "c";
String s = a + b + c; // 沒問題,java編譯器會進行優(yōu)化
StringBuilder sb = new StringBuilder();
for (int i = 0; i < 10; i++) {
    sb.append(i);  // 循環(huán)中镜会,java編譯器無法進行優(yōu)化檬寂,所以要手動使用StringBuilder
}

6、List的隨機訪問

大家都知道數(shù)組和鏈表的區(qū)別:數(shù)組的隨機訪問效率更高戳表。當調(diào)用方法獲取到 List 后桶至,如果想隨機訪問其中的數(shù)據(jù),并不知道該數(shù)組內(nèi)部實現(xiàn)是鏈表還是數(shù)組匾旭,怎么辦呢镣屹?可以判斷它是否實現(xiàn) RandomAccess 接口。

正例:
// 調(diào)用別人的服務(wù)獲取到list
List<Integer> list = otherService.getList();
if (list instanceof RandomAccess) {
    // 內(nèi)部數(shù)組實現(xiàn)价涝,可以隨機訪問
    System.out.println(list.get(list.size() - 1));
} else {
    // 內(nèi)部可能是鏈表實現(xiàn)女蜈,隨機訪問效率低
}

7、頻繁調(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) 惰许。

反例:
ArrayList<Integer> list = otherService.getList();
for (int i = 0; i <= Integer.MAX_VALUE; i++) {
    // 時間復(fù)雜度O(n)
    list.contains(i);
}

=========================================================================================

正例:
ArrayList<Integer> list = otherService.getList();
Set<Integer> set = new HashSet(list);
for (int i = 0; i <= Integer.MAX_VALUE; i++) {
    // 時間復(fù)雜度O(1)
    set.contains(i);
}

8席覆、不要使用魔法值

當你編寫一段代碼時,使用魔法值可能看起來很明確汹买,但在調(diào)試時它們卻不顯得那么明確了佩伤。這就是為什么需要把魔法值定義為可讀取常量的原因。但是晦毙,-1生巡、0 和 1 不被視為魔法值。

正例:
private static final int MAX_COUNT = 100;
for (int i = 0; i < MAX_COUNT; i++){
    ...
}
if (count == MAX_COUNT) {
    ...
}

9见妒、不要使用集合實現(xiàn)來賦值靜態(tài)成員變量

對于集合類型的靜態(tài)成員變量孤荣,不要使用集合實現(xiàn)來賦值须揣,應(yīng)該使用靜態(tài)代碼塊賦值盐股。

反例:
private static Map<String, Integer> map = new HashMap<String, Integer>() {
    {
        put("a", 1);
        put("b", 2);
    }
};
private static List<String> list = new ArrayList<String>() {
    {
        add("a");
        add("b");
    }
};

=========================================================================================

正例:
private static Map<String, Integer> map = new HashMap<>();
static {
    map.put("a", 1);
    map.put("b", 2);
};
private static List<String> list = new ArrayList<>();
static {
    list.add("a");
    list.add("b");
};

10、建議使用 try-with-resources 語句

Java 7 中引入了 try-with-resources 語句耻卡,該語句能保證將相關(guān)資源關(guān)閉疯汁,優(yōu)于原來的 try-catch-finally 語句,并且使程序代碼更安全更簡潔卵酪。

反例:
private void handle(String fileName) {
    BufferedReader reader = null;
    try {
        String line;
        reader = new BufferedReader(new FileReader(fileName));
        while ((line = reader.readLine()) != null) {
            ...
        }
    } catch (Exception e) {
        ...
    } finally {
        if (reader != null) {
            try {
                reader.close();
            } catch (IOException e) {
                ...
            }
        }
    }
}

=========================================================================================

正例:
private void handle(String fileName) {
    try (BufferedReader reader = new BufferedReader(new FileReader(fileName))) {
        String line;
        while ((line = reader.readLine()) != null) {
            ...
        }
    } catch (Exception e) {
        ...
    }
}

11幌蚊、工具類應(yīng)該屏蔽構(gòu)造函數(shù)

工具類是一堆靜態(tài)字段和函數(shù)的集合,不應(yīng)該被實例化溃卡。但是溢豆, Java 為每個沒有明確定義構(gòu)造函數(shù)的類添加了一個隱式公有構(gòu)造函數(shù)。所以瘸羡,為了避免 java "小白"使用有誤漩仙,應(yīng)該顯式定義私有構(gòu)造函數(shù)來屏蔽這個隱式公有構(gòu)造函數(shù)。

反例:
public class MathUtils {
    public static final double PI = 3.1415926D;
    public static int sum(int a, int b) {
        return a + b;
    }
}

=========================================================================================

正例:
public class MathUtils {
    public static final double PI = 3.1415926D;
    private MathUtils() {}
    public static int sum(int a, int b) {
        return a + b;
    }
}

12最铁、刪除多余的異常捕獲并拋出

用catch語句捕獲異常后讯赏,什么也不進行處理,就讓異常重新拋出冷尉,這跟不捕獲異常的效果一樣漱挎,可以刪除這塊代碼或添加別的處理。

反例:
private static String readFile(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 readFile(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();
    }
}

13雀哨、公有靜態(tài)常量應(yīng)該通過類訪問

雖然通過類的實例訪問公有靜態(tài)常量是允許的磕谅,但是容易讓人它誤認為每個類的實例都有一個公有靜態(tài)常量私爷。所以,公有靜態(tài)常量應(yīng)該直接通過類訪問膊夹。

反例:
public class User {
    public static final String CONST_NAME = "name";
    ...
}
User user = new User();
String nameKey = user.CONST_NAME;

=========================================================================================

正例:
public class User {
    public static final String CONST_NAME = "name";
    ...
}

14衬浑、不要用 NullPointerException 判斷空

空指針異常應(yīng)該用代碼規(guī)避(比如檢測不為空),而不是用捕獲異常的方式處理放刨。

反例:
public String getUserName(User user) {
    try {
        return user.getName();
    } catch (NullPointerException e) {
        return null;
    }
}

=========================================================================================

正例:
public String getUserName(User user) {
    if (Objects.isNull(user)) {
        return null;
    }
    return user.getName();
}

14工秩、使用 String.valueOf(value) 代替 ""+value

當要把其它對象或類型轉(zhuǎn)化為字符串時,使用 String.valueOf(value) 比 ""+value 的效率更高进统。

反例:
int i = 1;
String s = "" + i;

=========================================================================================

正例:
int i = 1;
String s = String.valueOf(i);

15助币、過時代碼添加 @Deprecated 注解

當一段代碼過時,但為了兼容又無法直接刪除螟碎,不希望以后有人再使用它時眉菱,可以添加 @Deprecated 注解進行標記。在文檔注釋中添加 @deprecated 來進行解釋掉分,并提供可替代方案

正例:
/**
 * 保存
 *
 * @deprecated 此方法效率較低俭缓,請使用{@link newSave()}方法替換它
 */
@Deprecated
public void save(){
    // do something
}

16、禁止使用構(gòu)造方法 BigDecimal(double)

BigDecimal(double) 存在精度損失風(fēng)險酥郭,在精確計算或值比較的場景中可能會導(dǎo)致業(yè)務(wù)邏輯異常华坦。

反例:
BigDecimal value = new BigDecimal(0.1D); // 0.100000000000000005551115...

=========================================================================================

正例:
BigDecimal value = BigDecimal.valueOf(0.1D);; // 0.1

17、返回空數(shù)組和空集合而不是 null

返回 null 不从,需要調(diào)用方強制檢測 null 季春,否則就會拋出空指針異常。返回空數(shù)組或空集合消返,有效地避免了調(diào)用方因為未檢測 null 而拋出空指針異常,還可以刪除調(diào)用方檢測 null 的語句使代碼更簡潔耘拇。

反例:
ublic static Result[] getResults() {
    return null;
}
public static List<Result> getResultList() {
    return null;
}
public static Map<String, Result> getResultMap() {
    return null;
}
public static void main(String[] args) {
    Result[] results = getResults();
    if (results != null) {
        for (Result result : results) {
            ...
        }
    }
    List<Result> resultList = getResultList();
    if (resultList != null) {
        for (Result result : resultList) {
            ...
        }
    }
    Map<String, Result> resultMap = getResultMap();
    if (resultMap != null) {
        for (Map.Entry<String, Result> resultEntry : resultMap) {
            ...
        }
    }
}

=========================================================================================

正例:
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();
}
public static void main(String[] args) {
    Result[] results = getResults();
    for (Result result : results) {
        ...
    }
    List<Result> resultList = getResultList();
    for (Result result : resultList) {
        ...
    }
    Map<String, Result> resultMap = getResultMap();
    for (Map.Entry<String, Result> resultEntry : resultMap) {
        ...
    }
}

18撵颊、優(yōu)先使用常量或確定值來調(diào)用 equals 方法

對象的 equals 方法容易拋空指針異常,應(yīng)使用常量或確定有值的對象來調(diào)用 equals 方法惫叛。當然倡勇,使用java.util.Objects.equals() 方法是最佳實踐。

反例:
public void isFinished(OrderStatus status) {
    return status.equals(OrderStatus.FINISHED); // 可能拋空指針異常
}

=========================================================================================

正例:
public void isFinished(OrderStatus status) {
    return OrderStatus.FINISHED.equals(status);
}
public void isFinished(OrderStatus status) {
    return Objects.equals(status, OrderStatus.FINISHED);
}

19嘉涌、枚舉的屬性字段必須是私有不可變

枚舉通常被當做常量使用妻熊,如果枚舉中存在公共屬性字段或設(shè)置字段方法,那么這些枚舉常量的屬性很容易被修改仑最。理想情況下扔役,枚舉中的屬性字段是私有的,并在私有構(gòu)造函數(shù)中賦值警医,沒有對應(yīng)的 Setter 方法亿胸,最好加上 final 修飾符坯钦。

反例:
public enum UserStatus {
    DISABLED(0, "禁用"),
    ENABLED(1, "啟用");
    public int value;
    private String description;
    private UserStatus(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 UserStatus {
    DISABLED(0, "禁用"),
    ENABLED(1, "啟用");
    private final int value;
    private final String description;
    private UserStatus(int value, String description) {
        this.value = value;
        this.description = description;
    }
    public int getValue() {
        return value;
    }
    public String getDescription() {
        return description;
    }
}

20、小心 String.split(String regex)

字符串 String 的 split 方法侈玄,傳入的分隔字符串是 正則表達式婉刀!部分關(guān)鍵字(比如.|等)需要轉(zhuǎn)義

反例:
"a.ab.abc".split("."); // 結(jié)果為[]
"a|ab|abc".split("|"); // 結(jié)果為["a", "|", "a", "b", "|", "a", "b", "c"]

=========================================================================================

正例:
"a.ab.abc".split("\\."); // 結(jié)果為["a", "ab", "abc"]
"a|ab|abc".split("\\|"); // 結(jié)果為["a", "ab", "abc"]

總結(jié)

這篇文章,可以說是從事 Java 開發(fā)的經(jīng)驗總結(jié)序仙,分享出來以供大家參考突颊。希望能幫大家避免踩坑,讓代碼更加高效優(yōu)雅潘悼。

原文鏈接: https://mp.weixin.qq.com/s/O3vj-Pcy6eCtw6p4dgcNdw

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末律秃,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子挥等,更是在濱河造成了極大的恐慌友绝,老刑警劉巖,帶你破解...
    沈念sama閱讀 221,635評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件肝劲,死亡現(xiàn)場離奇詭異迁客,居然都是意外死亡,警方通過查閱死者的電腦和手機辞槐,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,543評論 3 399
  • 文/潘曉璐 我一進店門掷漱,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人榄檬,你說我怎么就攤上這事卜范。” “怎么了鹿榜?”我有些...
    開封第一講書人閱讀 168,083評論 0 360
  • 文/不壞的土叔 我叫張陵海雪,是天一觀的道長。 經(jīng)常有香客問我舱殿,道長奥裸,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 59,640評論 1 296
  • 正文 為了忘掉前任沪袭,我火速辦了婚禮湾宙,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘冈绊。我一直安慰自己侠鳄,他們只是感情好,可當我...
    茶點故事閱讀 68,640評論 6 397
  • 文/花漫 我一把揭開白布死宣。 她就那樣靜靜地躺著伟恶,像睡著了一般。 火紅的嫁衣襯著肌膚如雪十电。 梳的紋絲不亂的頭發(fā)上知押,一...
    開封第一講書人閱讀 52,262評論 1 308
  • 那天叹螟,我揣著相機與錄音,去河邊找鬼台盯。 笑死罢绽,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的静盅。 我是一名探鬼主播良价,決...
    沈念sama閱讀 40,833評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼蒿叠!你這毒婦竟也來了明垢?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,736評論 0 276
  • 序言:老撾萬榮一對情侶失蹤市咽,失蹤者是張志新(化名)和其女友劉穎痊银,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體施绎,經(jīng)...
    沈念sama閱讀 46,280評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡溯革,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,369評論 3 340
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了谷醉。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片致稀。...
    茶點故事閱讀 40,503評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖俱尼,靈堂內(nèi)的尸體忽然破棺而出抖单,到底是詐尸還是另有隱情,我是刑警寧澤遇八,帶...
    沈念sama閱讀 36,185評論 5 350
  • 正文 年R本政府宣布矛绘,位于F島的核電站,受9級特大地震影響刃永,放射性物質(zhì)發(fā)生泄漏蔑歌。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,870評論 3 333
  • 文/蒙蒙 一揽碘、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧园匹,春花似錦雳刺、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,340評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至供汛,卻和暖如春枪汪,著一層夾襖步出監(jiān)牢的瞬間涌穆,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,460評論 1 272
  • 我被黑心中介騙來泰國打工雀久, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留宿稀,地道東北人。 一個月前我還...
    沈念sama閱讀 48,909評論 3 376
  • 正文 我出身青樓赖捌,卻偏偏與公主長得像祝沸,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子越庇,可洞房花燭夜當晚...
    茶點故事閱讀 45,512評論 2 359

推薦閱讀更多精彩內(nèi)容

  • 整理來自互聯(lián)網(wǎng) 1罩锐,JDK:Java Development Kit,java的開發(fā)和運行環(huán)境卤唉,java的開發(fā)工具...
    Ncompass閱讀 1,540評論 0 6
  • 一:java概述: 1涩惑,JDK:Java Development Kit,java的開發(fā)和運行環(huán)境桑驱,java的開發(fā)...
    慕容小偉閱讀 1,796評論 0 10
  • 一:java概述:1竭恬,JDK:Java Development Kit,java的開發(fā)和運行環(huán)境碰纬,java的開發(fā)工...
    ZaneInTheSun閱讀 2,661評論 0 11
  • 一萍聊、基礎(chǔ)知識:1、JVM悦析、JRE和JDK的區(qū)別:JVM(Java Virtual Machine):java虛擬機...
    殺小賊閱讀 2,388評論 0 4
  • 今天我上了一天的課寿桨,很勞累。但是呢强戴,有兩節(jié)課亭螟。我覺得他們上的特別特別的快。兩節(jié)課骑歹,其中一節(jié)是數(shù)學(xué)課预烙。還有一節(jié)是語文...
    楊小魚兒0728閱讀 299評論 0 1