dubbo rpc 接口兼容升級 hessian2 序列化
任何使用微服務架構的團隊柳琢，作為接口提供方若對擴展性沒有考慮周全的話，后續(xù)的升級和打補丁絕對是一件讓人頭疼的事情盅抚。要不新增接口與原接口物理隔離漠魏，但這會造成接口數(shù)量的迅速膨脹和維護困難；要不小心翼翼的修改原接口妄均，盡量考慮兼容到所有依賴系統(tǒng)柱锹，而這很容易進入顧此失彼/百密一疏的境地哪自。
本文作者的團隊是基于Dubbo微服務架構，所以很多說明和示例都與此有關禁熏，我會盡量表述清楚壤巷，不妨礙大家理解和閱讀。
#兼容性升級常見問題
1. 參數(shù)本身或內部成員變量的【類型****修改】
這里的參數(shù)包括入?yún)⒊鰠? 下文不再特別說明瞧毙。
既然是兼容升級胧华，修改類定義指的通常是修改為父類。比如MailForm修改為父類BaseForm甚至Object宙彪，用來處理類型邊界更廣的數(shù)據(jù)矩动。問題隨之而來，邊界放大了可以收入或者釋放更多類型的數(shù)據(jù)释漆，但是邏輯復雜度也不可避免的升高悲没，稍有不慎萬劫不復。此類修改強烈不建議男图。
2. 參數(shù)內部【增刪成員變量】
新增應該是最經(jīng)常發(fā)生的示姿。很多時候我們沒辦法預估到未來的某個需求時，比如要新增一個屬性讓調用方傳遞過來享言，可能是必填也可能是非必填峻凫，如果是沒有封裝為對象只是在入?yún)纫灰涣_列屬性變量，這種低級的設計誤區(qū)我們就不提了览露；所以一般是封裝為對象作為入?yún)⒂恚@時我們就不得不在對象內新增一個成員變量。
刪除一個屬性字段的情況很少發(fā)生差牛，這里說的場景是：服務方新加了一個屬性字段命锄，并提供了一個新的jar包，然后調用方拿著新jar在生產(chǎn)環(huán)境發(fā)布偏化，而服務方卻因為某些原因沒有上線脐恩，這就出現(xiàn)了好像服務方“刪除”了一個字段一樣。
3. 修改參數(shù)對象的【數(shù)據(jù)結構】
可能有人會說修改數(shù)據(jù)結構和兼容性不可能同時出現(xiàn)侦讨，這個不能絕對驶冒，因為編程中接口定義作為雙方約定好的承諾，被單方面破壞的事情偶有發(fā)生韵卤。比如服務方提供一個接收 Map 類型的方法骗污，如果沒約定好具體的實現(xiàn)，調用方使用HashMap沈条、LinkedHashMap需忿、TreeMap的可能性都存在，如果不小心直接使用了TreeMap.firstKey()，只有妥妥的異常屋厘。
4. 使用Enum 參數(shù)
服務方為了調用方的方便不少人喜歡將參數(shù)定義成枚舉涕烧，殊不知這在RPC接口定義中是一大忌，因為一旦新增枚舉值就絕對會導致一片血雨腥風汗洒，后文會從序列化角度來說明為何不可议纯。友情提醒，還是老老實實用常量類來實現(xiàn)比較穩(wěn)妥仲翎。
5. 簡單總個結
上文主要總結了一些日常會碰到的問題痹扇，不少人可能也曾深受其害。接口升級務必充分測試溯香，萬不可想當然鲫构。舉個實際的案例，某個接口的出參是一個Json字符串玫坛，有次升級給Json新增了一個Key值结笨，這個Key值很多場景下無關痛癢，只有很特殊的場景才會用這個值湿镀。服務方的想法很簡單炕吸，就算是沒有升級的老的調用方解析出這個Key，他的邏輯里也不會對其進行任何操作勉痴，理論上沒有任何問題赫模。而最后的結果很驚悚，它會導致某些版本的客戶端App閃退!
無法免俗的還是不得不提下RPC微服務接口設計和升級的幾個要素和建議：
a. 接口或者類最好預定義好版本號蒸矛，可以基于配置(比如dubbo xml)瀑罗，也可以基于類/方法命名。
b. 不能保證萬無一失的升級雏掠，就盡量新增接口而不是修改斩祭，也就是常說的開閉原則。
c. 接口涉及的對象一定要拿捏好邊界乡话。不能暴露非必要的屬性字段摧玫，造成后期的維護升級難度提高；也不能將屬性字段定義的太死绑青，不怎么修改的相對穩(wěn)定的字段可以用確定的類型诬像，而有很大可能性變動的字段建議用模糊的類型定義，比如Map闸婴、List等集合類颅停。
d. 用靜態(tài)常量代替 Enum 類型。
e. 用相對扁平的數(shù)據(jù)結構掠拳，不要使用嵌套過多的集合類型等。
f. 其他...
【Incompatible Changes & Compatible Changes】
https://docs.oracle.com/javase/8/docs/platform/serialization/spec/version.html#a5172
#serialVersionUID
RPC調用本質無非就是數(shù)據(jù)的傳遞纸肉，而數(shù)據(jù)在RPC場景下無非就是序列化的二進制對象溺欧，然后成功調用的基本前提就是能夠在 Remote 端反序列化恢復成原本的對象喊熟。所以本文我們就把接口升級這件事轉換到如何保證序列化&反序列化成功率的角度。
先簡單把序列化相關基礎知識準備一下姐刁。談到序列化大家腦子里先蹦出來的應該是 Serializable 這個Marker標記型接口芥牌，和該接口的實現(xiàn)類( IDE通常會提示讓你生成 )的一個變量值：
private static final long **serialVersionUID** = 1L;
【4.6 Stream Unique Identifiers】
https://docs.oracle.com/javase/7/docs/platform/serialization/spec/class.html#4100
這個值的算法簡單說就是對類名，接口名聂使，方法和屬性的名稱壁拉、修飾符以及描述符的64位哈希值。動態(tài)代理類和枚舉類的該值都是 0L柏靶。特別說明：static/transient類型成員變量弃理、私有方法都不參與Hash值計算。
它也是JDK官方定義的所有序列化的類必須設定的屎蜓，不過如果代碼里沒有顯性設置痘昌，也不用擔心，JVM會使用相同的算法幫你生成一個炬转。
一個類能序列化的前提是它內部所引用的所有對象也必須可以被序列化辆苔，這點是很容易被忽視的。
有個不怎么常用的 Externalizable扼劈，不知道多少人用過驻啤，它繼承自 Serializable，是個歷史遺留接口荐吵。有興趣的可以自己了解下骑冗。
對JDK序列化方式本文不會再展開，主流的RPC調用框架一般都不會選擇JDK序列化方式捍靠，因為它的性能相比hessian2, kryo, FST, protstuff, thrift等等基本沒有任何優(yōu)勢沐旨。
#Dubbo hessian2 序列化測試
Dubbo框架缺省的dubbo協(xié)議默認序列化方式就是Hessian2, 話不多說，直接上針對Hessian2的測試代碼榨婆，然后出結論磁携。代碼設計簡述如下：
使用兩個完全不同的Project，保證同一個package對象做修改不會互相影響良风。（一開始考慮過用自定義的Classloader來隔離和模擬調用方和服務方兩個同名不同內容的對象谊迄，發(fā)現(xiàn)復雜度有點高，放棄）
不需要真正的發(fā)起RPC調用烟央，雙方使用本地的二進制文件簡單模擬傳輸通道统诺。
兩個工程：
Project-Provider
Project-Consumer
分別實現(xiàn)四個類：
HessianUtil(Hessian工具類)
SerialBean(序列化的Bean)
RequestEnum(枚舉類)
Main(Main測試主入口)
測試案例
代碼準備完畢，開始我們的測試案例疑俭，下圖是筆者的一些用例和測試結果：
圖中“綠色對勾”圖標表示可以成功序列化和反序列化粮呢，“紅色叉”圖標表示不能完全或者部分行不通(比如存在的枚舉值行得通)
大家有興趣可以自己去驗證更多的案例，這里直接總結結論：
所有RPC交換對象必須實現(xiàn)Serializable接口;
serialVersionUID 對hessian2無任何影響;
構造方法不管是否私有，對hessian2無任何影響;
類型定義除了比較容易理解的修改成父類沒有影響之外啄寡，類似Long to Boolean也可以成功運行相信很多人沒想到豪硅，雖然行得通，但是代碼邏輯已經(jīng)失控挺物，肯定是不會建議大家這么做懒浮；
枚舉類中增刪新的枚舉值，對于雙方存在的枚舉值不會報錯识藤，但是一方不存在的就會反序列化異常砚著；
其他多層嵌套和集合類的測試交給讀者自測吧，筆者就不展開了哈哈哈
Dubbo Http協(xié)議的坑
架構組老錢前端時間把Mail基礎組件從1.0升級成2.0的時候痴昧，分享了一個坑稽穆。簡單來說就是原有MailForm沒有顯性的設置serialVersionUID, 后來升級新增了字段導致serialVersionUID的計算結果產(chǎn)生變化，一些依賴Mail1.0的調用方會報錯剪个，最后不得不顯性的設置serialVersionUID并保持不變秧骑，這樣老的調用方就不會拋異常了。
后來筆者通過上文的各種測試發(fā)現(xiàn)這種情況與結論相悖扣囊，因為hessian2壓根就無視serialVersionUID的存在乎折，到底是怎么發(fā)生的呢？苦思無果下侵歇，突然想到Mail1.0版本提供的微服務采用的是http協(xié)議不是默認的dubbo協(xié)議骂澄，會不會http協(xié)議采用的默認序列化方式不是hessian2呢？看圖!
上圖是Debug過程中的一張截圖惕虑，大家可以看89行坟冲，對象obj是通過ois.readObject() 反序列化出來的。再看ois這個流對象CodebaseAwareObjectInputStream壓根就不是Hessian2體系內的類溃蔫，而是Spring框架里繼承自java.io.ObjectInputStream的一個流對象健提。到這里就說得通了，因為JDK自帶的序列化機制確實會嚴格比對serianVersionUID是否一致伟叛，出現(xiàn)上面的異常也就不足為怪了私痹。
Hessian2 如何處理不存在的類
再送一個知識點，hessian2反序列化的類如果在當前jvm里或者classloader里不存在统刮，會出現(xiàn)什么場景紊遵？
上圖是SerializerFactory用來根據(jù)反序列化的類型找反序列化器的源碼，很清晰的看到是MapDeserializer侥蒙，它會把不存在的對象按照成員變量的名稱反序列化成一個HashMap結構暗膜。
這個問題是筆者在使用自定義classloader模擬測試的時候發(fā)現(xiàn)的，一并分享出來鞭衩。
END
