Java 序列化筆記

1. 什麼是java對象序列化

    java平台允許我們在記憶體中建立可複用的java對象，但一般情況下，隻有當jvm處于運作時，這些對象才可能存在，即，這些對象的生命周期不會比jvm的生命周期更長。但在現實應用中，就可能要求在jvm停止運作之後能夠儲存(持久化)指定的對象，并在将來重新讀取被儲存的對象。java對象序列化就能夠幫助我們實作該功能。

    使用java對象序列化，在儲存對象時，會把其狀态儲存為一組位元組，在未來，再将這些位元組組裝成對象。必須注意地是，對象序列化儲存的是對象的"狀态"，即它的成員變量。由此可知，對象序列化不會關注類中的靜态變量。

    除了在持久化對象時會用到對象序列化之外，當使用rmi(遠端方法調用)，或在網絡中傳遞對象時，都會用到對象序列化。java序列化api為處理對象序列化提供了一個标準機制，該api簡單易用，在本文的後續章節中将會陸續講到。

2. 簡單示例

在java中，隻要一個類實作了java.io.serializable接口，那麼它就可以被序列化。此處将建立一個可序列化的類person，本文中的所有示例将圍繞着該類或其修改版。

    gender類，是一個枚舉類型，表示性别

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

<code>public</code> <code>class</code> <code>person </code><code>implements</code> <code>serializable {</code>

<code>    </code><code>private</code> <code>string name = </code><code>null</code><code>;</code>

<code>    </code><code>private</code> <code>integer age = </code><code>null</code><code>;</code>

<code>    </code><code>private</code> <code>gender gender = </code><code>null</code><code>;</code>

<code>    </code><code>public</code> <code>person() {</code>

<code>        </code><code>system.out.println(</code><code>"none-arg constructor"</code><code>);</code>

<code>    </code><code>}</code>

<code>    </code><code>public</code> <code>person(string name, integer age, gender gender) {</code>

<code>        </code><code>system.out.println(</code><code>"arg constructor"</code><code>);</code>

<code>        </code><code>this</code><code>.name = name;</code>

<code>        </code><code>this</code><code>.age = age;</code>

<code>        </code><code>this</code><code>.gender = gender;</code>

<code>    </code><code>public</code> <code>string getname() {</code>

<code>        </code><code>return</code> <code>name;</code>

<code>    </code><code>public</code> <code>void</code> <code>setname(string name) {</code>

<code>    </code><code>public</code> <code>integer getage() {</code>

<code>        </code><code>return</code> <code>age;</code>

<code>    </code><code>public</code> <code>void</code> <code>setage(integer age) {</code>

<code>    </code><code>public</code> <code>gender getgender() {</code>

<code>        </code><code>return</code> <code>gender;</code>

<code>    </code><code>public</code> <code>void</code> <code>setgender(gender gender) {</code>

<code>    </code><code>@override</code>

<code>    </code><code>public</code> <code>string tostring() {</code>

<code>        </code><code>return</code> <code>"["</code> <code>+ name + </code><code>", "</code> <code>+ age + </code><code>", "</code> <code>+ gender + </code><code>"]"</code><code>;</code>

<code>}</code>

　　

    simpleserial，是一個簡單的序列化程式，它先将一個person對象儲存到檔案person.out中，然後再從該檔案中讀出被存儲的person對象，并列印該對象。

<code>public</code> <code>class</code> <code>simpleserial {</code>

<code>    </code><code>public</code> <code>static</code> <code>void</code> <code>main(string[] args) </code><code>throws</code> <code>exception {</code>

<code>        </code><code>file file = </code><code>new</code> <code>file(</code><code>"person.out"</code><code>);</code>

<code>        </code><code>objectoutputstream oout = </code><code>new</code> <code>objectoutputstream(</code><code>new</code> <code>fileoutputstream(file));</code>

<code>        </code><code>person person = </code><code>new</code> <code>person(</code><code>"john"</code><code>, </code><code>101</code><code>, gender.male);</code>

<code>        </code><code>oout.writeobject(person);</code>

<code>        </code><code>oout.close();</code>

<code>        </code><code>objectinputstream oin = </code><code>new</code> <code>objectinputstream(</code><code>new</code> <code>fileinputstream(file));</code>

<code>        </code><code>object newperson = oin.readobject(); </code><code>// 沒有強制轉換到person類型</code>

<code>        </code><code>oin.close();</code>

<code>        </code><code>system.out.println(newperson);</code>

上述程式的輸出的結果為：

arg constructor

[john, 31, male]

    此時必須注意的是，當重新讀取被儲存的person對象時，并沒有調用person的任何構造器，看起來就像是直接使用位元組将person對象還原出來的。

當person對象被儲存到person.out檔案中之後，我們可以在其它地方去讀取該檔案以還原對象，但必須確定該讀取程式的classpath中包含有person.class(哪怕在讀取person對象時并沒有顯示地使用person類，如上例所示)，否則會抛出classnotfoundexception。

3. serializable的作用

    為什麼一個類實作了serializable接口，它就可以被序列化呢？在上節的示例中，使用objectoutputstream來持久化對象，在該類中有如下代碼：

<code>private</code> <code>void</code> <code>writeobject0(object obj, </code><code>boolean</code> <code>unshared) </code><code>throws</code> <code>ioexception {</code>

<code>    </code> 

<code>    </code><code>if</code> <code>(obj </code><code>instanceof</code> <code>string) {</code>

<code>        </code><code>writestring((string) obj, unshared);</code>

<code>    </code><code>} </code><code>else</code> <code>if</code> <code>(cl.isarray()) {</code>

<code>        </code><code>writearray(obj, desc, unshared);</code>

<code>    </code><code>} </code><code>else</code> <code>if</code> <code>(obj </code><code>instanceof</code> <code>enum) {</code>

<code>        </code><code>writeenum((enum) obj, desc, unshared);</code>

<code>    </code><code>} </code><code>else</code> <code>if</code> <code>(obj </code><code>instanceof</code> <code>serializable) {</code>

<code>        </code><code>writeordinaryobject(obj, desc, unshared);</code>

<code>    </code><code>} </code><code>else</code> <code>{</code>

<code>        </code><code>if</code> <code>(extendeddebuginfo) {</code>

<code>            </code><code>throw</code> <code>new</code> <code>notserializableexception(cl.getname() + </code><code>"\n"</code>

<code>                    </code><code>+ debuginfostack.tostring());</code>

<code>        </code><code>} </code><code>else</code> <code>{</code>

<code>            </code><code>throw</code> <code>new</code> <code>notserializableexception(cl.getname());</code>

<code>        </code><code>}</code>

從上述代碼可知，如果被寫對象的類型是string，或數組，或enum，或serializable，那麼就可以對該對象進行序列化，否則将抛出notserializableexception。

4. 預設序列化機制

    如果僅僅隻是讓某個類實作serializable接口，而沒有其它任何處理的話，則就是使用預設序列化機制。使用預設機制，在序列化對象時，不僅會序列化目前對象本身，還會對該對象引用的其它對象也進行序列化，同樣地，這些其它對象引用的另外對象也将被序列化，以此類推。是以，如果一個對象包含的成員變量是容器類對象，而這些容器所含有的元素也是容器類對象，那麼這個序列化的過程就會較複雜，開銷也較大。

5. 影響序列化

    在現實應用中，有些時候不能使用預設序列化機制。比如，希望在序列化過程中忽略掉敏感資料，或者簡化序列化過程。下面将介紹若幹影響序列化的方法。

5.1 transient關鍵字

    當某個字段被聲明為transient後，預設序列化機制就會忽略該字段。此處将person類中的age字段聲明為transient，如下所示，

<code>    </code><code>transient</code> <code>private</code> <code>integer age = </code><code>null</code><code>;</code>

再執行simpleserial應用程式，會有如下輸出：

[john, null, male]

可見，age字段未被序列化。

5.2 writeobject()方法與readobject()方法

    對于上述已被聲明為transitive的字段age，除了将transitive關鍵字去掉之外，是否還有其它方法能使它再次可被序列化？方法之一就是在person類中添加兩個方法：writeobject()與readobject()，如下所示：

<code>    </code><code>private</code> <code>void</code> <code>writeobject(objectoutputstream out) </code><code>throws</code> <code>ioexception {</code>

<code>        </code><code>out.defaultwriteobject();</code>

<code>        </code><code>out.writeint(age);</code>

<code>    </code><code>private</code> <code>void</code> <code>readobject(objectinputstream in) </code><code>throws</code> <code>ioexception, classnotfoundexception {</code>

<code>        </code><code>in.defaultreadobject();</code>

<code>        </code><code>age = in.readint();</code>

在writeobject()方法中會先調用objectoutputstream中的defaultwriteobject()方法，該方法會執行預設的序列化機制，如5.1節所述，此時會忽略掉age字段。然後再調用writeint()方法顯示地将age字段寫入到objectoutputstream中。readobject()的作用則是針對對象的讀取，其原理與writeobject()方法相同。

    再次執行simpleserial應用程式，則又會有如下輸出：

必須注意地是，writeobject()與readobject()都是private方法，那麼它們是如何被調用的呢？毫無疑問，是使用反射。詳情可見objectoutputstream中的writeserialdata方法，以及objectinputstream中的readserialdata方法。

5.3 externalizable接口

    無論是使用transient關鍵字，還是使用writeobject()和readobject()方法，其實都是基于serializable接口的序列化。jdk中提供了另一個序列化接口--externalizable，使用該接口之後，之前基于serializable接口的序列化機制就将失效。此時将person類修改成如下，

<code>public</code> <code>class</code> <code>person </code><code>implements</code> <code>externalizable {</code>

<code>    </code><code>public</code> <code>void</code> <code>writeexternal(objectoutput out) </code><code>throws</code> <code>ioexception {</code>

<code>    </code><code>public</code> <code>void</code> <code>readexternal(objectinput in) </code><code>throws</code> <code>ioexception, classnotfoundexception {</code>

此時再執行simpleserial程式之後會得到如下結果：

none-arg constructor

[null, null, null]

從該結果，一方面可以看出person對象中任何一個字段都沒有被序列化。另一方面，如果細心的話，還可以發現這此次序列化過程調用了person類的無參構造器。

    externalizable繼承于serializable，當使用該接口時，序列化的細節需要由程式員去完成。如上所示的代碼，由于writeexternal()與readexternal()方法未作任何處理，那麼該序列化行為将不會儲存/讀取任何一個字段。這也就是為什麼輸出結果中所有字段的值均為空。

    另外，若使用externalizable進行序列化，當讀取對象時，會調用被序列化類的無參構造器去建立一個新的對象，然後再将被儲存對象的字段的值分别填充到新對象中。這就是為什麼在此次序列化過程中person類的無參構造器會被調用。由于這個原因，實作externalizable接口的類必須要提供一個無參的構造器，且它的通路權限為public。

    對上述person類作進一步的修改，使其能夠對name與age字段進行序列化，但要忽略掉gender字段，如下代碼所示：

<code>        </code><code>out.writeobject(name);</code>

<code>        </code><code>name = (string) in.readobject();</code>

執行simpleserial之後會有如下結果：

[john, 31, null]

5.4 readresolve()方法

    當我們使用singleton模式時，應該是期望某個類的執行個體應該是唯一的，但如果該類是可序列化的，那麼情況可能會略有不同。此時對第2節使用的person類進行修改，使其實作singleton模式，如下所示：

<code>    </code><code>private</code> <code>static</code> <code>class</code> <code>instanceholder {</code>

<code>        </code><code>private</code> <code>static</code> <code>final</code> <code>person instatnce = </code><code>new</code> <code>person(</code><code>"john"</code><code>, </code><code>31</code><code>, gender.male);</code>

<code>    </code><code>public</code> <code>static</code> <code>person getinstance() {</code>

<code>        </code><code>return</code> <code>instanceholder.instatnce;</code>

<code>    </code><code>private</code> <code>person() {</code>

<code>    </code><code>private</code> <code>person(string name, integer age, gender gender) {</code>

同時要修改simpleserial應用，使得能夠儲存/擷取上述單例對象，并進行對象相等性比較，如下代碼所示：

<code>        </code><code>oout.writeobject(person.getinstance()); </code><code>// 儲存單例對象</code>

<code>        </code><code>object newperson = oin.readobject();</code>

<code>        </code><code>system.out.println(person.getinstance() == newperson); </code><code>// 将擷取的對象與person類中的單例對象進行相等性比較</code>

執行上述應用程式後會得到如下結果：

false

值得注意的是，從檔案person.out中擷取的person對象與person類中的單例對象并不相等。為了能在序列化過程仍能保持單例的特性，可以在person類中添加一個readresolve()方法，在該方法中直接傳回person的單例對象，如下所示：

<code>    </code><code>private</code> <code>object readresolve() </code><code>throws</code> <code>objectstreamexception {</code>

再次執行本節的simpleserial應用後将有如下輸出：

true

    無論是實作serializable接口，或是externalizable接口，當從i/o流中讀取對象時，readresolve()方法都會被調用到。實際上就是用readresolve()中傳回的對象直接替換在反序列化過程中建立的對象，而被建立的對象則會被垃圾回收掉。