以下文章來源于（公眾號：阿里巴巴中間件），作者常意

前言：

中國有句老話叫"事不過三"誉裆，指一個(gè)人犯了同樣的錯(cuò)誤顿颅，一次兩次三次還可以原諒，超過三次就不可原諒了足丢。有人指出這個(gè)“三”是虛數(shù)粱腻，用來泛指多次，所以"事不過三"不包括“三”斩跌。至于"事不過三"包不包括“三”绍些，可能跟每個(gè)人的底線有關(guān)系，屬于哲學(xué)范疇耀鸦，不在本文的討論范圍之內(nèi)遇革。

寫代碼也是如此，同一個(gè)代碼“坑”揭糕，踩第一次叫"長了經(jīng)驗(yàn)"，踩第二次叫"加深印象"锻霎，踩第三次叫"不長心眼"著角，踩三次以上就叫"不可救藥"。在本文中旋恼，筆者總結(jié)了一些代碼坑吏口，描述了問題現(xiàn)象，進(jìn)行了問題分析冰更，給出了避坑方法产徊。希望大家在日常編碼中，遇到了這類代碼坑蜀细，能夠提前避開舟铜。

1.對象比較方法

JDK1.7 提供的 Objects.equals 方法，非常方便地實(shí)現(xiàn)了對象的比較奠衔，有效地避免了繁瑣的空指針檢查谆刨。

1.1.問題現(xiàn)象

在 JDK1.7 之前，在判斷一個(gè)短整型归斤、整型痊夭、長整型包裝數(shù)據(jù)類型與常量是否相等時(shí)，我們一般這樣寫：

Short shortValue = (short)12345;

System.out.println(shortValue == 12345); // true

System.out.println(12345 == shortValue); // true

Integer intValue = 12345;

System.out.println(intValue == 12345); // true

System.out.println(12345 == intValue); // true

Long longValue = 12345L;

System.out.println(longValue == 12345); // true

System.out.println(12345 == longValue); // true

從 JDK1.7 之后脏里，提供了 Objects.equals 方法她我，并推薦使用函數(shù)式編程，更改代碼如下：

Short shortValue = (short)12345;

System.out.println(Objects.equals(shortValue, 12345)); // false

System.out.println(Objects.equals(12345, shortValue)); // false

Integer intValue = 12345;

System.out.println(Objects.equals(intValue, 12345)); // true

System.out.println(Objects.equals(12345, intValue)); // true

Long longValue = 12345L;

System.out.println(Objects.equals(longValue, 12345)); // false

System.out.println(Objects.equals(12345, longValue)); // false

為什么直接把==替換為 Objects.equals 方法會導(dǎo)致輸出結(jié)果不一樣？

1.2.問題分析

通過反編譯第一段代碼番舆，我們得到語句"System.out.println(shortValue == 12345);"的字節(jié)碼指令如下：

7? getstatic java.lang.System.out : java.io.PrintStream [22]

10? aload_1 [shortValue]

11? invokevirtual java.lang.Short.shortValue() : short [28]

14? sipush 12345

17? if_icmpne 24

20? iconst_1

21? goto 25

24? iconst_0

25? invokevirtual java.io.PrintStream.println(boolean) : void [32]

原來酝碳，編譯器會判斷包裝數(shù)據(jù)類型對應(yīng)的基本數(shù)據(jù)類型，并采用這個(gè)基本數(shù)據(jù)類型的指令進(jìn)行比較（比如上面字節(jié)碼指令中的sipush和if_icmpne等）合蔽，相當(dāng)于編譯器自動對常量進(jìn)行了數(shù)據(jù)類型的強(qiáng)制轉(zhuǎn)化击敌。

為什么采用 Objects.equals 方法后，編譯器不自動對常量進(jìn)行數(shù)據(jù)類型的強(qiáng)制轉(zhuǎn)化拴事？通過反編譯第二段代碼沃斤，我們得到語句

"System.out.println(Objects.equals(shortValue, 12345));" 的字節(jié)碼指令如下：

7? getstatic java.lang.System.out : java.io.PrintStream [22]

10? aload_1 [shortValue]

11? sipush 12345

14? invokestatic java.lang.Integer.valueOf(int) : java.lang.Integer [28]

17? invokestatic java.util.Objects.equals(java.lang.Object, java.lang.Object) : boolean [33]

20? invokevirtual java.io.PrintStream.println(boolean) : void [39]

原來，編譯器根據(jù)字面意思刃宵，認(rèn)為常量 12345 默認(rèn)基本數(shù)據(jù)類型是 int 衡瓶，所以會自動轉(zhuǎn)化為包裝數(shù)據(jù)類型 Integer 。

在 Java 語言中牲证，整數(shù)的默認(rèn)數(shù)據(jù)類型是 int 哮针，小數(shù)的默認(rèn)數(shù)據(jù)類型是 double 。

下面來分析一下 Objects.equals 方法的代碼實(shí)現(xiàn)：

public static boolean equals(Object a, Object b) {

return (a == b) || (a != null && a.equals(b));

}

其中坦袍，語句 “a.equals(b)” 將會使用到 Short.equals 方法十厢。

Short.equals 方法的代碼實(shí)現(xiàn)為：

public boolean equals(Object obj) {

if (obj instanceof Short) {

return value == ((Short)obj).shortValue();

}

return false;

}

通過代碼實(shí)現(xiàn)分析：對應(yīng)語句"System.out.println(Objects.equals(shortValue, 12345));"，因?yàn)?Objects.equals 的兩個(gè)參數(shù)對象類型不一致捂齐，一個(gè)是包裝數(shù)據(jù)類型 Short 蛮放，另一個(gè)是包裝數(shù)據(jù)類型 Integer ，所以最終的比較結(jié)果必然是 false 奠宜。同樣包颁，語句 “System.out.println(Objects.equals(intValue, 12345));” ，因?yàn)?Objects.equals 的兩個(gè)參數(shù)對象類型一致压真，都是包裝數(shù)據(jù)類型Integer且取值一樣娩嚼，所以最終的比較結(jié)果必然是 true 。

1.3.避坑方法

1滴肿、保持良好的編碼習(xí)慣岳悟，避免數(shù)據(jù)類型的自動轉(zhuǎn)化

為了避免數(shù)據(jù)類型自動轉(zhuǎn)化，更科學(xué)的寫法是直接聲明常量為對應(yīng)的基本數(shù)據(jù)類型嘴高。

第一段代碼可以這樣寫：

Short shortValue = (short)12345;

System.out.println(shortValue == (short)12345); // true

System.out.println((short)12345 == shortValue); // true

Integer intValue = 12345;

System.out.println(intValue == 12345); // true

System.out.println(12345 == intValue); // true

Long longValue = 12345L;

System.out.println(longValue == 12345L); // true

System.out.println(12345L == longValue); // true

第二段代碼可以這樣寫：

Short shortValue = (short)12345;

System.out.println(Objects.equals(shortValue, (short)12345)); // true

System.out.println(Objects.equals((short)12345, shortValue)); // true

Integer intValue = 12345;

System.out.println(Objects.equals(intValue, 12345)); // true

System.out.println(Objects.equals(12345, intValue)); // true

Long longValue = 12345L;

System.out.println(Objects.equals(longValue, 12345L)); // true

System.out.println(Objects.equals(12345L, longValue)); // true

2竿音、借助開發(fā)工具或插件，及早地發(fā)現(xiàn)數(shù)據(jù)類型不匹配問題

在 Eclipse 的問題窗口中拴驮，我們會看到這樣的提示：

Unlikely argument type for equals(): int seems to be unrelated to Short

Unlikely argument type for equals(): Short seems to be unrelated to int

Unlikely argument type for equals(): int seems to be unrelated to Long

Unlikely argument type for equals(): Long seems to be unrelated to int

通過 FindBugs 插件掃描春瞬，我們會看到這樣的警告：

Call to Short.equals(Integer) in xxx.Xxx.main(String[]) [Scariest(1), High confidence]

Call to Integer.equals(Short) in xxx.Xxx.main(String[]) [Scariest(1), High confidence]

Call to Long.equals(Integer) in xxx.Xxx.main(String[]) [Scariest(1), High confidence]

Call to Integer.equals(Long) in xxx.Xxx.main(String[]) [Scariest(1), High confidence]

3、進(jìn)行常規(guī)性單元測試套啤，盡量把問題發(fā)現(xiàn)在研發(fā)階段

“勿以善小而不為”宽气，不要因?yàn)楦膭雍苄【筒恍枰M(jìn)行單元測試了随常，往往 Bug 都出現(xiàn)在自己過度自信的代碼中。像這種問題萄涯，只要進(jìn)行一次單元測試绪氛，是完全可以發(fā)現(xiàn)問題的。

2.三元表達(dá)式拆包

三元表達(dá)式是 Java 編碼中的一個(gè)固定語法格式：“條件表達(dá)式涝影？表達(dá)式 1 ：表達(dá)式 2 ”枣察。三元表達(dá)式的邏輯為：“如果條件表達(dá)式成立，則執(zhí)行表達(dá)式 1 燃逻，否則執(zhí)行表達(dá)式 2 ”序目。

2.1.問題現(xiàn)象

boolean condition = false;

Double value1 = 1.0D;

Double value2 = 2.0D;

Double value3 = null;

Double result = condition ? value1 * value2 : value3; // 拋出空指針異常

當(dāng)條件表達(dá)式 condition 等于 false 時(shí)，直接把 Double 對象 value3 賦值給 Double 對象result伯襟，按道理沒有問題呀猿涨，為什么會拋出空指針異常（NullPointerException）？

2.2.問題分析

通過反編譯代碼姆怪，我們得到語句"Double result = condition ? value1 * value2 : value3;"的字節(jié)碼指令如下：

17? iload_1 [condition]

18? ifeq 33

21? aload_2 [value1]

22? invokevirtual java.lang.Double.doubleValue() : double [24]

25? aload_3 [value2]

26? invokevirtual java.lang.Double.doubleValue() : double [24]

29? dmul

30? goto 38

33? aload 4 [value3]

35? invokevirtual java.lang.Double.doubleValue() : double [24]

38? invokestatic java.lang.Double.valueOf(double) : java.lang.Double [16]

41? astore 5 [result]

43? getstatic java.lang.System.out : java.io.PrintStream [28]

46? aload 5 [result]

在第 33 行叛赚，加載 Double 對象 value3 到操作數(shù)棧中；在第 35 行稽揭，調(diào)用 Double 對象 value3 的 doubleValue 方法俺附。這個(gè)時(shí)候，由于 value3 是空對象 null 溪掀，調(diào)用? doubleValue? 方法必然拋出拋出空指針異常昙读。但是，為什么要把空對象 value3 轉(zhuǎn)化為基礎(chǔ)數(shù)據(jù)類型 double 膨桥？

查閱相關(guān)資料，得到三元表達(dá)式的類型轉(zhuǎn)化規(guī)則：

若兩個(gè)表達(dá)式類型相同唠叛，返回值類型為該類型只嚣；

若兩個(gè)表達(dá)式類型不同，但類型不可轉(zhuǎn)換艺沼，返回值類型為Object類型册舞；

若兩個(gè)表達(dá)式類型不同，但類型可以轉(zhuǎn)化障般，先把包裝數(shù)據(jù)類型轉(zhuǎn)化為基本數(shù)據(jù)類型调鲸，然后按照基本數(shù)據(jù)類型的轉(zhuǎn)換規(guī)則（byte<short(char)<int<long<float<double）來轉(zhuǎn)化，返回值類型為優(yōu)先級最高的基本數(shù)據(jù)類型挽荡。

根據(jù)規(guī)則分析藐石，表達(dá)式 1（value1 * value2）計(jì)算后返回基礎(chǔ)數(shù)據(jù)類型 double ，表達(dá)式 2（value3） 返回包裝數(shù)據(jù)類型 Double 定拟，根據(jù)三元表達(dá)式的類型轉(zhuǎn)化規(guī)則判斷于微，最終的返回類型為基礎(chǔ)數(shù)據(jù)類型 double 。所以，當(dāng)條件表達(dá)式 condition 等于 false 時(shí)株依，需要把空對象 value3 轉(zhuǎn)化為基礎(chǔ)數(shù)據(jù)類型 double 驱证，于是就調(diào)用了 value3 的 doubleValue 方法拋出了空指針異常。

可以用以下案例驗(yàn)證三元表達(dá)式的類型轉(zhuǎn)化規(guī)則：

boolean condition = false;

Double value1 = 1.0D;

Double value2 = 2.0D;

Double value3 = null;

Integer value4 = null;

// 返回類型為Double,不拋出空指針異常

Double result1 = condition ? value1 : value3;

// 返回類型為double,會拋出空指針異常

Double result2 = condition ? value1 : value4;

// 返回類型為double,不拋出空指針異常

Double result3 = !condition ? value1 * value2 : value3;

// 返回類型為double,會拋出空指針異常

Double result4 = condition ? value1 * value2 : value3;

2.3.避坑方法

1恋腕、盡量避免使用三元表達(dá)式抹锄，可以采用 if-else 語句代替

如果三元表達(dá)式中有算術(shù)計(jì)算和包裝數(shù)據(jù)類型，可以考慮利用 if-else 語句代替荠藤。改寫代碼如下：

boolean condition = false;

Double value1 = 1.0D;

Double value2 = 2.0D;

Double value3 = null;

Double result;

if (condition) {

result = value1 * value2;

} else {

result = value3;

}

2伙单、盡量使用基本數(shù)據(jù)類型，避免數(shù)據(jù)類型的自動轉(zhuǎn)化

如果三元表達(dá)式中有算術(shù)計(jì)算和包裝數(shù)據(jù)類型商源，可以考慮利用 if-else 語句代替车份。改寫代碼如下：

boolean condition = false;

double value1 = 1.0D;

double value2 = 2.0D;

double value3 = 3.0D;

double result = condition ? value1 * value2 : value3;

3、進(jìn)行覆蓋性單元測試牡彻，盡量把問題發(fā)現(xiàn)在研發(fā)階段

像這種問題扫沼，只要編寫一些單元測試用例，進(jìn)行一些覆蓋性測試庄吼，是完全可以提前發(fā)現(xiàn)的缎除。

3.泛型對象賦值

Java 泛型是 JDK1.5 中引入的一個(gè)新特性，其本質(zhì)是參數(shù)化類型总寻，即把數(shù)據(jù)類型做為一個(gè)參數(shù)使用器罐。

3.1.問題現(xiàn)象

在做用戶數(shù)據(jù)分頁查詢時(shí)，因?yàn)楣P誤編寫了如下代碼：

1渐行、PageDataVO.java：/** 分頁數(shù)據(jù)VO類/

@Getter

@Setter

@ToString

@NoArgsConstructor

@AllArgsConstructor

public class PageDataVO {

/* 總共數(shù)量/

private Long totalCount;

/* 數(shù)據(jù)列表 */private List dataList;}

2轰坊、UserDAO.java：/** 用戶DAO接口/

@Mapper

public interface UserDAO {

/* 統(tǒng)計(jì)用戶數(shù)量/

public Long countUser(@Param("query") UserQueryVO query);

/* 查詢用戶信息 */public List queryUser(@Param("query") UserQueryVO query);}

3、UserService.java：/** 用戶服務(wù)類/

@Service

public class UserService {

/* 用戶DAO */@Autowiredprivate UserDAO userDAO;

/** 查詢用戶信息 */

public PageDataVO queryUser(UserQueryVO query) {

List dataList = null;

Long totalCount = userDAO.countUser(query);

if (Objects.nonNull(totalCount) && totalCount.compareTo(0L) > 0) {

dataList = userDAO.queryUser(query);

}

return new PageDataVO(totalCount, dataList);

}

}

4祟印、UserController.java：/** 用戶控制器類/

@Controller

@RequestMapping("/user")

public class UserController {

/* 用戶服務(wù) */@Autowiredprivate UserService userService;

/** 查詢用戶 */

@ResponseBody

@RequestMapping(value = "/query", method = RequestMethod.POST)

public Result<PageDataVO> queryUser(@RequestBody UserQueryVO query) {

PageDataVO pageData = userService.queryUser(query);

return ResultBuilder.success(pageData);

}

}

以上代碼沒有任何編譯問題肴沫，但是卻把 UserDO 中一些涉密字段返回給前端。細(xì)心的讀者可能已經(jīng)發(fā)現(xiàn)了蕴忆，在 UserService 類的 queryUser 方法的語句" return new PageDataVO(totalCount, dataList);"中颤芬，我們把List對象dataList賦值給了PageDataVO的List字段dataList。

問題是：為什么開發(fā)工具不報(bào)編譯錯(cuò)誤啦套鹅？

3.2.問題分析

由于歷史原因站蝠，參數(shù)化類型和原始類型需要兼容。我們以? ArrayList 舉例子卓鹿，來看看如何兼容的菱魔。

以前的寫法：

ArrayList list = new ArrayList();

現(xiàn)在的寫法：

ArrayList list = new ArrayList();

考慮到與以前的代碼兼容，各種對象引用之間傳值吟孙，必然會出現(xiàn)以下的情況：

// 第一種情況

ArrayList list1 = new ArrayList();

// 第二種情況

ArrayList list2 = new ArrayList();

所以豌习， Java 編譯器對以上兩種類型進(jìn)行了兼容存谎，不會出現(xiàn)編譯錯(cuò)誤，但會出現(xiàn)編譯告警肥隆。但是既荚，我的開發(fā)工具在編譯時(shí)真沒出現(xiàn)過告警。

再來分析我們遇到的問題栋艳，實(shí)際上同時(shí)命中了兩種情況：

1恰聘、把 List 對象賦值給 List ，命中了第一種情況吸占；

2晴叨、把 PageDataVO 對象賦值給 PageDataVO ，命中了第二種情況矾屯。

最終的效果就是：我們神奇地把 List 對象賦值給了 List 兼蕊。

問題的根源就是：我們在初始化 PageDataVO 對象時(shí)，沒有要求強(qiáng)制進(jìn)行類型檢查件蚕。

3.3.避坑方法

1孙技、在初始化泛型對象時(shí)，推薦使用 diamond 語法

在《阿里巴巴 Java 開發(fā)手冊》中排作，有這么一條推薦規(guī)則：

【推薦】集合泛型定義時(shí)牵啦，在 JDK7 及以上，使用 diamond 語法或全省略妄痪。說明：菱形泛型哈雏，即 diamond，直接使用<>來指代前邊已經(jīng)指定的類型衫生。正例：

// <> diamond 方式

HashMap<String, String> userCache = new HashMap<>(16);

// 全省略方式

ArrayList users = new ArrayList(10);

其實(shí)裳瘪，初始化泛型對象時(shí)，全省略是不推薦的罪针。這樣會避免類型檢查盹愚，從而造成上面的問題。

在初始化泛型對象時(shí)站故，推薦使用 diamond 語法，代碼如下：

return new PageDataVO<>(totalCount, dataList);

現(xiàn)在毅舆，在 Eclipse 的問題窗口中西篓，我們會看到這樣的錯(cuò)誤：

Cannot infer type arguments for PageDataVO<>

于是，我們就知道忘了把 List 對象轉(zhuǎn)化為 List 對象了憋活。

2岂津、在進(jìn)行單元測試時(shí)，需要對比數(shù)據(jù)內(nèi)容

在進(jìn)行單元測試時(shí)悦即，運(yùn)行正常是一個(gè)指標(biāo)吮成，但數(shù)據(jù)正確才是更重要的指標(biāo)橱乱。

4.泛型屬性拷貝

Spring 的 BeanUtils.copyProperties 方法，是一個(gè)很好用的屬性拷貝工具方法粱甫。

4.1.問題現(xiàn)象

根據(jù)數(shù)據(jù)庫開發(fā)規(guī)范泳叠，數(shù)據(jù)庫表格必須包含 id，gmt_create茶宵，gmt_modified 三個(gè)字段危纫。其中， id? 這個(gè)字段乌庶，可能根據(jù)數(shù)據(jù)量不同种蝶，采用 int 或 long 類型（注意：阿里規(guī)范要求必須是 long 類型，這里為了舉例說明瞒大，允許為 int 或 long 類型）螃征。

所以，把這三個(gè)字段抽出來透敌，定義了一個(gè) BaseDO 基類：

/** 基礎(chǔ)DO類 */

@Getter

@Setter

@ToString

public class BaseDO {

private T id;

private Date gmtCreate;

private Date gmtModified;

}

針對 user 表盯滚，定義了一個(gè) UserDO 類：

/** 用戶DO類 */

@Getter

@Setter

@ToString

public class UserDO extends BaseDO{

private String name;

private String description;

}

對于查詢接口，定義了一個(gè) UserVO 類：

/** 用戶VO類 */

@Getter

@Setter

@ToString

public static class UserVO {

private Long id;

private String name;

private String description;

}

實(shí)現(xiàn)查詢用戶服務(wù)接口拙泽，實(shí)現(xiàn)代碼如下：/** 用戶服務(wù)類/

@Service

public class UserService {

/* 用戶DAO */@Autowiredprivate UserDAO userDAO;

/** 查詢用戶 */

public List queryUser(UserQueryVO query) {

// 查詢用戶信息

List userDOList = userDAO.queryUser(query);

if (CollectionUtils.isEmpty()) {

return Collections.emptyList();

}

// 轉(zhuǎn)化用戶列表? List userVOList = new ArrayList<>(userDOList.size());? for (UserDO userDO : userDOList) {? ? ? UserVO userVO = new UserVO();? ? ? BeanUtils.copyProperties(userDO, userVO);? ? ? userVOList.add(userVO);? }? // 返回用戶列表? return userVOList;復(fù)制代碼

}

}

通過測試淌山，我們會發(fā)現(xiàn)一個(gè)問題——調(diào)用查詢用戶服務(wù)接口，用戶 ID 的值并沒有返回顾瞻。

[{"description":"This is a tester.","name":"tester"},...]

4.2.問題分析

按道理泼疑，UserDO 類和 UserVO 類的 id 字段，類型都是 Long 類型荷荤，不存在類型不可轉(zhuǎn)化退渗，應(yīng)該能夠正常賦值。嘗試手工賦值蕴纳，代碼如下：

for (UserDO userDO : userDOList) {

UserVO userVO = new UserVO();

userVO.setId(userDO.getId());

userVO.setName(userDO.getName());

userVO.setDescription(userDO.getDescription());

userVOList.add(userVO);

}

經(jīng)過測試会油，上面代碼返回結(jié)果正常，用戶ID的值成功返回古毛。

那么翻翩，就是 BeanUtils.copyProperties 工具方法的問題了。用 Debug 模式運(yùn)行稻薇，進(jìn)入到 BeanUtils.copyProperties 工具方法內(nèi)部嫂冻，得到以下數(shù)據(jù)：

原來， UserDO 類的 getId 方法返回類型不是 Long 類型塞椎，而是被泛型還原成了 Object 類型桨仿。而下面的 ClassUtils.isAssignable 工具方法，判斷是否能夠把 Object 類型賦值給 Long 類型案狠，當(dāng)然會返回 false 導(dǎo)致不能進(jìn)行屬性拷貝服傍。

為什么作者不考慮"先獲取屬性值钱雷，再判斷能否賦值”？建議代碼如下：

Object value = readMethod.invoke(source);

if (Objects.nonNull(value) && ClassUtils.isAssignable(writeMethod.getParameterTypes()[0], value.getClass())) {

... // 賦值相關(guān)代碼

}

4.3.避坑方法

1吹零、不要盲目地相信第三方工具包罩抗，任何工具包都有可能存在問題

在 Java 中，存在很多第三方工具包瘪校，比如：Apache 的 commons-lang3 澄暮、 commons-collections ， Google 的 guava …… 都是很好用的第三方工具包阱扬。但是泣懊，不要盲目地相信第三方工具包，任何工具包都有可能存在問題麻惶。

2馍刮、如果需要拷貝的屬性較少，可以手動編碼進(jìn)行屬性拷貝

用 BeanUtils.copyProperties 反射拷貝屬性窃蹋，主要優(yōu)點(diǎn)是節(jié)省了代碼量卡啰，主要缺點(diǎn)是導(dǎo)致程序性能下降。所以警没，如果需要拷貝的屬性較少匈辱，可以手動編碼進(jìn)行屬性拷貝。

3杀迹、一定要進(jìn)行單元測試亡脸，一定要對比數(shù)據(jù)內(nèi)容

在編寫完代碼后，一定要進(jìn)行單元測試树酪，一定要對比數(shù)據(jù)內(nèi)容浅碾。切莫想當(dāng)然地認(rèn)為：工具包很成熟、代碼也很簡單续语，不可能出現(xiàn)問題垂谢。

5.Set對象排重

在 Java 語言中， Set 數(shù)據(jù)結(jié)構(gòu)可以用于對象排重疮茄，常見的 Set 類有 HashSet 滥朱、 LinkedHashSet 等。

5.1.問題現(xiàn)象

編寫了一個(gè)城市輔助類力试，從 CSV 文件中讀取城市數(shù)據(jù)：/** 城市輔助類/

@Slf4j

public class CityHelper {

/* 測試主方法 */public static void main(String[] args) {Collection cityCollection = readCities2("cities.csv");log.info(JSON.toJSONString(cityCollection));}

/** 讀取城市 */

public static Collection readCities(String fileName) {

try (FileInputStream stream = new FileInputStream(fileName);

InputStreamReader reader = new InputStreamReader(stream, "GBK");

CSVParser parser = new CSVParser(reader, CSVFormat.DEFAULT.withHeader())) {

Set citySet = new HashSet<>(1024);

Iterator iterator = parser.iterator();

while (iterator.hasNext()) {

citySet.add(parseCity(iterator.next()));

}

return citySet;

} catch (IOException e) {

log.warn("讀取所有城市異常", e);

}

return Collections.emptyList();

}

/** 解析城市 */

private static City parseCity(CSVRecord record) {

City city = new City();

city.setCode(record.get(0));

city.setName(record.get(1));

return city;

}

/** 城市類/

@Getter

@Setter

@ToString

private static class City {

/* 城市編碼/

private String code;

/* 城市名稱 */private String name;}}

代碼中使用 HashSet 數(shù)據(jù)結(jié)構(gòu)徙邻，目的是為了避免城市數(shù)據(jù)重復(fù)，對讀取的城市數(shù)據(jù)進(jìn)行強(qiáng)制排重懂版。

當(dāng)輸入文件內(nèi)容如下時(shí)：

編碼,名稱

010,北京

020,廣州

010,北京

解析后的 JSON 結(jié)果如下：

[{"code":"010","name":"北京"},{"code":"020","name":"廣州"},{"code":"010","name":"北京"}]

但是，并沒有對城市“北京”進(jìn)行排重躏率。

5.2.問題分析

當(dāng)向集合 Set 中增加對象時(shí)躯畴，首先集合計(jì)算要增加對象的 hashCode 民鼓，根據(jù)該值來得到一個(gè)位置用來存放當(dāng)前對象。如在該位置沒有一個(gè)對象存在的話蓬抄，那么集合 Set 認(rèn)為該對象在集合中不存在丰嘉，直接增加進(jìn)去。如果在該位置有一個(gè)對象存在的話嚷缭，接著將準(zhǔn)備增加到集合中的對象與該位置上的對象進(jìn)行 equals 方法比較：如果該 equals 方法返回 false 饮亏，那么集合認(rèn)為集合中不存在該對象，就把該對象放在這個(gè)對象之后阅爽；如果 equals 方法返回 true 路幸，那么就認(rèn)為集合中已經(jīng)存在該對象了，就不會再將該對象增加到集合中了付翁。所以简肴，在哈希表中判斷兩個(gè)元素是否重復(fù)要使用到 hashCode 方法和 equals 方法。hashCode 方法決定數(shù)據(jù)在表中的存儲位置百侧，而 equals 方法判斷表中是否存在相同的數(shù)據(jù)砰识。

分析上面的問題，由于沒有重寫 City 類的 hashCode 方法和 equals 方法佣渴，就會采用 Object 類的 hashCode 方法和 equals 方法辫狼。其實(shí)現(xiàn)如下：

public native int hashCode();

public boolean equals(Object obj) {

return (this == obj);

}

可以看出： Object 類的 hashCode 方法是一個(gè)本地方法，返回的是對象地址辛润； Object 類的 equals 方法只比較對象是否相等膨处。所以，對于兩條完全一樣的北京數(shù)據(jù)频蛔，由于在解析時(shí)初始化了不同的 City 對象灵迫，導(dǎo)致 hashCode 方法和 equals 方法值都不一樣，必然被 Set 認(rèn)為是不同的對象晦溪，所以沒有進(jìn)行排重瀑粥。

那么，我們就重寫把 City 類的 hashCode 方法和 equals 方法三圆，代碼如下：/** 城市類/

@Getter

@Setter

@ToString

private static class City {

/* 城市編碼/

private String code;

/* 城市名稱 */private String name;

/** 判斷相等 */

@Override

public boolean equals(Object obj) {

if (obj == this) {

return true;

}

if (Objects.isNull(obj)) {

return false;

}

if (obj.getClass() != this.getClass()) {

return false;

}

return Objects.equals(this.code, ((City)obj).code);

}

/** 哈希編碼 */

@Override

public int hashCode() {

return Objects.hashCode(this.code);

}

}

重新支持測試程序狞换，解析后的JSON結(jié)果如下：

[{"code":"010","name":"北京"},{"code":"020","name":"廣州"}]

結(jié)果正確，已經(jīng)對城市“北京”進(jìn)行排重舟肉。

5.3.避坑方法

1修噪、當(dāng)確定數(shù)據(jù)唯一時(shí)，可以使用List代替Set

當(dāng)確定解析的城市數(shù)據(jù)唯一時(shí)路媚，就沒有必要進(jìn)行排重操作黄琼，可以直接使用 List 來存儲。

List citySet = new ArrayList<>(1024);

Iterator iterator = parser.iterator();

while (iterator.hasNext()) {

citySet.add(parseCity(iterator.next()));

}

return citySet;

2整慎、當(dāng)確定數(shù)據(jù)不唯一時(shí)脏款，可以使用 Map 代替 Set

當(dāng)確定解析的城市數(shù)據(jù)不唯一時(shí)围苫，需要安裝城市名稱進(jìn)行排重操作，可以直接使用 Map 進(jìn)行存儲撤师。為什么不建議實(shí)現(xiàn) City 類的 hashCode 方法剂府，再采用 HashSet 來實(shí)現(xiàn)排重呢？首先剃盾，不希望把業(yè)務(wù)邏輯放在模型 DO 類中腺占；其次，把排重字段放在代碼中痒谴，便于代碼的閱讀衰伯、理解和維護(hù)。

Map<String, City> cityMap = new HashMap<>(1024);

Iterator iterator = parser.iterator();

while (iterator.hasNext()) {

City city = parseCity(iterator.next());

cityMap.put(city.getCode(), city);

}

return cityMap.values();

3闰歪、遵循Java語言規(guī)范嚎研，重寫hashCode方法和equals方法

不重寫hashCode方法和equals方法的自定義類不應(yīng)該在Set中使用。

6.公有方法代理

SpringCGLIB 代理生成的代理類是一個(gè)繼承被代理類库倘，通過重寫被代理類中的非 final 的方法實(shí)現(xiàn)代理临扮。所以， SpringCGLIB? 代理的類不能是 final 類教翩，代理的方法也不能是final 方法杆勇，這是由繼承機(jī)制限制的。

6.1.問題現(xiàn)象

這里舉例一個(gè)簡單的例子饱亿，只有超級用戶才有刪除公司的權(quán)限蚜退，并且所有服務(wù)函數(shù)被 AOP 攔截處理異常。例子代碼如下：

1彪笼、UserService.java：/** 用戶服務(wù)類/

@Service

public class UserService {

/* 超級用戶 */private User superUser;

/** 設(shè)置超級用戶 */

public void setSuperUser(User superUser) {

this.superUser = superUser;

}

/** 獲取超級用戶 */

public final User getSuperUser() {

return this.superUser;

}

}

2钻注、CompanyService.java：/** 公司服務(wù)類/

@Service

public class CompanyService {

/* 公司DAO/

@Autowired

private CompanyDAO companyDAO;

/* 用戶服務(wù) */@Autowiredprivate UserService userService;

/** 刪除公司 */

public void deleteCompany(Long companyId, Long operatorId) {

// 設(shè)置超級用戶

userService.setSuperUser(new User(0L, "admin", "超級用戶"));

// 驗(yàn)證超級用戶? if (!Objects.equals(operatorId, userService.getSuperUser().getId())) {? ? ? throw new ExampleException("只有超級用戶才能刪除公司");? }? // 刪除公司信息? companyDAO.delete(companyId, operatorId);復(fù)制代碼

}

}

3、AopConfiguration.java：/** AOP配置類/

@Slf4j

@Aspect

@Configuration

public class AopConfiguration {

/* 環(huán)繞方法/

@Around("execution(org.changyi.springboot.service...(..))")public Object around(ProceedingJoinPoint joinPoint) {try {log.info("開始調(diào)用服務(wù)方法...");return joinPoint.proceed();} catch (Throwable e) {log.error(e.getMessage(), e);throw new ExampleException(e.getMessage(), e);}}}

當(dāng)我們調(diào)用 CompanyService的deleteCompany 方法時(shí)配猫，居然也拋出空指針異常（NullPointerException）幅恋，因?yàn)檎{(diào)用 UserService 類的 getSuperUser 方法獲取的超級用戶為 null 。但是泵肄，我們在 CompanyService 類的 deleteCompany 方法中捆交，每次都通過 UserService 類的 setSuperUser 方法強(qiáng)制指定了超級用戶，按道理通過 UserService 類的 getSuperUser 方法獲取到的超級用戶不應(yīng)該為 null 腐巢。其實(shí)品追，這個(gè)問題也是由 AOP 代理導(dǎo)致的。

6.2.問題分析

使用SpringCGLIB代理類時(shí)冯丙，Spring會創(chuàng)建一個(gè)名為 UserService$$EnhancerBySpringCGLIB

的代理類肉瓦。反編譯這個(gè)代理類，得到以下主要代碼：

public class UserService$$EnhancerBySpringCGLIB$$a2c3b345 extends UserService implements SpringProxy, Advised, Factory {

......

public final void setSuperUser(User var1) {

MethodInterceptor var10000 = this.CGLIBBIND_CALLBACKS(this);

var10000 = this.CGLIB$CALLBACK_0;

}

if (var10000 != null) {? ? ? var10000.intercept(this, CGLIB$setSuperUser$0$Method, new Object[]{var1}, CGLIB$setSuperUser$0$Proxy);? } else {? ? ? super.setSuperUser(var1);? }復(fù)制代碼

}

......

}

可以看出，這個(gè)代理類繼承了 UserService 類泞莉，代理了 setSuperUser 方法洁墙，但是沒有代理 getSuperUser 方法。所以戒财，當(dāng)我們調(diào)用 setSuperUser 方法時(shí)，設(shè)置的是原始對象實(shí)例的 superUser 字段值捺弦；而當(dāng)我們調(diào)用 getSuperUser 方法時(shí)饮寞，獲取的是代理對象實(shí)例的 superUser 字段值。如果把這兩個(gè)方法的 final 修飾符互換列吼，同樣存在獲取超級用戶為 null 的問題幽崩。

6.3.避坑方法

1、嚴(yán)格遵循 CGLIB 代理規(guī)范寞钥，被代理的類和方法不要加 final 修飾符

嚴(yán)格遵循 CGLIB 代理規(guī)范慌申，被代理的類和方法不要加 final 修飾符，避免動態(tài)代理操作對象實(shí)例不同（原始對象實(shí)例和代理對象實(shí)例）理郑，從而導(dǎo)致數(shù)據(jù)不一致或空指針問題蹄溉。

2、縮小 CGLIB 代理類的范圍您炉，能不用被代理的類就不要被代理

縮小 CGLIB 代理類的范圍柒爵，能不用被代理的類就不要被代理，即可以節(jié)省內(nèi)存開銷赚爵，又可以提高函數(shù)調(diào)用效率棉胀。

7.公有字段代理

在 fastjson 強(qiáng)制升級到 1.2.60 時(shí)踩過一個(gè)坑，作者為了開發(fā)快速冀膝，在 ParseConfig 中定義了：

public class ParseConfig {

public final SymbolTable symbolTable = new SymbolTable(4096);

......

}

在我們的項(xiàng)目中繼承了該類唁奢，同時(shí)又被 AOP 動態(tài)代理了，于是一行代碼引起了一場“血案”窝剖。

7.1.問題現(xiàn)象

仍然使用上章的例子麻掸，但是把獲取、設(shè)置方法刪除枯芬，定義了一個(gè)公有字段论笔。例子代碼如下：

1、UserService.java：/** 用戶服務(wù)類/

@Service

public class UserService {

/* 超級用戶 */public final User superUser = new User(0L, "admin", "超級用戶");......}

2千所、CompanyService.java：/** 公司服務(wù)類/

@Service

public class CompanyService {

/* 公司DAO/

@Autowired

private CompanyDAO companyDAO;

/* 用戶服務(wù) */@Autowiredprivate UserService userService;

/** 刪除公司 */

public void deleteCompany(Long companyId, Long operatorId) {

// 驗(yàn)證超級用戶

if (!Objects.equals(operatorId, userService.superUser.getId())) {

throw new ExampleException("只有超級用戶才能刪除公司");

}

// 刪除公司信息? companyDAO.delete(companyId, operatorId);復(fù)制代碼

}

}

3狂魔、AopConfiguration.java：

同上一章 AopConfiguration.java 。

當(dāng)我們調(diào)用 CompanyService的deleteCompany 方法時(shí)淫痰，居然拋出空指針異常（NullPointerException）最楷。經(jīng)過調(diào)試打印，發(fā)現(xiàn)是 UserService的superUser 變量為null。如果把AopConfiguration刪除籽孙，就不會出現(xiàn)空指針異常烈评，說明這個(gè)問題是由AOP代理導(dǎo)致的。

7.2.問題分析

使用 SpringCGLIB 代理類時(shí)犯建， Spring 會創(chuàng)建一個(gè)名為 UserService$$EnhancerBySpringCGLIB$$???????? 的代理類讲冠。這個(gè)代理類繼承了 UserService 類，并覆蓋了 UserService 類中的所有非 final 的 public 的方法适瓦。但是竿开，這個(gè)代理類并不調(diào)用 super 基類的方法；相反玻熙，它會創(chuàng)建的一個(gè)成員 userService 并指向原始的 UserService 類對象實(shí)例》癫剩現(xiàn)在，內(nèi)存中存在兩個(gè)對象實(shí)例：一個(gè)是原始的 UserService 對象實(shí)例嗦随，另一個(gè)指向 UserService 的代理對象實(shí)例列荔。這個(gè)代理類只是一個(gè)虛擬代理，它繼承了 UserService 類枚尼，并且具有與 UserService 相同的字段贴浙，但是它從來不會去初始化和使用它們。所以署恍，一但通過這個(gè)代理類對象實(shí)例獲取公有成員變量時(shí)悬而，將返回一個(gè)默認(rèn)值 null 。

7.3.避坑方法

1锭汛、當(dāng)確定字段不可變時(shí)笨奠，可以定義為公有靜態(tài)常量

當(dāng)確定字段不可變時(shí)，可以定義為公有靜態(tài)常量唤殴，并用類名稱+字段名稱訪問般婆。類名稱+字段名稱訪問公有靜態(tài)常量，與類實(shí)例的動態(tài)代理無關(guān)朵逝。/** 用戶服務(wù)類/

@Service

public class UserService {

/* 超級用戶 */public static final User SUPER_USER = new User(0L, "admin", "超級用戶");......}

/** 使用代碼 */

if (!Objects.equals(operatorId, UserService.SUPER_USER.getId())) {

throw new ExampleException("只有超級用戶才能刪除公司");

}

2蔚袍、當(dāng)確定字段不可變時(shí)，可以定義為私有成員變量

當(dāng)確定字段不可變時(shí)配名，可以定義為私有成員變量啤咽，提供一個(gè)公有方法獲取該變量值。當(dāng)該類實(shí)例被動態(tài)代理時(shí)渠脉，代理方法會調(diào)用被代理方法宇整，從而返回被代理類的成員變量值。/** 用戶服務(wù)類/

@Service

public class UserService {

/* 超級用戶/

private User superUser = new User(0L, "admin", "超級用戶");

/* 獲取超級用戶 */public User getSuperUser() {return this.superUser;}......}

/** 使用代碼 */

if (!Objects.equals(operatorId, userService.getSuperUser().getId())) {

throw new ExampleException("只有超級用戶才能刪除公司");

}

3芋膘、遵循 JavaBean 編碼規(guī)范鳞青，不要定義公有成員變量

遵循 JavaBean 編碼規(guī)范霸饲，不要定義公有成員變量。JavaBean 規(guī)范如下：

(1)JavaBean類必須是一個(gè)公共類臂拓，并將其訪問屬性設(shè)置為public厚脉，如：public class User{......}(2)JavaBean類必須有一個(gè)空的構(gòu)造函數(shù)：類中必須有一個(gè)不帶參數(shù)的公用構(gòu)造器(3)一個(gè)JavaBean類不應(yīng)有公共實(shí)例變量，類變量都為private胶惰，如：private Integer id;(4)屬性應(yīng)該通過一組getter/setter方法來訪問傻工。

后記

人類受益于“類比”思維，舉一反三就是人類的智慧孵滞，每當(dāng)遇到新生事物時(shí)精钮，人們往往用類似的已知事物作為參考，能夠加速對新生事物的認(rèn)知剃斧。而人類又受制于“定勢”思維，因?yàn)橐阎挛锊⒉荒艽硇律挛锖瞿悖藗冇秩菀仔纬上热霝橹鞯母拍钣锥罱K導(dǎo)致對新生事物產(chǎn)生誤判。

? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?轉(zhuǎn)自：阿里巴巴中間件