serialVersionUID適用於JAVA的序列化機制。簡單來說,Java的序列化機制是通過判斷類的serialVersionUID來驗證版本一致性的。在進行反序列化時,JVM會把傳來的字節流中的serialVersionUID與本地相應實體類的serialVersionUID進行比較,如果相同就認爲是一致的,可以進行反序列化,否則就會出現序列化版本不一致的異常,即是InvalidCastException。
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)序列化實體類
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | import java.io.Serializable; public class Person implements Serializable { private static final long serialVersionUID = 1234567890L; 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)序列化功能:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
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("serialTest.txt");
ObjectOutputStream
oos
=
new
ObjectOutputStream(fos);
oos.writeObject(person);
oos.flush();
oos.close();
}
}
|
(3)反序列化功能:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | 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("serialTest.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不一致,會產生什麼錯誤呢?
答案如下:
1)先執行測試類SerialTest,生成序列化文件,代表A端序列化後的文件,然後修改serialVersion值,再執行測試類DeserialTest,代表B端使用不同serialVersion的類去反序列化,結果報錯:
|
Exception
in
thread
"main"
java.io.InvalidClassException:
test.Person;
local
class
incompatible:
stream
classdesc
serialVersionUID
=
1234567890,
local
class
serialVersionUID
=
123456789
at
java.io.ObjectStreamClass.initNonProxy(ObjectStreamClass.java:560)
at
java.io.ObjectInputStream.readNonProxyDesc(ObjectInputStream.java:1580)
at
java.io.ObjectInputStream.readClassDesc(ObjectInputStream.java:1493)
at
java.io.ObjectInputStream.readOrdinaryObject(ObjectInputStream.java:1729)
at
java.io.ObjectInputStream.readObject0(ObjectInputStream.java:1326)
at
java.io.ObjectInputStream.readObject(ObjectInputStream.java:348)
at
test.DeserialTest.main(DeserialTest.java:15)
|
情況二:假設兩處serialVersionUID一致,如果A端增加一個字段,然後序列化,而B端不變,然後反序列化,會是什麼情況呢?
【答案】新增 public int age; 執行SerialTest,生成序列化文件,代表A端。刪除 public int age,反序列化,代表B端,最後的結果爲:執行序列化,反序列化正常,但是A端增加的字段丟失(被B端忽略)。
情況三:假設兩處serialVersionUID一致,如果B端減少一個字段,A端不變,會是什麼情況呢?
【答案】序列化,反序列化正常,B端字段少於A端,A端多的字段值丟失(被B端忽略)。
情況三:假設兩處serialVersionUID一致,如果B端增加一個字段,A端不變,會是什麼情況呢?
驗證過程如下:
先執行SerialTest,然後在實體類Person增加一個字段age,如下所示,再執行測試類DeserialTest.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | import java.io.Serializable; public class Person implements Serializable { private static final long serialVersionUID = 123456789L; 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; } } |
相應的修改測試類DeserialTest,打印出age的值。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
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
+
" age:"
+
person.age);
FileOutputStream
fos
=
new
FileOutputStream("serialTest.txt");
ObjectOutputStream
oos
=
new
ObjectOutputStream(fos);
oos.writeObject(person);
oos.flush();
oos.close();
}
}
|
結果爲:
|
Person
DeserialPerson:
1234
wang,age:
0
|
說明序列化,反序列化正常,B端新增加的int字段被賦予了默認值0。