java類中serialVersionUID的作用及其使用

更新時間：2019年12月04日 11:58:28 作者：SimpleSupervision

這篇文章主要介紹了java類中serialVersionUID的作用及其使用，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

實現(xiàn)Serializable接口的目的是為類可持久化，比如在網(wǎng)絡(luò)傳輸或本地存儲，為系統(tǒng)的分布和異構(gòu)部署提供先決條件。若沒有序列化，現(xiàn)在我們所熟悉的遠程調(diào)用，對象數(shù)據(jù)庫都不可能存在，

serialVersionUID適用于java序列化機制。簡單來說，JAVA序列化的機制是通過判斷類的serialVersionUID來驗證的版本一致的。在進行反序列化時，JVM會把傳來的字節(jié)流中的serialVersionUID于本地相應(yīng)實體類的serialVersionUID進行比較。如果相同說明是一致的，可以進行反序列化，否則會出現(xiàn)反序列化版本一致的異常，即是InvalidCastException。
具體序列化的過程是這樣的：序列化操作時會把系統(tǒng)當(dāng)前類的serialVersionUID寫入到序列化文件中，當(dāng)反序列化時系統(tǒng)會自動檢測文件中的serialVersionUID，判斷它是否與當(dāng)前類中的serialVersionUID一致。如果一致說明序列化文件的版本與當(dāng)前類的版本是一樣的，可以反序列化成功，否則就失??；

serialVersionUID有兩種顯示的生成方式：

一是默認的1L，比如：private static final long serialVersionUID = 1L;

二是根據(jù)包名，類名，繼承關(guān)系，非私有的方法和屬性，以及參數(shù)，返回值等諸多因子計算得出的，極度復(fù)雜生成的一個64位的哈希字段?；旧嫌嬎愠鰜淼倪@個值是唯一的。比如：private static final long serialVersionUID = xxxxL;
注意：顯示聲明serialVersionUID可以避免對象不一致，

當(dāng)一個類實現(xiàn)類Serializable接口，如果沒有顯示定義serialVersionUIDEclipse會自動給出相應(yīng)的提醒；面對這種情況，我們只需要在Eclipse中點擊類的warning圖標(biāo)，Eclipse就會自動給出兩種生成方式。如果不想定義，在Eclipse的設(shè)置中也可以把它關(guān)掉的，設(shè)置如下：
Window ==> Preferences ==> Java ==> Compiler ==> Error/Warnings ==> Potential programming problems

將Serializable class without serialVersionUID的warning改成ignore即可。

當(dāng)實現(xiàn)java.io.Serializable接口中沒有顯示的定義serialVersionUID變量的時候，JAVA序列化機制會根據(jù)Class自動生成一個serialVersionUID作序列化版本比較用，這種情況下，如果Class文件(類名，方法明等)沒有發(fā)生變化(增加空格，換行，增加注釋等等)，就算再編譯多次，serialVersionUID也不會變化的。

如果我們不希望通過編譯來強制劃分軟件版本，即實現(xiàn)序列化接口的實體能夠兼容先前版本，就需要顯示的定義一個serialVersionUID，類型為long的變量。不修改這個變量值的序列化實體，都可以相互進行序列化和反序列化。

下面用代碼說明一下serialVersionUID在應(yīng)用中常見的幾種情況。

（1）序列化實體類

package com.example.demo.entity.serializable;
 
import java.io.Serializable;
 
public class Persion implements Serializable {
 
  private static final long serialVersionUID = 4359709211352400087L;
  public Long id;
  public String name;
  public final String userName;
 
  public Persion(Long id, String name){
    this.id = id;
    this.name = name;
    userName = "dddbbb";
  }
 
  public String toString() {
    return id.toString() + "--" + name.toString();
  }
}

（2）序列化功能：

package com.example.demo.entity.serializable;
 
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.ObjectOutputStream;
 
public class SerialTest {
 
  public static void main(String[] args) {
    Persion p = new Persion(1L, "陳俊生");
    System.out.println("person Seria:" + p);
    try {
      FileOutputStream fos = new FileOutputStream("Persion.txt");
      ObjectOutputStream oos = new ObjectOutputStream(fos);
      oos.writeObject(p);
      oos.flush();
      oos.close();
    } catch (IOException e) {
      e.printStackTrace();
    }
  }
}

（3）反序列化功能

package com.example.demo.entity.serializable;
 
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.ObjectInputStream;
 
public class DeserialTest {
 
  public static void main(String[] args) {
    Persion p;
    try {
      FileInputStream fis = new FileInputStream("Persion.txt");
      ObjectInputStream ois = new ObjectInputStream(fis);
      p = (Persion) ois.readObject();
      ois.close();
      System.out.println(p.toString());
      System.out.println(p.userName);
    } catch (IOException | ClassNotFoundException e) {
      e.printStackTrace();
    }
  }
}

情況一：Persion類序列化之后，從A端傳到B端，然后在B端進行反序列化，在序列化Persion和反序列化Persion的時候A和B端都需要一個相同的類。如果兩處的serialVersionUID不一致，會產(chǎn)生什么樣的效果呢。

【答案】可以利用上面的代碼做個試驗來驗證：

先執(zhí)行測試類SerialTest，生成序列化文件，代表A端序列化后的文件，然后修改serialVersion值，再執(zhí)行測試類DeserialTest，代表B端使用不同serialVersion的類去反序列化，結(jié)果報錯:

java.io.InvalidClassException: com.example.demo.entity.serializable.Persion; local class incompatible: stream classdesc serialVersionUID = 4359709211352400087, local class serialVersionUID = 4359709211352400082
 at java.io.ObjectStreamClass.initNonProxy(ObjectStreamClass.java:616)
 at java.io.ObjectInputStream.readNonProxyDesc(ObjectInputStream.java:1843)
 at java.io.ObjectInputStream.readClassDesc(ObjectInputStream.java:1713)
 at java.io.ObjectInputStream.readOrdinaryObject(ObjectInputStream.java:2000)
 at java.io.ObjectInputStream.readObject0(ObjectInputStream.java:1535)
 at java.io.ObjectInputStream.readObject(ObjectInputStream.java:422)
 at com.example.demo.entity.serializable.DeserialTest.main(DeserialTest.java:22)

情況二：假設(shè)兩處serialVersionUID一致，如果A端增加一個字段，然后序列化，而B端不變，然后反序列化，會是什么情況呢?

package com.example.demo.entity.serializable;
 
import java.io.Serializable;
 
public class Persion implements Serializable {
 
  private static final long serialVersionUID = 4359709211352400082L;
  public Long id;
  public String name;
  public int age;
 
  public Persion(Long id, String name, int age){
    this.id = id;
    this.name = name;
    this.age = age;
  }
 
  public String toString() {
    return id.toString() + "--" + name.toString() + "age:" + age;
  }
}

package com.example.demo.entity.serializable;
 
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.ObjectOutputStream;
 
public class SerialTest {
 
  public static void main(String[] args) {
    Persion p = new Persion(1L, "陳俊生", 100);
    System.out.println("person Seria:" + p);
    try {
      FileOutputStream fos = new FileOutputStream("Persion.txt");
      ObjectOutputStream oos = new ObjectOutputStream(fos);
      oos.writeObject(p);
      oos.flush();
      oos.close();
    } catch (IOException e) {
      e.printStackTrace();
    }
  }
}

Person DeserialPerson:1--陳俊生

【答案】新增 public int age; 執(zhí)行SerialTest，生成序列化文件，代表A端。刪除 public int age，反序列化，代表B端，最后的結(jié)果為：執(zhí)行序列化，反序列化正常，但是A端增加的字段丟失(被B端忽略)。

情況三：假設(shè)兩處serialVersionUID一致，如果B端減少一個字段，A端不變，會是什么情況呢?

package com.example.demo.entity.serializable;
 
import java.io.Serializable;
 
public class Persion implements Serializable {
 
  private static final long serialVersionUID = 4359709211352400082L;
  public Long id;
  public String name;
//  public int age;
 
  public Persion(Long id, String name){
    this.id = id;
    this.name = name;
//    this.age = age;
  }
 
  public String toString() {
    return "Persion:"+id.toString() + "name:" + name.toString() ;
  }
}

Person DeserialPerson: 1234,age:0

【答案】序列化，反序列化正常，B端字段少于A端，A端多的字段值丟失(被B端忽略)。

情況四：假設(shè)兩處serialVersionUID一致，如果B端增加一個字段，A端不變，會是什么情況呢?

驗證過程如下：

先執(zhí)行SerialTest，然后在實體類Person增加一個字段age，如下所示，再執(zhí)行測試類DeserialTest.

package com.sf.code.serial;
 
import java.io.Serializable;
 
public class Person implements Serializable {
  private static final long serialVersionUID = 1234567890L;
  public int id;
  public String name;
  public int age;
 
  public Person(int id, String name) {
    this.id = id;
    this.name = name;
  }
  
  /*public Person(int id, String name, int age) {
    this.id = id;
    this.name = name;
    this.age = age;
  }*/
 
  public String toString() {
    return "Person: " + id 
        + ",name:" + name 
        + ",age:" + age;
  }
}

結(jié)果：Person DeserialPerson: 1234,name:wang,age:0

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

最后通過下面的圖片，總結(jié)一下上面的幾種情況。

package com.example.demo.entity.serializable;
 
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;
 
import org.aspectj.weaver.ast.Test;
 
public class TestStatic implements Serializable {
 
  private static final long serialVersionUID = 1L;
  public static int staticVar = 5;
 
  public static void main(String[] args) {
    try {
      // 初始時staticVar為5
      ObjectOutputStream out = new ObjectOutputStream(new FileOutputStream("result.obj"));
      out.writeObject(new TestStatic());
      out.close();
      // 序列化后修改為10
      TestStatic.staticVar = 10;
      ObjectInputStream oin = new ObjectInputStream(new FileInputStream("result.obj"));
      TestStatic t = (TestStatic) oin.readObject();
      oin.close();
      // 再讀取，通過t.staticVar打印新的值
      System.out.println(t.staticVar);
    } catch (FileNotFoundException e) {
      e.printStackTrace();
    } catch (IOException e) {
      e.printStackTrace();
    } catch (ClassNotFoundException e) {
      e.printStackTrace();
    }
  }
}

清單 2 中的 main 方法，將對象序列化后，修改靜態(tài)變量的數(shù)值，再將序列化對象讀取出來，然后通過讀取出來的對象獲得靜態(tài)變量的數(shù)值并打印出來。依照清單 2，這個 System.out.println(t.staticVar) 語句輸出的是 10 還是 5 呢？

最后的輸出是 10，對于無法理解的讀者認為，打印的 staticVar 是從讀取的對象里獲得的，應(yīng)該是保存時的狀態(tài)才對。之所以打印 10 的原因在于序列化時，并不保存靜態(tài)變量，這其實比較容易理解，序列化保存的是對象的狀態(tài)，靜態(tài)變量屬于類的狀態(tài)，因此序列化并不保存靜態(tài)變量。

父類的序列化與 Transient 關(guān)鍵字

情境：一個子類實現(xiàn)了 Serializable 接口，它的父類都沒有實現(xiàn) Serializable 接口，序列化該子類對象，然后反序列化后輸出父類定義的某變量的數(shù)值，該變量數(shù)值與序列化時的數(shù)值不同。

解決：要想將父類對象也序列化，就需要讓父類也實現(xiàn)Serializable 接口。如果父類不實現(xiàn)的話的，就需要有默認的無參的構(gòu)造函數(shù)。在父類沒有實現(xiàn) Serializable 接口時，虛擬機是不會序列化父對象的，而一個 Java 對象的構(gòu)造必須先有父對象，才有子對象，反序列化也不例外。所以反序列化時，為了構(gòu)造父對象，只能調(diào)用父類的無參構(gòu)造函數(shù)作為默認的父對象。因此當(dāng)我們?nèi)「笇ο蟮淖兞恐禃r，它的值是調(diào)用父類無參構(gòu)造函數(shù)后的值。如果你考慮到這種序列化的情況，在父類無參構(gòu)造函數(shù)中對變量進行初始化，否則的話，父類變量值都是默認聲明的值，如 int 型的默認是 0，string 型的默認是 null。

Transient 關(guān)鍵字的作用是控制變量的序列化，在變量聲明前加上該關(guān)鍵字，可以阻止該變量被序列化到文件中，在被反序列化后，transient 變量的值被設(shè)為初始值，如 int 型的是 0，對象型的是 null。

特性使用案例

我們熟悉使用 Transient 關(guān)鍵字可以使得字段不被序列化，那么還有別的方法嗎？根據(jù)父類對象序列化的規(guī)則，我們可以將不需要被序列化的字段抽取出來放到父類中，子類實現(xiàn) Serializable 接口，父類不實現(xiàn)，根據(jù)父類序列化規(guī)則，父類的字段數(shù)據(jù)將不被序列化，形成類圖如圖 2 所示。

上圖中可以看出，attr1、attr2、attr3、attr5 都不會被序列化，放在父類中的好處在于當(dāng)有另外一個 Child 類時，attr1、attr2、attr3 依然不會被序列化，不用重復(fù)抒寫 transient，代碼簡潔。

static final 修飾的serialVersionUID如何被寫入到序列化文件中的，看下面的源碼：
序列化寫入時的ObjectStreamClass.java中，

void writeNonProxy(ObjectOutputStream out) throws IOException {
    out.writeUTF(name);
    out.writeLong(getSerialVersionUID());

    byte flags = 0;
    ...

  public long getSerialVersionUID() {
    // REMIND: synchronize instead of relying on volatile?
    if (suid == null) {
      suid = AccessController.doPrivileged(
        new PrivilegedAction<Long>() {
          public Long run() {
            return computeDefaultSUID(cl);
          }
        }
      );
    }
    return suid.longValue();
  }