java 序列化 serialVersionUID 的做用 和 兩種添加方式

serialVersionUID適用於Java的序列化機制。簡單來講，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變量時候，Java序列化機制會根據編譯的Class自動生成一個serialVersionUID做序列化版本比較用，這種狀況下，若是Class文件(類名，方法明等)沒有發生變化(增長空格，換行，增長註釋等等)，就算再編譯屢次，serialVersionUID也不會變化的。

若是咱們不但願經過編譯來強制劃分軟件版本，即實現序列化接口的實體可以兼容先前版本，就須要顯式地定義一個名爲serialVersionUID，類型爲long的變量，不修改這個變量值的序列化實體均可以相互進行串行化和反串行化。

 

下面用代碼說明一下serialVersionUID在應用中常見的幾種狀況。

（1）序列化實體類

 1 import java.io.Serializable;
 2 public class Person implements Serializable
 3 {
 4     private static final long serialVersionUID = 1234567890L;
 5     public int id;
 6     public String name;
 7  
 8     public Person(int id, String name)
 9     {
10         this.id = id;
11         this.name = name;
12     }
13  
14     public String toString()
15     {
16         return "Person: " + id + " " + name;
17     }
18 }

（2）序列化功能：

 1 import java.io.FileOutputStream;
 2 import java.io.IOException;
 3 import java.io.ObjectOutputStream;
 4  
 5 public class SerialTest
 6 {
 7  
 8     public static void main(String[] args) throws IOException
 9     {
10         Person person = new Person(1234, "wang");
11         System.out.println("Person Serial" + person);
12         FileOutputStream fos = new FileOutputStream("Person.txt");
13         ObjectOutputStream oos = new ObjectOutputStream(fos);
14         oos.writeObject(person);
15         oos.flush();
16         oos.close();
17     }
18 }

（3）反序列化功能：

 1 import java.io.FileInputStream;
 2 import java.io.IOException;
 3 import java.io.ObjectInputStream;
 4 public class DeserialTest
 5 {
 6     public static void main(String[] args) throws IOException, ClassNotFoundException
 7     {
 8         Person person;
 9  
10         FileInputStream fis = new FileInputStream("Person.txt");
11         ObjectInputStream ois = new ObjectInputStream(fis);
12         person = (Person) ois.readObject();
13         ois.close();
14         System.out.println("Person Deserial" + person);
15     }
16  
17 }

狀況一：假設Person類序列化以後，從A端傳輸到B端，而後在B端進行反序列化。在序列化Person和反序列化Person的時候，A端和B端都須要存在一個相同的類。若是兩處的serialVersionUID不一致，會產生什麼錯誤呢?
【答案】能夠利用上面的代碼作個試驗來驗證：
先執行測試類SerialTest，生成序列化文件，表明A端序列化後的文件，而後修改serialVersion值，再執行測試類DeserialTest，表明B端使用不一樣serialVersion的類去反序列化，結果報錯:

Exception in thread "main" java.io.InvalidClassException: test.Person; local class incompatible: stream classdesc serialVersionUID = 1234567890, local class serialVersionUID = 123456789
    at java.io.ObjectStreamClass.initNonProxy(ObjectStreamClass.java:560)
    at java.io.ObjectInputStream.readNonProxyDesc(ObjectInputStream.java:1580)
    at java.io.ObjectInputStream.readClassDesc(ObjectInputStream.java:1493)
    at java.io.ObjectInputStream.readOrdinaryObject(ObjectInputStream.java:1729)
    at java.io.ObjectInputStream.readObject0(ObjectInputStream.java:1326)
    at java.io.ObjectInputStream.readObject(ObjectInputStream.java:348)
    at test.DeserialTest.main(DeserialTest.java:15)

 

狀況二：假設兩處serialVersionUID一致，若是A端增長一個字段，而後序列化，而B端不變，而後反序列化，會是什麼狀況呢?
【答案】新增 public int age; 執行SerialTest，生成序列化文件，表明A端。刪除 public int age，反序列化，表明B端，最後的結果爲：執行序列化，反序列化正常，可是A端增長的字段丟失(被B端忽略)。

 

狀況三：假設兩處serialVersionUID一致，若是B端減小一個字段，A端不變，會是什麼狀況呢?
【答案】序列化，反序列化正常，B端字段少於A端，A端多的字段值丟失(被B端忽略)。

 

狀況四：假設兩處serialVersionUID一致，若是B端增長一個字段，A端不變，會是什麼狀況呢?
驗證過程以下：
先執行SerialTest，而後在實體類Person增長一個字段age，以下所示，再執行測試類DeserialTest.

 1 import java.io.Serializable;
 2 public class Person implements Serializable
 3 {
 4     private static final long serialVersionUID = 123456789L;
 5     public int id;
 6     public String name;
 7     public int age;
 8  
 9     public Person(int id, String name)
10     {
11         this.id = id;
12         this.name = name;
13     }
14  
15     public String toString()
16     {
17         return "Person: " + id + " " + name;
18     }
19 }

相應的修改測試類DeserialTest，打印出age的值。

 1 import java.io.FileOutputStream;
 2 import java.io.IOException;
 3 import java.io.ObjectOutputStream;
 4  
 5 public class SerialTest
 6 {
 7  
 8     public static void main(String[] args) throws IOException
 9     {
10         Person person = new Person(1234, "wang");
11         System.out.println("Person Serial" + person + " age:" + person.age);
12         FileOutputStream fos = new FileOutputStream("Person.txt");
13         ObjectOutputStream oos = new ObjectOutputStream(fos);
14         oos.writeObject(person);
15         oos.flush();
16         oos.close();
17     }
18 }

結果爲：
Person Deserial Person: 1234 wang age: 0
說明序列化，反序列化正常，B端新增長的int字段被賦予了默認值0。
最後經過下面的圖片，總結一下上面的幾種狀況。

原文：http://swiftlet.net/archives/1268