新聞中心
序列化是一種對(duì)象持久化的手段。普遍應(yīng)用在網(wǎng)絡(luò)傳輸、RMI等場景中。類通過實(shí)現(xiàn)java.io.Serializable 接口以啟用其序列化功能。

創(chuàng)新互聯(lián)堅(jiān)持“要么做到,要么別承諾”的工作理念,服務(wù)領(lǐng)域包括:網(wǎng)站設(shè)計(jì)、網(wǎng)站建設(shè)、企業(yè)官網(wǎng)、英文網(wǎng)站、手機(jī)端網(wǎng)站、網(wǎng)站推廣等服務(wù),滿足客戶于互聯(lián)網(wǎng)時(shí)代的永平網(wǎng)站設(shè)計(jì)、移動(dòng)媒體設(shè)計(jì)的需求,幫助企業(yè)找到有效的互聯(lián)網(wǎng)解決方案。努力成為您成熟可靠的網(wǎng)絡(luò)建設(shè)合作伙伴!
在我的博客中,其實(shí)已經(jīng)有多篇文章介紹過序列化了,對(duì)序列化的基礎(chǔ)知識(shí)不夠了解的朋友可以參考以下幾篇文章:
Java對(duì)象的序列化與反序列化
深入分析Java的序列化與反序列化
單例與序列化的那些事兒
在這幾篇文章中,我分別介紹過了序列化涉及到的類和接口、如何自定義序列化策略、transient關(guān)鍵字和序列化的關(guān)系等,還通過學(xué)習(xí)ArrayList對(duì)序列化的實(shí)現(xiàn)源碼深入學(xué)習(xí)了序列化。并且還拓展分析了一下序列化對(duì)單例的影響等。
但是,還有一個(gè)知識(shí)點(diǎn)并未展開介紹,那就是關(guān)于serialVersionUID 。這個(gè)字段到底有什么用?如果不設(shè)置會(huì)怎么樣?為什么《阿里巴巴Java開發(fā)手冊》中有以下規(guī)定:
背景知識(shí)
在展開本文的介紹之前,先來簡單介紹一些和序列化有關(guān)的知識(shí),內(nèi)容均來自文章開頭的三個(gè)文章鏈接中。
Serializable 和 Externalizable
Java類通過實(shí)現(xiàn) java.io.Serializable 接口以啟用其序列化功能。未實(shí)現(xiàn)此接口的類將無法進(jìn)行序列化或反序列化。可序列化類的所有子類型本身都是可序列化的。
如果讀者看過Serializable的源碼,就會(huì)發(fā)現(xiàn),他只是一個(gè)空的接口,里面什么東西都沒有。Serializable接口沒有方法或字段,僅用于標(biāo)識(shí)可序列化的語義。但是,如果一個(gè)類沒有實(shí)現(xiàn)這個(gè)接口,想要被序列化的話,就會(huì)拋出java.io.NotSerializableException異常。
它是怎么保證只有實(shí)現(xiàn)了該接口的方法才能進(jìn)行序列化與反序列化的呢?
原因是在執(zhí)行序列化的過程中,會(huì)執(zhí)行到以下代碼:
- if (obj instanceof String) {
- writeString((String) obj, unshared);
- } else if (cl.isArray()) {
- writeArray(obj, desc, unshared);
- } else if (obj instanceof Enum) {
- writeEnum((Enum>) obj, desc, unshared);
- } else if (obj instanceof Serializable) {
- writeOrdinaryObject(obj, desc, unshared);
- } else {
- if (extendedDebugInfo) {
- throw new NotSerializableException(
- cl.getName() + "\n" + debugInfoStack.toString());
- } else {
- throw new NotSerializableException(cl.getName());
- }
- }
在進(jìn)行序列化操作時(shí),會(huì)判斷要被序列化的類是否是Enum、Array和Serializable類型,如果都不是則直接拋出NotSerializableException。
Java中還提供了Externalizable接口,也可以實(shí)現(xiàn)它來提供序列化能力。
Externalizable繼承自Serializable,該接口中定義了兩個(gè)抽象方法:writeExternal()與readExternal()。
當(dāng)使用Externalizable接口來進(jìn)行序列化與反序列化的時(shí)候需要開發(fā)人員重寫writeExternal()與readExternal()方法。否則所有變量的值都會(huì)變成默認(rèn)值。
transient
transient 關(guān)鍵字的作用是控制變量的序列化,在變量聲明前加上該關(guān)鍵字,可以阻止該變量被序列化到文件中,在被反序列化后,transient 變量的值被設(shè)為初始值,如 int 型的是 0,對(duì)象型的是 null。
自定義序列化策略
在序列化過程中,如果被序列化的類中定義了writeObject 和 readObject 方法,虛擬機(jī)會(huì)試圖調(diào)用對(duì)象類里的 writeObject 和 readObject 方法,進(jìn)行用戶自定義的序列化和反序列化。
如果沒有這樣的方法,則默認(rèn)調(diào)用是 ObjectOutputStream 的defaultWriteObject 方法以及 ObjectInputStream 的defaultReadObject 方法。
用戶自定義的 writeObject 和 readObject 方法可以允許用戶控制序列化的過程,比如可以在序列化的過程中動(dòng)態(tài)改變序列化的數(shù)值。
所以,對(duì)于一些特殊字段需要定義序列化的策略的時(shí)候,可以考慮使用transient修飾,并自己重寫writeObject 和 readObject 方法,如java.util.ArrayList中就有這樣的實(shí)現(xiàn)。
以上,就是一些讀者需要掌握和和序列化有關(guān)的知識(shí)。
我們隨便找?guī)讉€(gè)Java中實(shí)現(xiàn)了序列化接口的類,如String、Integer等,我們可以發(fā)現(xiàn)一個(gè)細(xì)節(jié),那就是這些類除了實(shí)現(xiàn)了Serializable外,還定義了一個(gè)serialVersionUID
那么,到底什么是serialVersionUID呢?為什么要設(shè)置這樣一個(gè)字段呢?
什么是serialVersionUID
序列化是將對(duì)象的狀態(tài)信息轉(zhuǎn)換為可存儲(chǔ)或傳輸?shù)男问降倪^程。我們都知道,Java對(duì)象是保存在JVM的堆內(nèi)存中的,也就是說,如果JVM堆不存在了,那么對(duì)象也就跟著消失了。
而序列化提供了一種方案,可以讓你在即使JVM停機(jī)的情況下也能把對(duì)象保存下來的方案。就像我們平時(shí)用的U盤一樣。把Java對(duì)象序列化成可存儲(chǔ)或傳輸?shù)男问?如二進(jìn)制流),比如保存在文件中。這樣,當(dāng)再次需要這個(gè)對(duì)象的時(shí)候,從文件中讀取出二進(jìn)制流,再從二進(jìn)制流中反序列化出對(duì)象。
虛擬機(jī)是否允許反序列化,不僅取決于類路徑和功能代碼是否一致,一個(gè)非常重要的一點(diǎn)是兩個(gè)類的序列化 ID 是否一致,這個(gè)所謂的序列化ID,就是我們在代碼中定義的serialVersionUID。
如果serialVersionUID變了會(huì)怎樣
我們舉個(gè)例子吧,看看如果serialVersionUID被修改了會(huì)發(fā)生什么?
- public class SerializableDemo1 {
- public static void main(String[] args) {
- //Initializes The Object
- User1 user = new User1();
- user.setName("hollis");
- //Write Obj to File
- ObjectOutputStream oos = null;
- try {
- oos = new ObjectOutputStream(new FileOutputStream("tempFile"));
- oos.writeObject(user);
- } catch (IOException e) {
- e.printStackTrace();
- } finally {
- IOUtils.closeQuietly(oos);
- }
- }
- }
- class User1 implements Serializable {
- private static final long serialVersionUID = 1L;
- private String name;
- public String getName() {
- return name;
- }
- public void setName(String name) {
- this.name = name;
- }
- }
我們先執(zhí)行以上代碼,把一個(gè)User1對(duì)象寫入到文件中。然后我們修改一下User1類,把serialVersionUID的值改為2L。
- class User1 implements Serializable {
- private static final long serialVersionUID = 2L;
- private String name;
- public String getName() {
- return name;
- }
- public void setName(String name) {
- this.name = name;
- }
- }
然后執(zhí)行以下代碼,把文件中的對(duì)象反序列化出來:
- public class SerializableDemo2 {
- public static void main(String[] args) {
- //Read Obj from File
- File file = new File("tempFile");
- ObjectInputStream ois = null;
- try {
- ois = new ObjectInputStream(new FileInputStream(file));
- User1 newUser = (User1) ois.readObject();
- System.out.println(newUser);
- } catch (IOException e) {
- e.printStackTrace();
- } catch (ClassNotFoundException e) {
- e.printStackTrace();
- } finally {
- IOUtils.closeQuietly(ois);
- try {
- FileUtils.forceDelete(file);
- } catch (IOException e) {
- e.printStackTrace();
- }
- }
- }
- }
執(zhí)行結(jié)果如下:
- java.io.InvalidClassException: com.hollis.User1; local class incompatible: stream classdesc serialVersionUID = 1, local class serialVersionUID = 2
可以發(fā)現(xiàn),以上代碼拋出了一個(gè)java.io.InvalidClassException,并且指出serialVersionUID不一致。
這是因?yàn)?,在進(jìn)行反序列化時(shí),JVM會(huì)把傳來的字節(jié)流中的serialVersionUID與本地相應(yīng)實(shí)體類的serialVersionUID進(jìn)行比較,如果相同就認(rèn)為是一致的,可以進(jìn)行反序列化,否則就會(huì)出現(xiàn)序列化版本不一致的異常,即是InvalidCastException。
這也是《阿里巴巴Java開發(fā)手冊》中規(guī)定,在兼容性升級(jí)中,在修改類的時(shí)候,不要修改serialVersionUID的原因。除非是完全不兼容的兩個(gè)版本。所以,serialVersionUID其實(shí)是驗(yàn)證版本一致性的。
如果讀者感興趣,可以把各個(gè)版本的JDK代碼都拿出來看一下,那些向下兼容的類的serialVersionUID是沒有變化過的。比如String類的serialVersionUID一直都是-6849794470754667710L。
但是,作者認(rèn)為,這個(gè)規(guī)范其實(shí)還可以再嚴(yán)格一些,那就是規(guī)定:
如果一個(gè)類實(shí)現(xiàn)了Serializable接口,就必須手動(dòng)添加一個(gè)private static final long serialVersionUID變量,并且設(shè)置初始值。
為什么要明確定一個(gè)serialVersionUID
如果我們沒有在類中明確的定義一個(gè)serialVersionUID的話,看看會(huì)發(fā)生什么。
嘗試修改上面的demo代碼,先使用以下類定義一個(gè)對(duì)象,該類中不定義serialVersionUID,將其寫入文件。
- class User1 implements Serializable {
- private String name;
- public String getName() {
- return name;
- }
- public void setName(String name) {
- this.name = name;
- }
- }
然后我們修改User1類,向其中增加一個(gè)屬性。在嘗試將其從文件中讀取出來,并進(jìn)行反序列化。
- class User1 implements Serializable {
- private String name;
- private int age;
- public String getName() {
- return name;
- }
- public void setName(String name) {
- this.name = name;
- }
- public int getAge() {
- return age;
- }
- public void setAge(int age) {
- this.age = age;
- }
- }
執(zhí)行結(jié)果:
- java.io.InvalidClassException: com.hollis.User1; local class incompatible: stream classdesc serialVersionUID = -2986778152837257883, local class serialVersionUID = 7961728318907695402
同樣,拋出了InvalidClassException,并且指出兩個(gè)serialVersionUID不同,分別是-2986778152837257883和7961728318907695402。
從這里可以看出,系統(tǒng)自己添加了一個(gè)serialVersionUID。
所以,一旦類實(shí)現(xiàn)了Serializable,就建議明確的定義一個(gè)serialVersionUID。不然在修改類的時(shí)候,就會(huì)發(fā)生異常。
serialVersionUID有兩種顯示的生成方式:
一種是默認(rèn)的1L,比如:
- private static final long serialVersionUID = 1L;
另外一種是根據(jù)類名、接口名、成員方法及屬性等來生成一個(gè)64位的哈希字段,比如:
- private static final long serialVersionUID = xxxxL;
后面這種方式,可以借助IDE生成,后面會(huì)介紹。
背后原理
知其然,要知其所以然,我們再來看看源碼,分析一下為什么serialVersionUID改變的時(shí)候會(huì)拋異常?在沒有明確定義的情況下,默認(rèn)的serialVersionUID是怎么來的?
為了簡化代碼量,反序列化的調(diào)用鏈如下:
- ObjectInputStream.readObject ->
- readObject0 ->
- readOrdinaryObject ->
- readClassDesc ->
- readNonProxyDesc ->
- ObjectStreamClass.initNonProxy
在initNonProxy中 ,關(guān)鍵代碼如下:
在反序列化過程中,對(duì)serialVersionUID做了比較,如果發(fā)現(xiàn)不相等,則直接拋出異常。
深入看一下getSerialVersionUID方法:
- public long getSerialVersionUID() {
- // REMIND: synchronize instead of relying on volatile?
- if (suid == null) {
- suid = AccessController.doPrivileged(
- new PrivilegedAction
() { - public Long run() {
- return computeDefaultSUID(cl);
- }
- }
- );
- }
- return suid.longValue();
- }
在沒有定義serialVersionUID的時(shí)候,會(huì)調(diào)用computeDefaultSUID 方法,生成一個(gè)默認(rèn)的serialVersionUID。
這也就找到了以上兩個(gè)問題的根源,其實(shí)是代碼中做了嚴(yán)格的校驗(yàn),并且在未定義的時(shí)候自動(dòng)生成了一個(gè)serialVersionUID。
IDEA提示
為了確保我們不會(huì)忘記定義serialVersionUID,可以調(diào)節(jié)一下Intellij IDEA的配置,在實(shí)現(xiàn)Serializable接口后,如果沒定義serialVersionUID的話,IDEA(eclipse一樣)會(huì)進(jìn)行提示:
并且可以一鍵生成一個(gè):
當(dāng)然,這個(gè)配置并不是默認(rèn)生效的,需要手動(dòng)到IDEA中設(shè)置一下:
在圖中標(biāo)號(hào)3的地方(Serializable class without serialVersionUID的配置),打上勾,保存即可。
總結(jié)
serialVersionUID是用來驗(yàn)證版本一致性的。所以在做兼容性升級(jí)的時(shí)候,不要改變類中serialVersionUID的值。
特別說明一下,由于本文標(biāo)題并不完全能表達(dá)本文的全部內(nèi)容,這里再強(qiáng)調(diào)一下:serialVersionUID 既然是驗(yàn)證版本一致性的,在做版本升級(jí)的時(shí)候(非兼容性升級(jí)),記得要修改這個(gè)字段的值哦,這樣可以避免序列化混亂。
如果一個(gè)類實(shí)現(xiàn)了Serializable接口,一定要記得定義serialVersionUID,否則會(huì)發(fā)生異常??梢栽贗DE中通過設(shè)置,讓他幫忙提示,并且可以一鍵快速生成一個(gè)serialVersionUID。
之所以會(huì)發(fā)生異常,是因?yàn)榉葱蛄谢^程中做了校驗(yàn),并且如果沒有明確定義的話,會(huì)根據(jù)類名及屬性等自動(dòng)生成一個(gè)。
【本文是專欄作者Hollis的原創(chuàng)文章,作者微信公眾號(hào)Hollis(ID:hollischuang)】
當(dāng)前名稱:為什么阿里巴巴要求程序員謹(jǐn)慎修改serialVersionUID字段的值
URL網(wǎng)址:http://www.5511xx.com/article/ccdcjoh.html


咨詢
建站咨詢
