為什麼阿裡巴巴Java開發手冊中強制要求介面返回值不允許使用枚舉?

来源:https://www.cnblogs.com/wupeixuan/archive/2020/06/06/13055919.html
-Advertisement-
Play Games

在閱讀《阿裡巴巴Java開發手冊》時,發現有一條關於二方庫依賴中介面返回值不允許使用枚舉類型的規約,具體內容如下: 在談論為什麼之前先來科普下什麼是二方庫,二方庫也稱作二方包,一般指公司內部發佈到中央倉庫,可供公司內部其他應用依賴的庫(jar 包)。 那麼一方庫便是本工程內部子項目模塊依賴的庫;三方 ...


在閱讀《阿裡巴巴Java開發手冊》時,發現有一條關於二方庫依賴中介面返回值不允許使用枚舉類型的規約,具體內容如下:

在談論為什麼之前先來科普下什麼是二方庫,二方庫也稱作二方包,一般指公司內部發佈到中央倉庫,可供公司內部其他應用依賴的庫(jar 包)。

那麼一方庫便是本工程內部子項目模塊依賴的庫;三方庫為公司之外的開源庫,比如像 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)
}

定義了一個服務類,實現了根據 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 {
  @Resource
  private StarbucksService starbucksService;
  
  public void getStarbucks() {
    Starbucks starbucks = starbucksService.getStarbucksById(1L);
    System.out.println(starbucks);
  }
}

有一天,老羅說要那個中等大小的中杯拿鐵,但是服務員說那是大杯,經過一番爭論,羅老師很是生氣。

於是星巴克升級到了 0.0.2 版本二方庫,在枚舉類 SizeEnum 中新增了小杯,升級後的枚舉類如下:

public enum SizeEnum {
  TALL(1),
  GRANDE(2),
  VENTI(3),
  SHORT(4)
}

同時服務類的介面方法也做了相應修改:

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

由於星巴克的門店比較多,有的還不知道這個新加的需求,因此返回結果中出現了 SHORT,但是 0.0.1 版本的二方庫中沒有小杯啊,所以就出問題了,也就是序列化失敗。

通過這個例子,我相信大家對枚舉類型作為返回結果有了一定的理解,下麵引用孤盡大佬在知乎的回答:

由於升級原因,導致雙方的枚舉類不盡相同,在介面解析,類反序列化時出現異常。

Java 中出現的任何元素,在 Gosling 的角度都會有背後的思考和邏輯(儘管並非絕對完美,但 Java 的頂層抽象已經是天才級了),比如:介面、抽象類、註解、和本文提到的枚舉。枚舉有好處,類型安全,清晰直接,還可以使用等號來判斷,也可以用在 switch 中。它的劣勢也是明顯的,就是不要擴展。可是為什麼在返回值和參數進行了區分呢,如果不相容,那麼兩個都有問題,怎麼允許參數可以有枚舉。當時的考慮,如果參數也不能用,那麼枚舉幾乎無用武之地了。參數輸出,畢竟是本地決定的,你本地有的,傳送過去,向前相容是不會有問題的。但如果是介面返回,就比較噁心了,因為解析回來的這個枚舉值,可能本地還沒有,這時就會拋出序列化異常。

比如:你的本地枚舉類,有一個天氣 Enum:SUNNY, RAINY, CLOUDY,如果根據天氣計算心情的方法:guess(WeatcherEnum xx),傳入這三個值都是可以的。返回值:Weather guess(參數),那麼對方運算後,返回一個 SNOWY,本地枚舉里沒有這個值,傻眼了。

總結

本文通過一個實例讓大家理解到枚舉類型作為返回結果的坑,大家可以使用基本類型或者基本類型包裝類來替換掉枚舉類型就可以避免掉這麼問題了。

大家對於這條規約​有什麼看法,也歡迎留言討論。​

最好的關係就是互相成就,大家的在看、轉發、留言三連就是我創作的最大動力。

參考

《Java開發手冊》泰山版

https://www.zhihu.com/question/52760637/answer/338584321


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • import pandasexcel=pandas.read_excel('現代徵信學.xlsx',index_col='列名',header=None) #header預設為0,指讀取第幾行,0代表第一行excel.columns=['Id','title','hh','uei','t'] #重新 ...
  • Java生鮮電商平臺-生鮮小程式首頁系統功能詳解(小程式/APP) 說明:對於一個成熟的生鮮小程式而言,首頁至關重要,下麵我就列舉,我們系統中的首頁的功能,本文只是簡單的介紹下,以達到拋磚引玉的作用,希望對大家有點幫助。 QQ:137071249 共同學習QQ群:793305035 ...
  • 軟體開發的生命周期 既然我們以後從事的工作時軟體開發,那麼我們就要對軟體開發的流程先做瞭解,畢竟要從娃娃抓起。早點瞭解軟體開發流程,也就有了軟體開發的思想與動力。 軟體開發的生命周期 問題定義 問題定義 是軟體定義時期的第一個階段。作為軟體的開發者,在這個階段必須弄清用戶“需要電腦解決什麼問題”。 ...
  • import pandasa=pandas.DataFrame({'ID':[1,2,3],'Name':['Time','Mike','Nick']})b=a.set_index('ID') #重新設置索引b.to_excel(r'D:\電腦二級\ocr 訓練\a.xlsx') ...
  • 面完螞蟻後,早就聽聞拼多多這個獨角獸,決定也去面一把。首先我在脈脈找了一個拼多多的HR,加了微信聊了下,發了簡歷便開始我的拼多多面試之旅。這裡要非常感謝拼多多HR小姐姐,從面試內推到offer確認一直都在幫我,人真的很nice。 ...
  • from matplotlib import pyplotimport numpyx=numpy.random.randn(100) #生成100個隨機數,關於標準正態分佈 y=-x+numpy.random.randn(100)*0.5pyplot.scatter(x,y,s=25,c='pink ...
  • 所有知識體系文章,GitHub已收錄,歡迎Star!再次感謝,願你早日進入大廠! GitHub地址: https://github.com/Ziphtracks/JavaLearningmanual 01設計模式之單例設計模式 一、什麼是單例設計模式? 單例模式(Singleton Pattern) ...
  • 一、python的應用領域 二、人工智慧範例 1.範例1 將寫在紙上的文字,精準地識別出來 1 import requests 2 from aip import AipOcr 3 4 image = requests.get('https://res.pandateacher.com/python ...
一周排行
    -Advertisement-
    Play Games
  • 示例項目結構 在 Visual Studio 中創建一個 WinForms 應用程式後,項目結構如下所示: MyWinFormsApp/ │ ├───Properties/ │ └───Settings.settings │ ├───bin/ │ ├───Debug/ │ └───Release/ ...
  • [STAThread] 特性用於需要與 COM 組件交互的應用程式,尤其是依賴單線程模型(如 Windows Forms 應用程式)的組件。在 STA 模式下,線程擁有自己的消息迴圈,這對於處理用戶界面和某些 COM 組件是必要的。 [STAThread] static void Main(stri ...
  • 在WinForm中使用全局異常捕獲處理 在WinForm應用程式中,全局異常捕獲是確保程式穩定性的關鍵。通過在Program類的Main方法中設置全局異常處理,可以有效地捕獲並處理未預見的異常,從而避免程式崩潰。 註冊全局異常事件 [STAThread] static void Main() { / ...
  • 前言 給大家推薦一款開源的 Winform 控制項庫,可以幫助我們開發更加美觀、漂亮的 WinForm 界面。 項目介紹 SunnyUI.NET 是一個基於 .NET Framework 4.0+、.NET 6、.NET 7 和 .NET 8 的 WinForm 開源控制項庫,同時也提供了工具類庫、擴展 ...
  • 說明 該文章是屬於OverallAuth2.0系列文章,每周更新一篇該系列文章(從0到1完成系統開發)。 該系統文章,我會儘量說的非常詳細,做到不管新手、老手都能看懂。 說明:OverallAuth2.0 是一個簡單、易懂、功能強大的許可權+可視化流程管理系統。 有興趣的朋友,請關註我吧(*^▽^*) ...
  • 一、下載安裝 1.下載git 必須先下載並安裝git,再TortoiseGit下載安裝 git安裝參考教程:https://blog.csdn.net/mukes/article/details/115693833 2.TortoiseGit下載與安裝 TortoiseGit,Git客戶端,32/6 ...
  • 前言 在項目開發過程中,理解數據結構和演算法如同掌握蓋房子的秘訣。演算法不僅能幫助我們編寫高效、優質的代碼,還能解決項目中遇到的各種難題。 給大家推薦一個支持C#的開源免費、新手友好的數據結構與演算法入門教程:Hello演算法。 項目介紹 《Hello Algo》是一本開源免費、新手友好的數據結構與演算法入門 ...
  • 1.生成單個Proto.bat內容 @rem Copyright 2016, Google Inc. @rem All rights reserved. @rem @rem Redistribution and use in source and binary forms, with or with ...
  • 一:背景 1. 講故事 前段時間有位朋友找到我,說他的窗體程式在客戶這邊出現了卡死,讓我幫忙看下怎麼回事?dump也生成了,既然有dump了那就上 windbg 分析吧。 二:WinDbg 分析 1. 為什麼會卡死 窗體程式的卡死,入口門檻很低,後續往下分析就不一定了,不管怎麼說先用 !clrsta ...
  • 前言 人工智慧時代,人臉識別技術已成為安全驗證、身份識別和用戶交互的關鍵工具。 給大家推薦一款.NET 開源提供了強大的人臉識別 API,工具不僅易於集成,還具備高效處理能力。 本文將介紹一款如何利用這些API,為我們的項目添加智能識別的亮點。 項目介紹 GitHub 上擁有 1.2k 星標的 C# ...