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 的代碼。
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 所示。
上圖中可以看出,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 作用 是什麼?舉個例子說明