为什么阿里巴巴Java开发手册中强制要求接口返回值不允许使用枚举?
在閱讀《阿里巴巴Java開發(fā)手冊》時,發(fā)現(xiàn)有一條關(guān)于二方庫依賴中接口返回值不允許使用枚舉類型的規(guī)約,具體內(nèi)容如下:
在談?wù)摓槭裁粗跋葋砜破障率裁词嵌綆?#xff0c;二方庫也稱作二方包,一般指公司內(nèi)部發(fā)布到中央倉庫,可供公司內(nèi)部其他應(yīng)用依賴的庫(jar 包)。
那么一方庫便是本工程內(nèi)部子項(xiàng)目模塊依賴的庫;三方庫為公司之外的開源庫,比如像 fastjson、easyexcel 這種。
下面我們就通過一個例子來看下為什么阿里巴巴不允許返回枚舉類型或者包含枚舉類型的 POJO 對象。
比如星巴克提供了 0.0.1 版本的二方庫,定義了一個 Starbucks 類,里面包含了枚舉類型的 SizeEnum,里面分別是中杯、大杯、特大杯。
public class Starbucks implements Serializable {private Long id;private String name;private Integer capacity;private SizeEnum sizeEum; }public enum SizeEnum {TALL(1),GRANDE(2),VENTI(3) }定義了一個服務(wù)類,實(shí)現(xiàn)了根據(jù) id 獲取星巴克的方法:
public class StarbucksImpl implements StarbucksService {public Starbucks getStarbucksById(Long id) {Starbucks starbucks = new Starbucks();starbucks.setId(1L);starbucks.setName("Latte");starbucks.setCapacity(360);starbucks.setSizeEnum(SizeEnum.TALL);return starbucks;} }然后,星巴克的門店引入 0.0.1 這個版本 jar 包,然后賣的好好的:
public class StarbucksDemo {@Resourceprivate StarbucksService starbucksService;public void getStarbucks() {Starbucks starbucks = starbucksService.getStarbucksById(1L);System.out.println(starbucks);} }有一天,老羅說要那個中等大小的中杯拿鐵,但是服務(wù)員說那是大杯,經(jīng)過一番爭論,羅老師很是生氣。
于是星巴克升級到了 0.0.2 版本二方庫,在枚舉類 SizeEnum 中新增了小杯,升級后的枚舉類如下:
public enum SizeEnum {TALL(1),GRANDE(2),VENTI(3),SHORT(4) }同時服務(wù)類的接口方法也做了相應(yīng)修改:
public class StarbucksImpl implements StarbucksService {public Starbucks getStarbucksById(Long id) {Starbucks starbucks = new Starbucks();starbucks.setId(1L);starbucks.setName("Latte");starbucks.setCapacity(240);starbucks.setSizeEnum(SizeEnum.SHORT);return starbucks;} }由于星巴克的門店比較多,有的還不知道這個新加的需求,因此返回結(jié)果中出現(xiàn)了 SHORT,但是 0.0.1 版本的二方庫中沒有小杯啊,所以就出問題了,也就是序列化失敗。
通過這個例子,我相信大家對枚舉類型作為返回結(jié)果有了一定的理解,下面引用孤盡大佬在知乎的回答:
由于升級原因,導(dǎo)致雙方的枚舉類不盡相同,在接口解析,類反序列化時出現(xiàn)異常。
Java 中出現(xiàn)的任何元素,在 Gosling 的角度都會有背后的思考和邏輯(盡管并非絕對完美,但 Java 的頂層抽象已經(jīng)是天才級了),比如:接口、抽象類、注解、和本文提到的枚舉。枚舉有好處,類型安全,清晰直接,還可以使用等號來判斷,也可以用在 switch 中。它的劣勢也是明顯的,就是不要擴(kuò)展。可是為什么在返回值和參數(shù)進(jìn)行了區(qū)分呢,如果不兼容,那么兩個都有問題,怎么允許參數(shù)可以有枚舉。當(dāng)時的考慮,如果參數(shù)也不能用,那么枚舉幾乎無用武之地了。參數(shù)輸出,畢竟是本地決定的,你本地有的,傳送過去,向前兼容是不會有問題的。但如果是接口返回,就比較惡心了,因?yàn)榻馕龌貋淼倪@個枚舉值,可能本地還沒有,這時就會拋出序列化異常。
比如:你的本地枚舉類,有一個天氣 Enum:SUNNY, RAINY, CLOUDY,如果根據(jù)天氣計(jì)算心情的方法:guess(WeatcherEnum xx),傳入這三個值都是可以的。返回值:Weather guess(參數(shù)),那么對方運(yùn)算后,返回一個 SNOWY,本地枚舉里沒有這個值,傻眼了。
總結(jié)
本文通過一個實(shí)例讓大家理解到枚舉類型作為返回結(jié)果的坑,大家可以使用基本類型或者基本類型包裝類來替換掉枚舉類型就可以避免掉這么問題了。
大家對于這條規(guī)約有什么看法,也歡迎留言討論。
有道無術(shù),術(shù)可成;有術(shù)無道,止于術(shù)
歡迎大家關(guān)注Java之道公眾號
好文章,我在看??
總結(jié)
以上是生活随笔為你收集整理的为什么阿里巴巴Java开发手册中强制要求接口返回值不允许使用枚举?的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 查阅文献时向原作者发邮件要文献的简单模板
- 下一篇: 浮点数大数相加求和