MyBatis-Plus 使用枚舉自動(dòng)關(guān)聯(lián)注入
什么是枚舉自動(dòng)注入?
官方文檔是這么解釋的
解決了繁瑣的配置,讓 mybatis 優(yōu)雅的使用枚舉屬性!
按我的理解是維護(hù)在內(nèi)存中且不易修改的輕量級(jí)字典。目前覺得這個(gè)功能的使用場景相對(duì)有限,但是如果有用到的話開箱即用也是很棒的。廢話不多說,接下來讓我們看一下它的實(shí)際效果吧。
實(shí)際效果
通常情況下,我們會(huì)這樣聲明一個(gè)用戶實(shí)體
public class User { private String id; private String name; private Integer age; private String phone; //省略getter&setter&constructor ... }
那么最終獲取到的JSON數(shù)據(jù)應(yīng)該類似于這樣
{ id: "1", name: "張三", age: 18, phone: "10000" }
如若使用MyBatis-Plus的枚舉自動(dòng)關(guān)聯(lián)注入,可以更優(yōu)雅的實(shí)現(xiàn)如下效果
{ id: "1", name: "張三", age: "十八歲", phone: "中國電信" }
實(shí)現(xiàn)步驟
實(shí)現(xiàn)過程僅有三步且非常簡單,代碼量也非常的少,下面介紹一下實(shí)現(xiàn)步驟。
1.創(chuàng)建兩個(gè)枚舉對(duì)象,分別為AgeEnum與PhoneEnum,這里使用枚舉建立一個(gè)映射關(guān)系。
public enum AgeEnum implements IEnum { ONE(1, "一歲"), TWO(2, "二歲"); private int age; private String desc; AgeEnum(final int age, final String desc) { this.age = age; this.desc = desc; } @Override public Serializable getValue() { return this.age; } @JsonValue public String getDesc(){ return this.desc; } }
public enum PhoneEnum implements IEnum { CMCC("10086", "中國移動(dòng)"), CUCC("10010", "中國聯(lián)通"), CT("10000", "中國電信"); private String phone; private String desc; PhoneEnum(final String phone, final String desc) { this.phone = phone; this.desc = desc; } @Override public Serializable getValue() { return this.phone; } @JsonValue public String getDesc(){ return this.desc; } }
注意:
- @JsonValue是使用JackSon解析時(shí)有效,若使用fastjson,請(qǐng)看官方文檔提供的解決方案
- 不要把@JsonValue打成@JsonView了,否則自動(dòng)關(guān)聯(lián)注入的是枚舉名(name屬性),如下所示
- 別忘記實(shí)現(xiàn)IEnum接口,否則自動(dòng)關(guān)聯(lián)注入的是枚舉名(name屬性),如下所示
{ id: "1", name: "張三", age: "十八歲", phone: "CT" }
2.將User實(shí)體中的屬性替換為枚舉,例如
public class User { private String id; private String name; private AgeEnum age; private PhoneEnum phone; //省略getter&setter&constructor ... }
3.配置掃描枚舉,添加如下配置
mybatis-plus.typeEnumsPackage=com.xxx.xxx.enums//枚舉所在路徑
至此,使用MyBatis-Plus的枚舉自動(dòng)關(guān)聯(lián)注入就完成了。
踩坑
在使用枚舉自動(dòng)關(guān)聯(lián)注入時(shí),還踩了一個(gè)坑。在代碼正確的情況下出現(xiàn)了如下問題。
{ id: null, name: null, age: null, phone: null }
查出的所有值都為null,通過DEBUG跟蹤代碼發(fā)現(xiàn)問題。數(shù)據(jù)庫中將實(shí)體中的某個(gè)枚舉屬性設(shè)置為了tinyint類型,在數(shù)據(jù)庫中存儲(chǔ)的值是1,枚舉中也是使用1來映射關(guān)系,然而MyBaits-Plus在獲取值是卻讀成了true,因此枚舉并沒有映射成功,返回null值。
當(dāng)獲取IsEnableEnum的枚舉時(shí),會(huì)執(zhí)行這行代碼獲取枚舉中的關(guān)系映射
EnumUtils.valueOf(this.type, rs.getObject(columnName));
但是MyBatis讀取到的值變成了true
無法正確匹配到映射的值,返回null值,IsEnableEnum中聲明的映射關(guān)系如下。
ENABLE(1, "可用"), LIMIT(-1, "禁用");
解決方法
1.將表中IsEnableEnum枚舉對(duì)應(yīng)的字段is_enable類型由tinyint改為int即可,這種解決方法的優(yōu)點(diǎn)就是不用修改代碼就解決問題。
2.MySQL中tinyint(1)對(duì)應(yīng)Java中的boolean類型,非0為true,0為false。因此修改IsEnableEnum中的映射關(guān)系,如下。
ENABLE(true, "可用"), LIMIT(false, "禁用");
參數(shù)解析
當(dāng)使用枚舉注入的方式時(shí),作為參數(shù)解析如果不注意會(huì)出現(xiàn)解析異常的情況。這里以修改User的is_enable值(數(shù)據(jù)庫表中字段屬性設(shè)置為int)為例看下具體解析異常情況的問題。例如,我們需要通過下面這個(gè)接口接收J(rèn)SON請(qǐng)求參數(shù)來修改用戶的信息。
@PostMapping public User saveUser(@RequestBody User user) { return userService.insertOrUpdate(user) ? userService.selectById(user.getId()) : null; }
使用Postman模擬請(qǐng)求,JSON參數(shù)
{ "id":"922000984245391362", "isEnable":-1 }
響應(yīng)結(jié)果
{ "timestamp": "2018-05-12T04:20:15.920+0000", "status": 400, "error": "Bad Request", "exception": "org.springframework.http.converter.HttpMessageNotReadableException", "message": "JSON parse error: Can not deserialize value of type com.github.common.domain.enums.IsEnableEnum from number -1: index value outside legal index range [0..1]; nested exception is com.fasterxml.jackson.databind.exc.InvalidFormatException: Can not deserialize value of type com.github.common.domain.enums.IsEnableEnum from number -1: index value outside legal index range [0..1]\n at [Source: java.io.PushbackInputStream@25386a8e; line: 3, column: 13] (through reference chain: com.github.common.domain.User[\"isEnable\"])", "path": "/" }
從錯(cuò)誤信息我們可知,無法將-1映射成IsEnableEnum枚舉,可用范圍是0..1,那么應(yīng)該怎么解決呢?
自己摸索出的解決方式有兩種,分別為
使用value屬性映射,經(jīng)過測試0對(duì)應(yīng)的是ENABLE(1, "可用"),1對(duì)應(yīng)的是LIMIT(-1, "禁用")。很奇葩吧,因此不推薦此方式。
使用desc屬性映射,將JSON請(qǐng)求參數(shù)改成如下就可以解析成功不報(bào)錯(cuò)。
{ "id":"922000984245391362", "isEnable":"禁用" }
總結(jié)
MyBatis-Plus這個(gè)特性目前用的還是不多,本質(zhì)上其實(shí)還是把映射關(guān)系寫死在代碼中且個(gè)人覺得設(shè)計(jì)有些許不合理的地方,并不能替代字典,因此還是推薦使用字典方式,可以動(dòng)態(tài)的修改映射關(guān)系。當(dāng)項(xiàng)目遇到希望使用比字典更輕更快更容易上手的場景時(shí),可以嘗試使用枚舉注入的方式。
針對(duì)于解決方法的選擇個(gè)人想法是,當(dāng)存儲(chǔ)的值僅有兩個(gè)且關(guān)系相對(duì)時(shí),可以使用方法二,而在任何場景下方法一都適用,因此個(gè)人比較推薦方法一,因?yàn)榭梢源鎯?chǔ)更多的值和映射關(guān)系,例如上文的電話號(hào)碼枚舉。
最后,貼上MyBatis-Plus的官方文檔,強(qiáng)烈推薦小伙伴們?nèi)L試使用,非常棒的一個(gè)開源項(xiàng)目。
到此這篇關(guān)于MyBatis-Plus 使用枚舉自動(dòng)關(guān)聯(lián)注入的文章就介紹到這了,更多相關(guān)MyBatis-Plus 枚舉自動(dòng)關(guān)聯(lián)注入內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Java中如何快速構(gòu)建項(xiàng)目腳手架的實(shí)現(xiàn)
這篇文章主要介紹了Java中如何快速構(gòu)建項(xiàng)目腳手架,文中通過示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2022-05-05mybatis-flex實(shí)現(xiàn)鏈?zhǔn)讲僮鞯氖纠a
MyBatis-Flex它提供了一種鏈?zhǔn)讲僮鞣绞?本文主要介紹了mybatis-flex實(shí)現(xiàn)鏈?zhǔn)讲僮鞯氖纠a,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2024-06-06springboot自動(dòng)配置沒有生效的問題定位(條件斷點(diǎn))
這篇文章主要介紹了springboot自動(dòng)配置未生效問題定位,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,下面我們來學(xué)習(xí)一下吧2019-06-06SpringMVC后端返回?cái)?shù)據(jù)到前端代碼示例
這篇文章主要介紹了SpringMVC后端返回?cái)?shù)據(jù)到前端代碼示例,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-04-04使用純Java實(shí)現(xiàn)一個(gè)WebSSH項(xiàng)目的示例代碼
這篇文章主要介紹了使用純Java實(shí)現(xiàn)一個(gè)WebSSH項(xiàng)目,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-03-03SpringBoot實(shí)現(xiàn)異步消息處理的代碼示例
在現(xiàn)代應(yīng)用程序中,異步消息處理是一項(xiàng)至關(guān)重要的任務(wù)。它可以提高應(yīng)用程序的性能、可伸縮性和可靠性,同時(shí)也可以提供更好的用戶體驗(yàn),本文將介紹如何使用Spring Boot實(shí)現(xiàn)異步消息處理,并提供相應(yīng)的代碼示例2023-06-06