1. 什么是Java對象序列化
Java平臺允許我們在內存中創建可復用的Java對象,但一般情況下,只有當JVM處于運行時,這些對象才可能存在,即,這些對象的生命周期不會比JVM的生命周期更長。但在現實應用中,就可能要求在JVM停止運行之后能夠保存(持久化)指定的對象,并在將來重新讀取被保存的對象。Java對象序列化就能夠幫助我們實現該功能。
使用Java對象序列化,在保存對象時,會把其狀態保存為一組字節,在未來,再將這些字節組裝成對象。必須注意地是,對象序列化保存的是對象的"狀態",即它的成員變量。由此可知,對象序列化不會關注類中的靜態變量。
除了在持久化對象時會用到對象序列化之外,當使用RMI(遠程方法調用),或在網絡中傳遞對象時,都會用到對象序列化。Java序列化API為處理對象序列化提供了一個標準機制,該API簡單易用,在本文的后續章節中將會陸續講到。
2. 簡單示例
在Java中,只要一個類實現了java.io.Serializable接口,那么它就可以被序列化。此處將創建一個可序列化的類Person,本文中的所有示例將圍繞著該類或其修改版。
Gender類,是一個枚舉類型,表示性別
1
2
3
|
public enum Gender { MALE, FEMALE } |
如果熟悉Java枚舉類型的話,應該知道每個枚舉類型都會默認繼承類java.lang.Enum,而該類實現了Serializable接口,所以枚舉類型對象都是默認可以被序列化的。
Person類,實現了Serializable接口,它包含三個字段:name,String類型;age,Integer類型;gender,Gender類型。另外,還重寫該類的toString()方法,以方便打印Person實例中的內容。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
public class Person implements Serializable { private String name = null ; private Integer age = null ; private Gender gender = null ; public Person() { System.out.println( "none-arg constructor" ); } public Person(String name, Integer age, Gender gender) { System.out.println( "arg constructor" ); this .name = name; this .age = age; this .gender = gender; } public String getName() { return name; } public void setName(String name) { this .name = name; } public Integer getAge() { return age; } public void setAge(Integer age) { this .age = age; } public Gender getGender() { return gender; } public void setGender(Gender gender) { this .gender = gender; } @Override public String toString() { return "[" + name + ", " + age + ", " + gender + "]" ; } } |
SimpleSerial,是一個簡單的序列化程序,它先將一個Person對象保存到文件person.out中,然后再從該文件中讀出被存儲的Person對象,并打印該對象。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
public class SimpleSerial { public static void main(String[] args) throws Exception { File file = new File( "person.out" ); ObjectOutputStream oout = new ObjectOutputStream( new FileOutputStream(file)); Person person = new Person( "John" , 101 , Gender.MALE); oout.writeObject(person); oout.close(); ObjectInputStream oin = new ObjectInputStream( new FileInputStream(file)); Object newPerson = oin.readObject(); // 沒有強制轉換到Person類型 oin.close(); System.out.println(newPerson); } } |
上述程序的輸出的結果為:
1
2
|
arg constructor [John, 31, MALE] |
此時必須注意的是,當重新讀取被保存的Person對象時,并沒有調用Person的任何構造器,看起來就像是直接使用字節將Person對象還原出來的。
當Person對象被保存到person.out文件中之后,我們可以在其它地方去讀取該文件以還原對象,但必須確保該讀取程序的CLASSPATH中包含有Person.class(哪怕在讀取Person對象時并沒有顯示地使用Person類,如上例所示),否則會拋出ClassNotFoundException。
3. Serializable的作用
為什么一個類實現了Serializable接口,它就可以被序列化呢?在上節的示例中,使用ObjectOutputStream來持久化對象,在該類中有如下代碼:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
private void writeObject0(Object obj, boolean unshared) throws IOException { ... if (obj instanceof String) { writeString((String) obj, unshared); } else if (cl.isArray()) { writeArray(obj, desc, unshared); } else if (obj instanceof Enum) { writeEnum((Enum) obj, desc, unshared); } else if (obj instanceof Serializable) { writeOrdinaryObject(obj, desc, unshared); } else { if (extendedDebugInfo) { throw new NotSerializableException(cl.getName() + "\n" + debugInfoStack.toString()); } else { throw new NotSerializableException(cl.getName()); } } ... } |
從上述代碼可知,如果被寫對象的類型是String,或數組,或Enum,或Serializable,那么就可以對該對象進行序列化,否則將拋出NotSerializableException。
4. 默認序列化機制
如果僅僅只是讓某個類實現Serializable接口,而沒有其它任何處理的話,則就是使用默認序列化機制。使用默認機制,在序列化對象時,不僅會序列化當前對象本身,還會對該對象引用的其它對象也進行序列化,同樣地,這些其它對象引用的另外對象也將被序列化,以此類推。所以,如果一個對象包含的成員變量是容器類對象,而這些容器所含有的元素也是容器類對象,那么這個序列化的過程就會較復雜,開銷也較大。
5. 影響序列化
在現實應用中,有些時候不能使用默認序列化機制。比如,希望在序列化過程中忽略掉敏感數據,或者簡化序列化過程。下面將介紹若干影響序列化的方法。
5.1 transient關鍵字
當某個字段被聲明為transient后,默認序列化機制就會忽略該字段。此處將Person類中的age字段聲明為transient,如下所示,
1
2
3
4
5
|
public class Person implements Serializable { ... transient private Integer age = null ; ... } |
再執行SimpleSerial應用程序,會有如下輸出:
1
2
|
arg constructor [John, null, MALE] |
可見,age字段未被序列化。
5.2 writeObject()方法與readObject()方法
對于上述已被聲明為transitive的字段age,除了將transitive關鍵字去掉之外,是否還有其它方法能使它再次可被序列化?方法之一就是在Person類中添加兩個方法:writeObject()與readObject(),如下所示:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
public class Person implements Serializable { ... transient private Integer age = null ; ... private void writeObject(ObjectOutputStream out) throws IOException { out.defaultWriteObject(); out.writeInt(age); } private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException { in.defaultReadObject(); age = in.readInt(); } } |
在writeObject()方法中會先調用ObjectOutputStream中的defaultWriteObject()方法,該方法會執行默認的序列化機制,如5.1節所述,此時會忽略掉age字段。然后再調用writeInt()方法顯示地將age字段寫入到ObjectOutputStream中。readObject()的作用則是針對對象的讀取,其原理與writeObject()方法相同。再次執行SimpleSerial應用程序,則又會有如下輸出:
1
2
|
arg constructor [John, 31, MALE] |
必須注意地是,writeObject()與readObject()都是private方法,那么它們是如何被調用的呢?毫無疑問,是使用反射。詳情可以看看ObjectOutputStream中的writeSerialData方法,以及ObjectInputStream中的readSerialData方法。
5.3 Externalizable接口
無論是使用transient關鍵字,還是使用writeObject()和readObject()方法,其實都是基于Serializable接口的序列化。JDK中提供了另一個序列化接口--Externalizable,使用該接口之后,之前基于Serializable接口的序列化機制就將失效。此時將Person類作如下修改,
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
public class Person implements Externalizable { private String name = null ; transient private Integer age = null ; private Gender gender = null ; public Person() { System.out.println( "none-arg constructor" ); } public Person(String name, Integer age, Gender gender) { System.out.println( "arg constructor" ); this .name = name; this .age = age; this .gender = gender; } private void writeObject(ObjectOutputStream out) throws IOException { out.defaultWriteObject(); out.writeInt(age); } private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException { in.defaultReadObject(); age = in.readInt(); } @Override public void writeExternal(ObjectOutput out) throws IOException { } @Override public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException { } ... } |
此時再執行SimpleSerial程序之后會得到如下結果:
1
2
3
|
arg constructor none-arg constructor [null, null, null] |
從該結果,一方面,可以看出Person對象中任何一個字段都沒有被序列化。另一方面,如果細心的話,還可以發現這此次序列化過程調用了Person類的無參構造器。
Externalizable繼承于Serializable,當使用該接口時,序列化的細節需要由程序員去完成。如上所示的代碼,由于writeExternal()與readExternal()方法未作任何處理,那么該序列化行為將不會保存/讀取任何一個字段。這也就是為什么輸出結果中所有字段的值均為空。
另外,使用Externalizable進行序列化時,當讀取對象時,會調用被序列化類的無參構造器去創建一個新的對象,然后再將被保存對象的字段的值分別填充到新對象中。這就是為什么在此次序列化過程中Person類的無參構造器會被調用。由于這個原因,實現Externalizable接口的類必須要提供一個無參的構造器,且它的訪問權限為public。
對上述Person類進行進一步的修改,使其能夠對name與age字段進行序列化,但忽略掉gender字段,如下代碼所示:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
|
public class Person implements Externalizable { private String name = null ; transient private Integer age = null ; private Gender gender = null ; public Person() { System.out.println( "none-arg constructor" ); } public Person(String name, Integer age, Gender gender) { System.out.println( "arg constructor" ); this .name = name; this .age = age; this .gender = gender; } private void writeObject(ObjectOutputStream out) throws IOException { out.defaultWriteObject(); out.writeInt(age); } private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException { in.defaultReadObject(); age = in.readInt(); } @Override public void writeExternal(ObjectOutput out) throws IOException { out.writeObject(name); out.writeInt(age); } @Override public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException { name = (String) in.readObject(); age = in.readInt(); } ... } |
執行SimpleSerial之后會有如下結果:
1
2
3
|
arg constructor none-arg constructor [John, 31, null] |
5.4 readResolve()方法
當我們使用Singleton模式時,應該是期望某個類的實例應該是唯一的,但如果該類是可序列化的,那么情況可能略有不同。此時對第2節使用的Person類進行修改,使其實現Singleton模式,如下所示:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
public class Person implements Serializable { private static class InstanceHolder { private static final Person instatnce = new Person( "John" , 31 , Gender.MALE); } public static Person getInstance() { return InstanceHolder.instatnce; } private String name = null ; private Integer age = null ; private Gender gender = null ; private Person() { System.out.println( "none-arg constructor" ); } private Person(String name, Integer age, Gender gender) { System.out.println( "arg constructor" ); this .name = name; this .age = age; this .gender = gender; } ... } 同時要修改SimpleSerial應用,使得能夠保存/獲取上述單例對象,并進行對象相等性比較,如下代碼所示: public class SimpleSerial { public static void main(String[] args) throws Exception { File file = new File( "person.out" ); ObjectOutputStream oout = new ObjectOutputStream( new FileOutputStream(file)); oout.writeObject(Person.getInstance()); // 保存單例對象 oout.close(); ObjectInputStream oin = new ObjectInputStream( new FileInputStream(file)); Object newPerson = oin.readObject(); oin.close(); System.out.println(newPerson); System.out.println(Person.getInstance() == newPerson); // 將獲取的對象與Person類中的單例對象進行相等性比較 } } |
執行上述應用程序后會得到如下結果:
1
2
3
|
arg constructor [John, 31, MALE] false |
值得注意的是,從文件person.out中獲取的Person對象與Person類中的單例對象并不相等。為了能在序列化過程仍能保持單例的特性,可以在Person類中添加一個readResolve()方法,在該方法中直接返回Person的單例對象,如下所示:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
|
public class Person implements Serializable { private static class InstanceHolder { private static final Person instatnce = new Person( "John" , 31 , Gender.MALE); } public static Person getInstance() { return InstanceHolder.instatnce; } private String name = null ; private Integer age = null ; private Gender gender = null ; private Person() { System.out.println( "none-arg constructor" ); } private Person(String name, Integer age, Gender gender) { System.out.println( "arg constructor" ); this .name = name; this .age = age; this .gender = gender; } private Object readResolve() throws ObjectStreamException { return InstanceHolder.instatnce; } ... } |
再次執行本節的SimpleSerial應用后將如下輸出:
1
2
3
|
arg constructor [John, 31, MALE] true |
無論是實現Serializable接口,或是Externalizable接口,當從I/O流中讀取對象時,readResolve()方法都會被調用到。實際上就是用readResolve()中返回的對象直接替換在反序列化過程中創建的對象。
6.一些高級用法
該說的都在注釋中說完了。直接給程序吧。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
package test.javaPuzzler.p5; import java.io.*; import java.io.ObjectInputStream.GetField; import java.io.ObjectOutputStream.PutField; // 一個類實現Serializable來表明自己可以被序列化; // 有一點需要特別注意的是: // 如果子類實現了Serializable,而父類沒有,則父類不會被序列化; public class SerializableObject implements Serializable { // 生成的序列化版本號會因為編譯環境,聲明的類名,成員名稱和數量的變化而不同; // 也就是說這個版本號一定程度上記錄著類的定義性的信息,如果類的定義變化了,最好重新生成版本號; // 如果新的代碼使用了舊的版本號,則在反序列化的時候,可以兼容讀取舊類的字節碼而不會報錯; private static final long serialVersionUID = 9038542591452547920L; public String name; public String password; // 如果你不希望某個非靜態成員被序列化,可以用transient來修飾它; public transient int age; // 靜態成員不會被序列化,因為序列化保存的是實例的狀態信息,而靜態成員是類的狀態信息; public static int version = 1 ; public SerializableObject(String name, String password) { this .name = name; this .password = password; } // 每個類可以寫一個writeObject方法,這個方法將會負責該類自身的序列化過程; // 比如對于敏感信息如password,可以加密之后再序列化; // 這個過程需要用到PutField,它可以指定哪些域會被序列化,怎么序列化(比如加密); // 如果沒有定義這個方法,將會調用ObjectOutputStream 的 defaultWriteObject; // 你可以注釋掉readObject方法,然后運行測試用例來測試密碼是否被加密; private void writeObject(ObjectOutputStream out) throws IOException { PutField putFields = out.putFields(); putFields.put( "name" , name); // 模擬加密密碼 putFields.put( "password" , "thePassword:" + password); out.writeFields(); } // 每個類可以寫一個readObject方法,該方法負責該類自身的反序列化過程; // 比如對序列化時加密后的密碼解密; // 這個過程需要用到GetField,他可以具體地讀取每個域;或執行解密動作等等; // 如果沒有定義這個方法,將會調用ObjectInputStream 的 defaultReadObject; private void readObject(ObjectInputStream in) throws ClassNotFoundException, IOException { GetField readFields = in.readFields(); // 讀取到成員的值之后,直接賦給該域,即完成該域的反序列化; name = (String) readFields.get( "name" , "defaultName" ); // 模擬解密密碼 String encPassword = (String) readFields.get( "password" , "thePassword:defaultValue" ); password = encPassword.split( ":" )[ 1 ]; } // 序列化 // 主要用到ObjectOutputStream; public void save() throws IOException { FileOutputStream fout = new FileOutputStream( "e:\\obj" ); ObjectOutputStream oout = new ObjectOutputStream(fout); oout.writeObject( this ); oout.close(); fout.close(); } // 反序列化 // 主要用到ObjectInputStream public static SerializableObject load() throws IOException, ClassNotFoundException { FileInputStream fin = new FileInputStream( "e:\\obj" ); ObjectInputStream oin = new ObjectInputStream(fin); Object o = oin.readObject(); return (SerializableObject) o; } @Override public String toString() { return "name: " + name + ", password: " + password; } // 測試用例 public static void main(String[] args) throws IOException, ClassNotFoundException { SerializableObject so = new SerializableObject( "http://blog.csdn.net/sunxing007" , "123456" ); so.save(); System.out.println(so); System.out.println(SerializableObject.load()); } } |
序列化會對單例模式不利, 因為可以通過反序列化而破壞單例. 這個時候就要請出readResolve這個方法了. 比如下面的程序:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
public class Dog extends Exception { //private static final long serialVersionUID = -7156412195888553079L; public static final Dog INSTANCE = new Dog(); private Dog() { } public String toString() { return "Woof" ; } // 通過readResolve, 保證反序列化的時候能完全自主地處理返回對象. private Object readResolve(){ return INSTANCE; } public static void main(String[] args) throws IOException, ClassNotFoundException{ Dog d = Dog.INSTANCE; ByteArrayOutputStream bro = new ByteArrayOutputStream(); ObjectOutputStream oout = new ObjectOutputStream(bro); oout.writeObject(d); ObjectInputStream oin = new ObjectInputStream( new ByteArrayInputStream(bro.toByteArray())); Dog d1 = (Dog)oin.readObject(); System.out.println(d1==d); } } |