serialVersionUID的作用和用法


java在序列化的時候涉及到很多檢查,serialVersionUID就是其中一個。 

那這個serialVersionUID有什么用處? 

這個值可以由類指定,也可以不指定。如果不指定的話java會根據class計算serialVersionUID,相當於hash的原理(但不是hash不要混淆),只要類沒有變化,計算出來的serialVersionUID也會變化。 

它用在反序列化的時候“檢查”當前的類是不是已經被修改過。如果發現serialVersionUID對不上號,那么會拋出 java.io.InvalidClassException的異常,這種情況發生在由於種種因素修改了序列化對象的類文件時。 

但是有時候我們有這樣的需求,將A類對象序列化之后,版本升級,修改了A類,這時候,希望反序列化的時候還能認識之前版本的序列化對象。這時候serialVersionUID就在笑了,對,只要指定序列化對象類的serialVersionUID就可以了。 

指定了序列化對象的serialVersionUID,即使你刪除了類的某個成員變量,其他未修改信息仍然能正確解析,對他就是這么變態。 

ps: 介紹下我的使用場景:我需要持久一些動態的配置,在每次修改之后,我都會將新的配置持久化到文件中。但是不想使用xml文件,雖然易懂,但是對我系統來說沒有必要,我這個配置我是提供用戶在頁面上直接配置的,不需要打開XML文件來寫(容易出錯,還需要重啟應用)。我現在的做法就是就配置文件寫成一個類,配置項就是類中的成員變量,這樣新加配置文件直接內存中分配一個配置對象,然后將次對象序列化到文件中,但是考慮到配置項可能會增加,但是我需要在配置類新加了配置項之后,之前的數據文件仍然能讀取,於是就有了上面的嘗試。 

 

簡單來說,Java的序列化機制是通過在運行時判斷類的serialVersionUID來驗證版本一致性的。在進行反序列化時,JVM會把傳來的字節流中的serialVersionUID與本地相應實體(類)的serialVersionUID進行比較,如果相同就認為是一致的,可以進行反序列化,否則就會出現序列化版本不一致的異常。(InvalidCastException)

serialVersionUID有兩種顯示的生成方式:        一個是默認的1L,比如:private static final long serialVersionUID = 1L;        一個是根據類名、接口名、成員方法及屬性等來生成一個64位的哈希字段,比如:        private static final   long     serialVersionUID = xxxxL; 當你一個類實現了Serializable接口,如果沒有顯示的定義serialVersionUID,Eclipse會提供這個      提示功能告訴你去定義 。在Eclipse中點擊類中warning的圖標一下,Eclipse就會      自動給定兩種生成的方式。如果不想定義它,在Eclipse的設置中也       可以把它關掉的,設置如下:         Window ==> Preferences ==> Java ==> Compiler ==> Error/Warnings ==>         Potential programming problems         將Serializable class without serialVersionUID的warning改成ignore即可。
當實現java.io.Serializable接口的實體(類)沒有顯式地定義一個名為serialVersionUID,類型為long的變量時,Java序列化機制會根據編譯的class(它通過類名,方法名等諸多因素經過計算而得,理論上是一一映射的關系,也就是唯一的)自動生成一個serialVersionUID作序列化版本比較用,這種情況下,如果class文件(類名,方法明等)沒有發生變化(增加空格,換行,增加注釋,等等),就算再編譯多次,serialVersionUID也不會變化的.

如果我們不希望通過編譯來強制划分軟件版本,即實現序列化接口的實體能夠兼容先前版本,未作更改的類,就需要顯式地定義一個名為serialVersionUID,類型為long的變量,不修改這個變量值的序列化實體都可以相互進行串行化和反串行化。

如果你沒有考慮到兼容性問題時,就把它關掉,不過有這個功能是好的,只要任何類別實現了Serializable這個接口的話,如果沒有加入 serialVersionUID,Eclipse都會給你warning提示,這個serialVersionUID為了讓該類別 Serializable向后兼容。

問題一:假設有A端和B端,如果2處的serialVersionUID不一致,會產生什么錯誤呢?

問題二:假設2處serialVersionUID一致,如果A端增加一個字段,B端不變,會是什么情況呢?

問題三:假設2處serialVersionUID一致,如果B段增加一個字段,A端不變,會是什么情況呢?

問題四:假設2處serialVersionUID一致,如果A端減少一個字段,B端不變,會是什么情況呢?

問題五:假設2處serialVersionUID一致,如果B端減少一個字段,A端不變,會是什么情況呢?

 

例子如下:寫2個類,類名相同,字段相同,方法相同.放在不同的包里,來模仿A端和B端.

實體類:在本例中,在測試類SerialTest執行前代表A端,然后,在測試類DeserialTest執行前代表B端.

package com.test; import java.io.Serializable;

public class Serial implements Serializable{ /**   *   */ private static final long serialVersionUID = 6977402643848374753L; int id;       String name;       public Serial(int id, String name) {           this.id = id;           this.name = name;       }       public String toString() {           return "DATA: " + id + " " +name;         }   }

 

測試類,代表A端的序列化

package com.test.serializable;

import java.io.FileNotFoundException; import java.io.FileOutputStream; import java.io.IOException; import java.io.ObjectOutputStream;

public class SerialTest {

/**   * @param args   */ public static void main(String[] args) {   // TODO Auto-generated method stub   Serial serial1 = new Serial(1,"song");   System.out.println("Object Serial"+serial1);     try {    FileOutputStream fos = new FileOutputStream("serialTest.txt");    ObjectOutputStream oos = new ObjectOutputStream(fos);    oos.writeObject(serial1);    oos.flush();    oos.close();         } catch (FileNotFoundException e) {    // TODO Auto-generated catch block    e.printStackTrace();   } catch (IOException e) {    // TODO Auto-generated catch block    e.printStackTrace();   } } }

測試類,代表B端的反序列化

package com.test.serializable;

import java.io.FileInputStream; import java.io.FileNotFoundException; import java.io.IOException; import java.io.ObjectInputStream;

public class DeserialTest {

/**   * @param args   */ public static void main(String[] args) {   // TODO Auto-generated method stub   Serial serial2 ;   try {    FileInputStream fis = new FileInputStream("serialTest.txt");    ObjectInputStream ois = new ObjectInputStream(fis);    serial2 = (Serial)ois.readObject();    ois.close();    System.out.println("Object Deserial"+serial2);   } catch (FileNotFoundException e) {    // TODO Auto-generated catch block    e.printStackTrace();   } catch (IOException e) {    // TODO Auto-generated catch block    e.printStackTrace();   } catch (ClassNotFoundException e) {    // TODO Auto-generated catch block    e.printStackTrace();   }   }

}

問題一:假設有A端和B端,如果2處的serialVersionUID不一致,會產生什么錯誤呢?

答案如下:

1)先執行測試類SerialTest,然后修改serialVersion值(或注釋掉serialVersion並編譯),再執行測試類DeserialTest,報錯:

java.io.InvalidClassException: com.test.serializable.Serial; local class incompatible: stream classdesc serialVersionUID = 1, local class serialVersionUID = 11

2)A端和B端都沒顯示的寫serialVersionUID,實體類沒有改動(如果class文件(類名,方法明等)沒有發生變化(增加空格,換行,增加注釋,等等),).序列化,反序列化正常.

 

問題二:假設2處serialVersionUID一致,如果A端增加一個字段,B端不變,會是什么情況呢?

答案二: 序列化,反序列化正常,A端增加的字段丟失(被B端忽略).

問題五:假設2處serialVersionUID一致,如果B端減少一個字段,A端不變,會是什么情況呢?

答案:與問題二類似,序列化,反序列化正常,B端字段少於A端,A端多的字段值丟失(被B端忽略).

 

問題三:假設2處serialVersionUID一致,如果B段增加一個字段,A端不變,會是什么情況呢?

問題四:假設2處serialVersionUID一致,如果A端減少一個字段,B端不變,會是什么情況呢?(與問題三類似,四答案:序列化,反序列化正常,B端字段多余A端,B端多出的字段被賦予對應類型的默認值)

答案三: 序列化,反序列化正常,B端新增加的int字段被賦予了默認值0.  

例子如下:

3)先執行SerialTest,然后在實體類增加一個字段age,再執行測試類DeserialTest.

package com.test.serializable;

import java.io.Serializable;

public class Serial implements Serializable {

/**   *   */ private static final long serialVersionUID = -2337937881709830076L;

/**   *   */ //private static final long serialVersionUID = 1L; int id;       

    String name;       public Serial(int id, String name) {           this.id = id;           this.name = name;       }       public String toString() {           return "DATA: " + id + " " +name;         }     public int age ;//在B端增加一個新字段 }

相應的修改測試類DeserialTest,打印出age的值.

package com.test.serializable;

import java.io.FileInputStream; import java.io.FileNotFoundException; import java.io.IOException; import java.io.ObjectInputStream;

public class DeserialTest {

/**   * @param args   */ public static void main(String[] args) {   // TODO Auto-generated method stub   Serial serial2 ;   try {    FileInputStream fis = new FileInputStream("serialTest.txt");    ObjectInputStream ois = new ObjectInputStream(fis);    serial2 = (Serial)ois.readObject();    ois.close();    System.out.println("Object Deserial"+serial2+" age="+serial2.age);   } catch (FileNotFoundException e) {    // TODO Auto-generated catch block    e.printStackTrace();   } catch (IOException e) {    // TODO Auto-generated catch block    e.printStackTrace();   } catch (ClassNotFoundException e) {    // TODO Auto-generated catch block    e.printStackTrace();   }   }

}

打印結果如下:

Object DeserialDATA: 1 song age=0

說明序列化,反序列化正常,B端新增加的int字段被賦予了默認值0.

 

上面的情況對增加/減少 字段/方法 都適用.

//但當serialVersionUID相同時,它就會將不一樣的field以type的預設值Deserialize,可避開不兼容性問題。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM