一不小心就踩了Lombok的坑?
引言
今天中午正在帶著耳機遨游在代碼的世界里,被運營在群里@了,氣沖沖的反問我最近有刪生產的用戶數據的嗎?我肯定客氣的回答道沒有呀?生產的數據我怎么能隨隨便便可以刪除,這可是公司的紅線,再說了我也沒有數據庫的刪除權限啊,不過查詢權限還是有的。趕緊登上堡壘機,然后去生產數據庫查一下數據,查了一下數據是還在的,嚇死了,數據還在問題就不大了,無非就是應用程序出問題了,趕緊打開代碼查看下,為什么會少了一條用戶數據,看了下代碼貌似沒啥問題就是比較簡單的一個邏輯,直接從DB通過分頁查詢數據給到前端,然后前端負責展示,沒有啥復雜的邏輯。心想肯定是前端的問題,肯定是他少展示了數據,立馬把問題也甩給了他,讓他幫忙配合一起看看是否是前端的問題,然后自己也仔細看看代碼,不到一分鐘前端說他展示的數據沒有問題,都是后端給到的,沒有漏掉展示的。那就是后端的bug了羅。肉眼望去覺得可能出問題的就是分頁導致的數據丟了。不過這個分頁插件是全公司都在用,應該不至于出問題吧,找不到問題只能讓測試幫忙在測試環境試試,看看是否可以復現。
測試環境復現
仔細看了一眼,居然有個去重的方法,去重邏輯也比較簡單就是把list通過轉為set去下重,看下來應該就是這個去重方法有問題了 大致寫了單元測試模仿了下生產的數據,大致邏輯如下:
- public static void main(String[] args) {
- Set<UserDTO> userSet = new HashSet<>();
- UserDTO userDTO = new UserDTO();
- userDTO.setId(1);
- userDTO.setUserName("java金融");
- UserDTO userDTO1 = new UserDTO();
- userDTO1.setId(2);
- userDTO1.setUserName("java金融");
- userSet.add(userDTO);
- userSet.add(userDTO1);
- System.out.println(userSet.size());
- System.out.println(userDTO1.equals(userDTO));
- }
- @Data
- static class UserDTO extends BaseDTO {
- private String userName;
- }
- @Data
- static class BaseDTO {
- private Integer id;
- }
我們可以輸出結果set集合的長度是1,user1和user2 是相等的,明明兩個user的ID是不一樣的,為何會相等,我們知道set可以去重 是因為Set的操作,都是通過操作map來實現的,set的add其實就是調用map的put方法,map的put方法我相信大家應該都去看過其源碼,這里就不詳細再說了,大概流程就是通過key通過hash算法定位到數組的下標,先判斷key的hash是否相等,如果相等再去判斷key的value相等,如果都相等就會覆蓋原來的值。我們上面這個例子就是對象的hash和value都相等導致,但是我們的兩個對象user1和user2 應該是不等的,因為ID不等,那為什么會相等列?我們仔細看下上面的代碼,我們使用了lombok里面@Data注解,我們可以看看這個注解幫我們生成了哪些方法
通過上面的對比我們可以看出@Data注解幫我們生成了 注在類上,提供類的get、set、equals、hashCode、canEqual、toString方法,這個注解確實比較方便。上面那個bug 就是因為它生成的equals方法有問題,我們可以把上述代碼編譯下,然后把class 里面生成的equals方法拷貝出來看看
通過上述生成的代碼我們可以看出equals方法只比較了userName這個字段,也就是當前類的字段,并沒有去比較父類的字段,這就是導致兩個對象相等的原因,我們既然找到問題了,那解決問題就比較簡單。
解決問題
- 手動重寫equals和hashCode方法,這種方法肯定是不推薦的,我們既然用了lombok就是為了解放我們的雙手,是代碼變得更加簡潔。
- 在比較的類上加上@EqualsAndHashCode(callSuper = true) callSuper = true 會包含父類的equals 和 hashCode方法 我們可以對比下加上@EqualsAndHashCode(callSuper = true)和沒有加上這個注解生成的equals方法的代碼差異。
圖片差異點還是很明顯的,加入了@EqualsAndHashCode(callSuper = true) 會去調用父類的equals方法比較,所以這個注解也能夠解決這個問題。
- 這樣加上注解確實可以解決問題,但是每個類上面都要加上這個注解,這也是個體力活。我們可以再找找其他的方案,例如有沒有比如配置文件設置下什么的,然后就能全局生效了。最終通過查詢資料發現我們我們寫一個lombok.config的配置文件放在我們項目的根目錄下面,內容寫上lombok.equalsAndHashCode.callSuper = call效果等同于@EqualsAndHashCode(callSuper = true),這樣的話我們就不需要為每個類都去加上這個注釋了,相當于在這個項目下面只要用到了@Data注解的類都會為其加上@EqualsAndHashCode(callSuper = true)通過配置文件的方式就可以全局生效。
總結
- 我們再來回顧下上面的問題,歸根結底還是由于對象的equals方法使用不當引起的,所以我們在如果在判斷自定義對象業務判斷相等的時候需要去重寫下hashCode和equals方法,重寫的時候我們可以通過idea來生成,生成后最好還是去看一眼,看看生成的是否符合我們的業務要求。
- 我們在工作中操作一些常見的容器類比如Set、Map等來實現一些我們自己的業務,我們還是有必要去看看它們的源碼的,就比如我們通過Set來進行去重,如果我們是使用的自定義對象的話,如果沒有重寫hashCode和equals方法的話,去重就會去不成功,我們只有了解了它,才能真正的去用好它。在關于hashCode和equals 阿里巴巴開發手冊也有明確的說到
- lombok 用起來還是挺爽的,但是還是有一些細節需要稍微注意下。使用前可以大概的去看看它的官網提供的內容,不然出現莫名其妙的問題你都不知道如何下手。這個就有點類似于我們使用SpringBoot一樣,用起來非常爽,但是如果遇到莫名其妙的bug解決起來就比較頭疼。
- 最后我們再來回顧幾道關于hashCode和equals的比較常見的面試題?其實如果我們只要真正看過HashMap的源碼的話,這下面幾個面試題還是非常簡單的。什么情況下需要我們去重寫 方法?如果只重寫equals方法不重寫HashCode可以嗎?equals ,== 和hashcode()的區別?
本文轉載自微信公眾號「 java金融」,可以通過以下二維碼關注。轉載本文請聯系 java金融公眾號。