來源:jiangshapub 的部落格(@jiangshapub)
關於Java序列化的文章早已是汗牛充棟了,本文是對我個人過往學習,理解及應用Java序列化的一個總結。此文內容涉及Java序列化的基本原理,以及多種方法對序列化形式進行定製。在撰寫本文時,既參考了Thinking in Java, Effective Java,JavaWorld,developerWorks中的相關文章和其它網路資料,也加入了自己的實踐經驗與理解,文、碼並茂,希望對大家有所幫助。
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 |
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 |
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 |
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 |
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應用,使得能夠儲存/獲取上述單例物件,並進行物件相等性比較,如下程式碼所示:
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)); 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()中返回的物件直接替換在反序列化過程中建立的物件,而被建立的物件則會被垃圾回收掉