Java中 serialVersionUID 的作用是什麼?舉個例子說明

2021-03-02 程式設計師極客社區

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總是無意義的?
    這個題目不主要講serialVersionUID作用，而是講後面的那一串數字的意義，當然也會對java的這個serialVersionUID的作用進行一個講解。下面我們舉一個例子：(1)不指定serialVersionUID首先我們定義一個User類，繼承Serializable接口
  • java序列化反序列化中serialVersionUID到底有什麼用
    前言：在回答上面的問題之前，首先要知道什麼是序列化、反序列化、用途是什麼、實現的必要條件。序列化\反序列化：java序列化是指把java對象轉換為字節序列的過程，而java反序列化是指把字節序列恢復為java對象的過程。
  • 全方位解析Java序列化
    1) 序列化機制可以讓對象地保存到硬碟上，減輕內存壓力的同時，也起了持久化的作用；比如 Web 伺服器中的 Session 對象，當有 10萬+用戶並發訪問的，就有可能出現 10萬個 Session 對象，內存可能消化不良
  • Java程式設計師必備:序列化全方位解析
    比如 Web伺服器中的Session對象，當有 10+萬用戶並發訪問的，就有可能出現10萬個Session對象，內存可能消化不良，於是Web容器就會把一些seesion先序列化到硬碟中，等要用了，再把保存在硬碟中的對象還原到內存中
  • 面試官:連Serializable都不知道是什麼,你這5年都幹些什麼了?
    張工是一名java程式設計師，工作5年了，一直從事java開發。最近到某網際網路公司面試，做了筆試題後，有一道筆試題是這樣子的：Serializable有什麼作用，張工沒有作答，面談時面試官又問了，張工回答不出個所以然。面試官：你都工作五年了，連序列化都不知道，你這5年都幹些什麼了？
  • 【Java拾遺】不可不知的 Java 序列化
    序列化是什麼百度百科中給序列化的定義是『序列化 (Serialization)是將對象的狀態信息轉換為可以存儲或傳輸的形式的過程。』。似乎有點抽象，下面用一個例子簡單類比一下。日常生活中，總少不了人跟人之間的交流與溝通。而溝通的前提是先要把我們大腦中想的內容，通過某種形式表達出來。然後別人再通過我們表達出的內容去理解。
  • 一文帶你全面了解Java 序列化
    而且serialVersionUID序列化版本號的作用是用來區分我們所編寫的類的版本，用於反序列化時確定版本。舉個慄子，剛剛我們已經在磁碟中生成了NY對象的序列化文件，如果我們對NY類的serialVersionUID稍作改動，改成：private static final long serialVersionUID =8891488565683643643L;//將末尾的2改成3再執行一次反序列化方法
  • java命令總結(經典篇)
    Javap：Java反彙編器，顯示編譯類文件中的可訪問功能和數據，同時顯示字節代碼含義 jar：多用途的存檔及壓縮工具，是個java應用程式，可將多個文件合併為單個JAR歸檔文件。serialver功能說明： serialver 命令返回 serialVersionUID。
  • 深入理解Java:註解(Annotation)基本概念
    另外，儘管一些annotation通過java的反射api方法在運行時被訪問，而java語言解釋器在工作時忽略了這些annotation。正是由於java虛擬機忽略了Annotation，導致了annotation類型在代碼中是「不起作用」的； 只有通過某種配套的工具才會對annotation類型中的信息進行訪問和處理。
  • Java 拷貝,你能說出個 123 麼?
    * 上面這裡已經說明了，clone()方法是淺拷貝，而不是深拷貝 * @see java.lang.Cloneable */ protected native Object clone() throws CloneNotSupportedException;這是一個用 native 關鍵字修飾的方法。
  • 什麼是序列化,怎麼序列化,為什麼序列化,反序列化會遇到什麼問題,如何解決.
    遇到這個 Java Serializable 序列化這個接口，我們可能會有如下的問題作用。為啥要實現這個 Serializable 接口，也就是為啥要序列化serialVersionUID 這個的值到底是在怎麼設置的，有什麼用。有的是1L，有的是一長串數字，迷惑ing。
  • Java元註解作用及使用
    Java 5 定義了 4 個註解，分別是 @Documented、@Target、@Retention 和 @Inherited。Java 8 又增加了 @Repeatable 和 @Native 兩個註解。這些註解都可以在 java.lang.annotation 包中找到。下面主要介紹每個元註解的作用及使用。
  • 對衝基金到底是什麼 舉個例子你就明白了
    在資本的市場中，基金是其中的一大類。它對資本市場的作用也是不可小視的。相信許多的朋友聽說過對衝基金。那麼，今天小編就和大家一塊看一下對衝基金到底是什麼？希望對大家能夠有所幫助。 　　對衝基金到底是什麼？
  • 支付寶面試:什麼是序列化,怎麼序列化,為什麼序列化,反序列化會遇到什麼問題,如何解決?
    作用。為啥要實現這個 Serializable 接口，也就是為啥要序列化serialVersionUID 這個的值到底是在怎麼設置的，有什麼用。有的是1L，有的是一長串數字，迷惑ing。我剛剛見到這個關鍵字 Serializable 的時候，就有如上的這麼些問題。
  • Java中線程池的簡單使用
    什麼是線程池？顧名思義線程池就是線程的容器舉個例子：在沒有共享電源的年代，車站有5個人手機都沒電且都沒有帶電源，這五個人想要給手機充電只能去車站的售貨亭各花100塊錢買一個移動電源；但是現在共享電源出現了，假設車站現在一共有3個共享移動電源，那麼其中三個人只需要花一塊錢租共享移動電源充電，後面2個人等前面的人用完了，接著花1塊錢租就可以了
  • 舉幾個例子來聊聊股市投資分析中的統計學概念「倖存者偏差」
    或許這樣說還是有點繞，舉個生活中的例子吧，就是吃藥問題。說是自己身邊的人感冒都吃某種感冒藥，一星期就好了，結論就是這個感冒藥是很有效的。這個就出現了偏差，為什麼呢，因為你取樣取的都是你身邊人，如果其他人吃的都是另外的藥，而吃另外的藥都3天以內就好了，那麼你還會說你吃的這個感冒藥是很有效的嗎？這就是倖存者偏差。
  • java中的自定義註解
    今天準備把Java中的自定義註解分享一下子，因為好多小夥伴，貌似都不知道註解這個東西到底是什麼，只知道怎麼用，卻不知道註解的底層原理。其實就是在我們自定義註解時，註解到我們自定義的註解上的，舉個例子:@Target(ElementType.TYPE) public @interface Table { public String tableName() default "className"; }大家先不要管語法，Table其實就是我自定義的一個註解，
  • 通過「訪問修飾符」java想告訴我們什麼?
    01定義java有四個訪問修飾符public：被public修飾的成員可以被所有類訪問到protected：所修飾的成員會被位於同一包中所有類可以訪問到。四個訪問修飾符的作用域如下：結合這些定義，再回想我們平時的編碼和學習，public和private用的很多。下面就舉一個簡單的例子。
  • java中的註解,真的很重要,你理解了嘛?
    這篇文章開始講解java中的註解，在平時的開發當中我相信你或多或少的接觸過註解。比如你可能都見過@override，它代表的就是一個註解。但是，為了更加清晰的去介紹註解，我還是先給出一個例子，讓你能夠方便的理解。
  • Java 中的異常和處理詳解
    這種行為叫做異常的冒泡，異常的冒泡是為了在當前發生異常的函數或者這個函數的caller中找到最近的異常處理程序。由於這個例子中沒有使用任何異常處理機制，因此異常最終由main函數拋給JRE，導致程序終止。上面的代碼不使用異常處理機制，也可以順利編譯，因為2個異常都是非檢查異常。但是下面的例子就必須使用異常處理機制，因為異常是檢查異常。