serialVersionUID作用

言曌發表於2018-04-02
UI

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;
  8.     public Person(int id, String name)
  9.     {
  10.         this.id = id;
  11.         this.name = name;
  12.     }
  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;
  5. public class SerialTest
  6. {
  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;
  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.     }
  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.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;
  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.     }
  17. }

 

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

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

結果為：

Person Deserial Person: 1234 wang age: 0

說明序列化，反序列化正常，B端新增加的int欄位被賦予了預設值0。

最後通過下面的圖片，總結一下上面的幾種情況。
serialVersionUID作用

 

 

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

相關文章