原文地址：https://mp.weixin.qq.com/s/-YQsD6jJuxewFjQtyX16UA

明代王陽明先生在《傳習(xí)錄》談為學(xué)之道時說：

私欲日生，如地上塵，一日不掃，便又有一層。著實用功，便見道無終窮，愈探愈深，必使精白無一毫不徹方可。

代碼中的 " 壞味道 "，如 " 私欲 " 如 " 灰塵 "，每天都在增加，一日不去清除，便會越累越多。如果用功去清除這些 " 壞味道 "，不僅能提高自己的編碼水平，也能使代碼變得 " 精白無一毫不徹 "。這里，整理了日常工作中的一些 " 壞味道 "，及清理方法，供大家參考。

讓代碼性能更高

需要 Map 的主鍵和取值時，應(yīng)該迭代 entrySet()

當(dāng)循環(huán)中只需要 Map 的主鍵時，迭代 keySet() 是正確的。但是，當(dāng)需要主鍵和取值時，迭代 entrySet() 才是更高效的做法，比先迭代 keySet() 后再去 get 取值性能更佳。

反例：

復(fù)制代碼

?	Map<String, String> map = ...;
?	for (String key : map.keySet()) {
?	String value = map.get(key);
?	...
?	}

正例：

復(fù)制代碼

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

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

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

反例：

復(fù)制代碼

?	if (collection.size() == 0) {
?	...
?	}

正例：

復(fù)制代碼

?	if (collection.isEmpty()) {
?	...
?	}

如果需要還需要檢測 null ，可采用 CollectionUtils.isEmpty(collection) 和 CollectionUtils.isNotEmpty(collection)。

不要把集合對象傳給自己

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

反例：

復(fù)制代碼

?	List<String> list = new ArrayList<>();
?	list.add("Hello");
?	list.add("World");
?	if (list.containsAll(list)) { // 無意義, 總是返回 true
?	...
?	}
?	list.removeAll(list); // 性能差, 直接使用 clear()

集合初始化盡量指定大小

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

反例：

復(fù)制代碼

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

正例：

復(fù)制代碼

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

字符串拼接使用 StringBuilder

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

反例：

復(fù)制代碼

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

正例：

復(fù)制代碼

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

List 的隨機(jī)訪問

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

正例：

復(fù)制代碼

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

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

反例：

復(fù)制代碼

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

正例：

復(fù)制代碼

?	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);
?	}

讓代碼更優(yōu)雅

長整型常量后添加大寫 L

在使用長整型常量值時，后面需要添加 L ，必須是大寫的 L ，不能是小寫的 l ，小寫 l 容易跟數(shù)字 1 混淆而造成誤解。

反例：

復(fù)制代碼

?	long value = 1l;
?	long max = Math.max(1L, 5);

正例：

復(fù)制代碼

?	long value = 1L;
?	long max = Math.max(1L, 5L);

不要使用魔法值

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

反例：

復(fù)制代碼

?	for (int i = 0; i < 100; i++){
?	...
?	}
?	if (a == 100) {
?	...
?	}

正例：

復(fù)制代碼

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

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

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

反例：

復(fù)制代碼

?	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");
?	}
?	};

正例：

復(fù)制代碼

?	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");
?	};

建議使用 try-with-resources 語句

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

反例：

復(fù)制代碼

?	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) {
?	...
?	}
?	}
?	}
?	}

正例：

復(fù)制代碼

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

刪除未使用的私有方法和字段

刪除未使用的私有方法和字段，使代碼更簡潔更易維護(hù)。若有需要再使用，可以從歷史提交中找回。

反例：

復(fù)制代碼

?	public class DoubleDemo1 {
?	private int unusedField = 100;
?	private void unusedMethod() {
?	...
?	}
?	public int sum(int a, int b) {
?	return a + b;
?	}
?	}

正例：

復(fù)制代碼

?	public class DoubleDemo1 {
?	public int sum(int a, int b) {
?	return a + b;
?	}
?	}

刪除未使用的局部變量

刪除未使用的局部變量，使代碼更簡潔更易維護(hù)。

反例：

復(fù)制代碼

?	public int sum(int a, int b) {
?	int c = 100;
?	return a + b;
?	}

正例：

復(fù)制代碼

?	public int sum(int a, int b) {
?	return a + b;
?	}

刪除未使用的方法參數(shù)

未使用的方法參數(shù)具有誤導(dǎo)性，刪除未使用的方法參數(shù)，使代碼更簡潔更易維護(hù)。但是，由于重寫方法是基于父類或接口的方法定義，即便有未使用的方法參數(shù)，也是不能刪除的。

反例：

復(fù)制代碼

?	public int sum(int a, int b, int c) {
?	return a + b;
?	}

正例：

復(fù)制代碼

?	public int sum(int a, int b) {
?	return a + b;
?	}

刪除表達(dá)式的多余括號

對應(yīng)表達(dá)式中的多余括號，有人認(rèn)為有助于代碼閱讀，也有人認(rèn)為完全沒有必要。對于一個熟悉 Java 語法的人來說，表達(dá)式中的多余括號反而會讓代碼顯得更繁瑣。

反例：

復(fù)制代碼

?	return (x);
?	return (x + 2);
?	int x = (y * 3) + 1;
?	int m = (n * 4 + 2);

正例：

復(fù)制代碼

?	return x;
?	return x + 2;
?	int x = y * 3 + 1;
?	int m = n * 4 + 2;

工具類應(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ù)。

反例：

復(fù)制代碼

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

正例：

復(fù)制代碼

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

刪除多余的異常捕獲并拋出

用 catch 語句捕獲異常后，什么也不進(jìn)行處理，就讓異常重新拋出，這跟不捕獲異常的效果一樣，可以刪除這塊代碼或添加別的處理。

反例：

復(fù)制代碼

?	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;
?	}
?	}

正例：

復(fù)制代碼

?	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();
?	}
?	}

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

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

反例：

復(fù)制代碼

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

正例：

復(fù)制代碼

?	public class User {
?	public static final String CONST_NAME = "name";
?	...
?	}
?	?
?	String nameKey = User.CONST_NAME;

不要用 NullPointerException 判斷空

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

反例：

復(fù)制代碼

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

正例：

復(fù)制代碼

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

使用 String.valueOf(value) 代替 ""+value

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

反例：

復(fù)制代碼

?	int i = 1;
?	String s = "" + i;

正例：

復(fù)制代碼

?	int i = 1;
?	String s = String.valueOf(i);

過時代碼添加 @Deprecated 注解

當(dāng)一段代碼過時，但為了兼容又無法直接刪除，不希望以后有人再使用它時，可以添加 @Deprecated 注解進(jìn)行標(biāo)記。在文檔注釋中添加 @deprecated 來進(jìn)行解釋，并提供可替代方案

正例：

復(fù)制代碼

?	/**
?	* 保存
?	*
?	* @deprecated 此方法效率較低，請使用{@link newSave()}方法替換它
?	*/
?	@Deprecated
?	public void save(){
?	// do something
?	}

讓代碼遠(yuǎn)離 bug

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

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

反例：

復(fù)制代碼

?	BigDecimal value = new BigDecimal(0.1D); // 0.100000000000000005551115...

正例：

復(fù)制代碼

?	BigDecimal value = BigDecimal.valueOf(0.1D);; // 0.1

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

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

反例：

復(fù)制代碼

?	public 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) {
?	...
?	}
?	}
?	}

正例：

復(fù)制代碼

?	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) {
?	...
?	}
?	}

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

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

反例：

復(fù)制代碼

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

正例：

復(fù)制代碼

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

枚舉的屬性字段必須是私有不可變

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

反例：

復(fù)制代碼

?	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;
?	}
?	}

正例：

復(fù)制代碼

?	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;
?	}
?	}
?	?
?	?

小心 String.split(String regex)

字符串 String 的 split 方法，傳入的分隔字符串是正則表達(dá)式！部分關(guān)鍵字（比如.| 等）需要轉(zhuǎn)義

反例：

復(fù)制代碼

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

正例：

復(fù)制代碼

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

總結(jié)

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

轉(zhuǎn)載于:https://www.cnblogs.com/davidwang456/articles/11561296.html

《新程序員》：云原生和全面數(shù)字化實踐50位技術(shù)專家共同創(chuàng)作，文字、視頻、音頻交互閱讀

總結(jié)

以上是生活随笔為你收集整理的消灭 Java 代码的“坏味道”【转】的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。