序列化的 serialVersionUID 到底有什麼用?

做者 | 學無止境
來源 | cnblogs.com/duanxz/p/3511695.html

實現Serializable接口的目的是爲類可持久化,好比在網絡傳輸或本地存儲,爲系統的分佈和異構部署提供先決條件。html


若沒有序列化,如今咱們所熟悉的遠程調用,對象數據庫都不可能存在,serialVersionUID適用於java序列化機制。java


簡單來講,JAVA序列化的機制是經過判斷類的serialVersionUID來驗證的版本一致的。web


在進行反序列化時,JVM會把傳來的字節流中的serialVersionUID本地相應實體類的serialVersionUID進行比較。若是相同說明是一致的,能夠進行反序列化,不然會出現反序列化版本一致的異常,便是InvalidCastException。數據庫


具體序列化的過程是這樣的:序列化操做時會把系統當前類的serialVersionUID寫入到序列化文件中,當反序列化時系統會自動檢測文件中的serialVersionUID,判斷它是否與當前類中的serialVersionUID一致。微信


若是一致說明序列化文件的版本與當前類的版本是同樣的,能夠反序列化成功,不然就失敗;網絡


serialVersionUID有兩種顯示的生成方式:app


一是默認的1L,好比:private static final long serialVersionUID = 1L;        
函數


二是根據包名,類名,繼承關係,非私有的方法和屬性,以及參數,返回值等諸多因子計算得出的,極度複雜生成的一個64位的哈希字段。基本上計算出來的這個值是惟一的。測試


好比:private static final long  serialVersionUID = xxxxL;ui


注意:顯示聲明serialVersionUID能夠避免對象不一致,

當一個類實現類Serializable接口,若是沒有顯示定義serialVersionUIDEclipse會自動給出相應的提醒;面對這種狀況,咱們只須要在Eclipse中點擊類的warning圖標,Eclipse就會自動給出兩種生成方式。


若是不想定義,在Eclipse的設置中也能夠把它關掉的,設置以下:


Window ==> Preferences ==> Java ==> Compiler ==> Error/Warnings ==> Potential programming problems

將Serializable class without serialVersionUID的warning改爲ignore便可。


若是Class文件(類名,方法等)沒有發生變化(增長空格,換行,增長註釋等等),就算再編譯屢次,serialVersionUID也不會變化的。

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


(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不一致,會產生什麼樣的效果呢。


【答案】能夠利用上面的代碼作個試驗來驗證:


先執行測試類SerialTest,生成序列化文件,表明A端序列化後的文件,而後修改serialVersion值,再執行測試類DeserialTest,表明B端使用不一樣serialVersion的類去反序列化,結果報錯:


java.io.InvalidClassException: com.example.demo.entity.serializable.Persion; local class incompatiblestream 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)


狀況二:假設兩處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; 執行SerialTest,生成序列化文件,表明A端。刪除 public int age,反序列化,表明B端,最後的結果爲:執行序列化,反序列化正常,可是A端增長的字段丟失(被B端忽略)。

狀況三:假設兩處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端忽略)。


狀況四:假設兩處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。


最後經過下面的圖片,總結一下上面的幾種狀況。



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 方法,將對象序列化後,修改靜態變量的數值,再將序列化對象讀取出來,而後經過讀取出來的對象得到靜態變量的數值並打印出來。依照清單 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 所示。



上圖中能夠看出,attr一、attr二、attr三、attr5 都不會被序列化,放在父類中的好處在於當有另一個 Child 類時,attr一、attr二、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 () {
                     public Long run() {
                         return computeDefaultSUID(cl);
                    }
                }
            );
        }
         return suid.longValue();
    }




< END >

往期精選
  SpringBoot中Tomcat是如何啓動的
  選型必看:RabbitMQ七戰Kafka,差別立現
  棧與隊列簡介
  Spring Boot實現定時任務的四種方式
  自定義註解詳解及應用
  一文了解Zookeeper

本文分享自微信公衆號 - Java旅途(Javatrip)。
若有侵權,請聯繫 support@oschina.cn 刪除。
本文參與「OSC源創計劃」,歡迎正在閱讀的你也加入,一塊兒分享。

相關文章
相關標籤/搜索