java 序列化關鍵字 serialversionuid 的作用（附帶程式碼距離）

阿新 • • 發佈：2018-12-15

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

具體的序列化過程是這樣的：序列化操作的時候系統會把當前類的serialVersionUID寫入到序列化檔案中，當反序列化時系統會去檢測檔案中的serialVersionUID，判斷它是否與當前類的serialVersionUID一致，如果一致就說明序列化類的版本與當前類版本是一樣的，可以反序列化成功，否則失敗。

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）序列化實體類

package com.sf.code.serial;

import java.io.Serializable;

public class Person implements Serializable {
    private static final long serialVersionUID = 123456789L;
    public int id;
    public String name;

    public Person(int id, String name) {
        this.id = id;
        this.name = name;
    }

    public String toString() {
        return "Person: " + id + " " + name;
    }
}

（2）序列化功能：

package com.sf.code.serial;

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

public class SerialTest {

    public static void main(String[] args) throws IOException {
        Person person = new Person(1234, "wang");
        System.out.println("Person Serial" + person);
        FileOutputStream fos = new FileOutputStream("Person.txt");
        ObjectOutputStream oos = new ObjectOutputStream(fos);
        oos.writeObject(person);
        oos.flush();
        oos.close();
    }
}

（3）反序列化功能：

package com.sf.code.serial;

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

public class DeserialTest {
    public static void main(String[] args) throws IOException, ClassNotFoundException {
        Person person;

        FileInputStream fis = new FileInputStream("Person.txt");
        ObjectInputStream ois = new ObjectInputStream(fis);
        person = (Person) ois.readObject();
        ois.close();
        System.out.println("Person Deserial" + person);
    }

}

情況一：假設Person類序列化之後，從A端傳輸到B端，然後在B端進行反序列化。在序列化Person和反序列化Person的時候，A端和B端都需要存在一個相同的類。如果兩處的serialVersionUID不一致，會產生什麼錯誤呢? 【答案】可以利用上面的程式碼做個試驗來驗證：先執行測試類SerialTest，生成序列化檔案，代表A端序列化後的檔案，然後修改serialVersion值，再執行測試類DeserialTest，代表B端使用不同serialVersion的類去反序列化，結果報錯:

Exception in thread "main" java.io.InvalidClassException: com.sf.code.serial.Person; local class incompatible: stream classdesc serialVersionUID = 1234567890, local class serialVersionUID = 123456789
    at java.io.ObjectStreamClass.initNonProxy(ObjectStreamClass.java:621)
    at java.io.ObjectInputStream.readNonProxyDesc(ObjectInputStream.java:1623)
    at java.io.ObjectInputStream.readClassDesc(ObjectInputStream.java:1518)
    at java.io.ObjectInputStream.readOrdinaryObject(ObjectInputStream.java:1774)
    at java.io.ObjectInputStream.readObject0(ObjectInputStream.java:1351)
    at java.io.ObjectInputStream.readObject(ObjectInputStream.java:371)
    at com.sf.code.serial.DeserialTest.main(DeserialTest.java:13)

情況二：假設兩處serialVersionUID一致，如果A端增加一個欄位，然後序列化，而B端不變，然後反序列化，會是什麼情況呢?

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

public class SerialTest {

    public static void main(String[] args) throws IOException {
        Person person = new Person(1234, "wang", 100);
        System.out.println("Person Serial" + person);
        FileOutputStream fos = new FileOutputStream("Person.txt");
        ObjectOutputStream oos = new ObjectOutputStream(fos);
        oos.writeObject(person);
        oos.flush();
        oos.close();
    }
}

Person DeserialPerson: 1234,name:wang

【答案】新增 public int age; 執行SerialTest，生成序列化檔案，代表A端。刪除 public int age，反序列化，代表B端，最後的結果為：執行序列化，反序列化正常，但是A端增加的欄位丟失(被B端忽略)。

情況三：假設兩處serialVersionUID一致，如果B端減少一個欄位，A端不變，會是什麼情況呢?

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 String toString() {
        return "Person: " + id 
                //+ ",name:" + name 
                + ",age:" + age;
    }
}

Person DeserialPerson: 1234,age:0

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

情況四：假設兩處serialVersionUID一致，如果B端增加一個欄位，A端不變，會是什麼情況呢? 驗證過程如下：先執行SerialTest，然後在實體類Person增加一個欄位age，如下所示，再執行測試類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;
    }
}

結果：Person DeserialPerson: 1234,name:wang,age:0

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

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

靜態變數序列化

情境：檢視清單 2 的程式碼。

清單 2. 靜態變數序列化問題程式碼

 public class Test 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 Test());
			out.close();

			//序列化後修改為10
			Test.staticVar = 10;

			ObjectInputStream oin = new ObjectInputStream(new FileInputStream(
					"result.obj"));
			Test t = (Test) 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 方法，將物件序列化後，修改靜態變數的數值，再將序列化物件讀取出來，然後通過讀取出來的物件獲得靜態變數的數值並打印出來。依照清單 2，這個 System.out.println(t.staticVar) 語句輸出的是 10 還是 5 呢？

最後的輸出是 10，對於無法理解的讀者認為，列印的 staticVar 是從讀取的物件裡獲得的，應該是儲存時的狀態才對。之所以列印 10 的原因在於序列化時，並不儲存靜態變數，這其實比較容易理解，序列化儲存的是物件的狀態，靜態變數屬於類的狀態，因此序列化並不儲存靜態變數。

父類的序列化與 Transient 關鍵字

情境：一個子類實現了 Serializable 介面，它的父類都沒有實現 Serializable 介面，序列化該子類物件，然後反序列化後輸出父類定義的某變數的數值，該變數數值與序列化時的數值不同。

解決：要想將父類物件也序列化，就需要讓父類也實現Serializable 介面。如果父類不實現的話的，就需要有預設的無參的建構函式。在父類沒有實現 Serializable 介面時，虛擬機器是不會序列化父物件的，而一個 Java 物件的構造必須先有父物件，才有子物件，反序列化也不例外。所以反序列化時，為了構造父物件，只能呼叫父類的無參建構函式作為預設的父物件。因此當我們取父物件的變數值時，它的值是呼叫父類無參建構函式後的值。如果你考慮到這種序列化的情況，在父類無參建構函式中對變數進行初始化，否則的話，父類變數值都是預設宣告的值，如 int 型的預設是 0，string 型的預設是 null。

Transient 關鍵字的作用是控制變數的序列化，在變數宣告前加上該關鍵字，可以阻止該變數被序列化到檔案中，在被反序列化後，transient 變數的值被設為初始值，如 int 型的是 0，物件型的是 null。

特性使用案例

我們熟悉使用 Transient 關鍵字可以使得欄位不被序列化，那麼還有別的方法嗎？根據父類物件序列化的規則，我們可以將不需要被序列化的欄位抽取出來放到父類中，子類實現 Serializable 介面，父類不實現，根據父類序列化規則，父類的欄位資料將不被序列化，形成類圖如圖 2 所示。

圖 2. 案例程式類圖

上圖中可以看出，attr1、attr2、attr3、attr5 都不會被序列化，放在父類中的好處在於當有另外一個 Child 類時，attr1、attr2、attr3 依然不會被序列化，不用重複抒寫 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();
    }

java 序列化關鍵字 serialversionuid 的作用（附帶程式碼距離）

靜態變數序列化

父類的序列化與 Transient 關鍵字

static final 修飾的serialVersionUID如何被寫入到序列化檔案中的，看下面的原始碼：

java 序列化關鍵字 serialversionuid 的作用（附帶程式碼距離）

java 序列化有什麼作用

java序列化有什麼作用

java回收finalize方法的作用（編程思想）

Java中常用關鍵字詳解（不斷更新中）

常見的序列化技術及框架（Protobuf的使用）

python2和python3的區別（附帶程式碼解析）

JAVA BIO,NIO,AIO詳解（附程式碼實現）

Java內部類超詳細總結（含程式碼示例）

【演算法】手撕紅黑樹（上）—— 基本性質以及插入實現（附帶程式碼實現）

Java序列化接口Serializable接口的作用總結

Java 之 Serializable 序列化和反序列化的概念,作用的通俗易懂的解釋

Java 序列化之transient關鍵字

java序列化機制（簡單使用）

Java---序列化與反序列化（ObjectOutputStream/ObjectInputStream）

Serializable序列化中serialVersionUId的作用

（雜記）Java序列化Serializable和反序列化

什麼是java序列化，如何實現java序列化？或請解釋Serializable介面的作用

Java的序列化ID的作用

java 序列化與反序列化（一）

java 序列化關鍵字 serialversionuid 的作用 （附帶程式碼距離）

靜態變數序列化

父類的序列化與 Transient 關鍵字

static final 修飾的serialVersionUID如何被寫入到序列化檔案中的，看下面的原始碼：

相關推薦

java 序列化關鍵字 serialversionuid 的作用（附帶程式碼距離）