夯實(shí)Java基礎(chǔ)系列22：一文讀懂Java序列化和反序列化

本系列文章將整理到我在GitHub上的《Java面試指南》倉庫，更多精彩內(nèi)容請(qǐng)到我的倉庫里查看

https://github.com/h3pl/Java-Tutorial

喜歡的話麻煩點(diǎn)下Star哈

文章首發(fā)于我的個(gè)人博客：

www.how2playlife.com

<!-- more -->

本文參考 http://www.importnew.com/17964.html和
https://www.ibm.com/developerworks/cn/java/j-lo-serial/

序列化與反序列化概念

序列化 (Serialization)是將對(duì)象的狀態(tài)信息轉(zhuǎn)換為可以存儲(chǔ)或傳輸?shù)男问降倪^程。一般將一個(gè)對(duì)象存儲(chǔ)至一個(gè)儲(chǔ)存媒介，例如檔案或是記億體緩沖等。在網(wǎng)絡(luò)傳輸過程中，可以是字節(jié)或是XML等格式。而字節(jié)的或XML編碼格式可以還原完全相等的對(duì)象。這個(gè)相反的過程又稱為反序列化。

Java對(duì)象的序列化與反序列化

在Java中，我們可以通過多種方式來創(chuàng)建對(duì)象，并且只要對(duì)象沒有被回收我們都可以復(fù)用該對(duì)象。但是，我們創(chuàng)建出來的這些Java對(duì)象都是存在于JVM的堆內(nèi)存中的。

只有JVM處于運(yùn)行狀態(tài)的時(shí)候，這些對(duì)象才可能存在。一旦JVM停止運(yùn)行，這些對(duì)象的狀態(tài)也就隨之而丟失了。

但是在真實(shí)的應(yīng)用場(chǎng)景中，我們需要將這些對(duì)象持久化下來，并且能夠在需要的時(shí)候把對(duì)象重新讀取出來。Java的對(duì)象序列化可以幫助我們實(shí)現(xiàn)該功能。

對(duì)象序列化機(jī)制（object serialization）是Java語言內(nèi)建的一種對(duì)象持久化方式，通過對(duì)象序列化，可以把對(duì)象的狀態(tài)保存為字節(jié)數(shù)組，并且可以在有需要的時(shí)候?qū)⑦@個(gè)字節(jié)數(shù)組通過反序列化的方式再轉(zhuǎn)換成對(duì)象。

對(duì)象序列化可以很容易的在JVM中的活動(dòng)對(duì)象和字節(jié)數(shù)組（流）之間進(jìn)行轉(zhuǎn)換。

在Java中，對(duì)象的序列化與反序列化被廣泛應(yīng)用到RMI(遠(yuǎn)程方法調(diào)用)及網(wǎng)絡(luò)傳輸中。

相關(guān)接口及類

Java為了方便開發(fā)人員將Java對(duì)象進(jìn)行序列化及反序列化提供了一套方便的API來支持。其中包括以下接口和類：

java.io.Serializable

java.io.Externalizable

ObjectOutput

ObjectInput

ObjectOutputStream

ObjectInputStream

Serializable 接口

類通過實(shí)現(xiàn) java.io.Serializable 接口以啟用其序列化功能。

未實(shí)現(xiàn)此接口的類將無法使其任何狀態(tài)序列化或反序列化?？尚蛄谢惖乃凶宇愋捅旧矶际强尚蛄谢?。序列化接口沒有方法或字段，僅用于標(biāo)識(shí)可序列化的語義。 (該接口并沒有方法和字段，為什么只有實(shí)現(xiàn)了該接口的類的對(duì)象才能被序列化呢？)

當(dāng)試圖對(duì)一個(gè)對(duì)象進(jìn)行序列化的時(shí)候，如果遇到不支持 Serializable 接口的對(duì)象。在此情況下，將拋出NotSerializableException。

如果要序列化的類有父類，要想同時(shí)將在父類中定義過的變量持久化下來，那么父類也應(yīng)該集成java.io.Serializable接口。

下面是一個(gè)實(shí)現(xiàn)了java.io.Serializable接口的類

public class 序列化和反序列化 {

    public static void main(String[] args) {

    }
    //注意，內(nèi)部類不能進(jìn)行序列化，因?yàn)樗蕾囉谕獠款?    @Test
    public void test() throws IOException {
        A a = new A();
        a.i = 1;
        a.s = "a";
        FileOutputStream fileOutputStream = null;
        FileInputStream fileInputStream = null;
        try {
            //將obj寫入文件
            fileOutputStream = new FileOutputStream("temp");
            ObjectOutputStream objectOutputStream = new ObjectOutputStream(fileOutputStream);
            objectOutputStream.writeObject(a);
            fileOutputStream.close();
            //通過文件讀取obj
            fileInputStream = new FileInputStream("temp");
            ObjectInputStream objectInputStream = new ObjectInputStream(fileInputStream);
            A a2 = (A) objectInputStream.readObject();
            fileInputStream.close();
            System.out.println(a2.i);
            System.out.println(a2.s);
            //打印結(jié)果和序列化之前相同
        } catch (IOException e) {
            e.printStackTrace();
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
    }
}

class A implements Serializable {

    int i;
    String s;
}

Externalizable接口

除了Serializable 之外，java中還提供了另一個(gè)序列化接口Externalizable

為了了解Externalizable接口和Serializable接口的區(qū)別，先來看代碼，我們把上面的代碼改成使用Externalizable的形式。

class B implements Externalizable {
    //必須要有公開無參構(gòu)造函數(shù)。否則報(bào)錯(cuò)
    public B() {

    }
    int i;
    String s;
    @Override
    public void writeExternal(ObjectOutput out) throws IOException {

    }

    @Override
    public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {

    }
}

@Test
    public void test2() throws IOException, ClassNotFoundException {
        B b = new B();
        b.i = 1;
        b.s = "a";
        //將obj寫入文件
        FileOutputStream fileOutputStream = new FileOutputStream("temp");
        ObjectOutputStream objectOutputStream = new ObjectOutputStream(fileOutputStream);
        objectOutputStream.writeObject(b);
        fileOutputStream.close();
        //通過文件讀取obj
        FileInputStream fileInputStream = new FileInputStream("temp");
        ObjectInputStream objectInputStream = new ObjectInputStream(fileInputStream);
        B b2 = (B) objectInputStream.readObject();
        fileInputStream.close();
        System.out.println(b2.i);
        System.out.println(b2.s);
        //打印結(jié)果為0和null，即初始值，沒有被賦值
        //0
        //null
    }

通過上面的實(shí)例可以發(fā)現(xiàn)，對(duì)B類進(jìn)行序列化及反序列化之后得到的對(duì)象的所有屬性的值都變成了默認(rèn)值。也就是說，之前的那個(gè)對(duì)象的狀態(tài)并沒有被持久化下來。這就是Externalizable接口和Serializable接口的區(qū)別：

Externalizable繼承了Serializable，該接口中定義了兩個(gè)抽象方法：writeExternal()與readExternal()。

當(dāng)使用Externalizable接口來進(jìn)行序列化與反序列化的時(shí)候需要開發(fā)人員重寫writeExternal()與readExternal()方法。由于上面的代碼中，并沒有在這兩個(gè)方法中定義序列化實(shí)現(xiàn)細(xì)節(jié)，所以輸出的內(nèi)容為空。

還有一點(diǎn)值得注意：在使用Externalizable進(jìn)行序列化的時(shí)候，在讀取對(duì)象時(shí)，會(huì)調(diào)用被序列化類的無參構(gòu)造器去創(chuàng)建一個(gè)新的對(duì)象，然后再將被保存對(duì)象的字段的值分別填充到新對(duì)象中。所以，實(shí)現(xiàn)Externalizable接口的類必須要提供一個(gè)public的無參的構(gòu)造器。

class C implements Externalizable {
    int i;
    int j;
    String s;
    public C() {

    }
    //實(shí)現(xiàn)下面兩個(gè)方法可以選擇序列化中需要被復(fù)制的成員。
    //并且，寫入順序和讀取順序要一致，否則報(bào)錯(cuò)。
    //可以寫入多個(gè)同類型變量，順序保持一致即可。
    @Override
    public void writeExternal(ObjectOutput out) throws IOException {
        out.writeInt(i);
        out.writeInt(j);
        out.writeObject(s);
    }

    @Override
    public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
        i = in.readInt();
        j = in.readInt();
        s = (String) in.readObject();
    }
}

@Test
    public void test3() throws IOException, ClassNotFoundException {
        C c = new C();
        c.i = 1;
        c.j = 2;
        c.s = "a";
        //將obj寫入文件
        FileOutputStream fileOutputStream = new FileOutputStream("temp");
        ObjectOutputStream objectOutputStream = new ObjectOutputStream(fileOutputStream);
        objectOutputStream.writeObject(c);
        fileOutputStream.close();
        //通過文件讀取obj
        FileInputStream fileInputStream = new FileInputStream("temp");
        ObjectInputStream objectInputStream = new ObjectInputStream(fileInputStream);
        C c2 = (C) objectInputStream.readObject();
        fileInputStream.close();
        System.out.println(c2.i);
        System.out.println(c2.j);
        System.out.println(c2.s);
        //打印結(jié)果為0和null，即初始值，沒有被賦值
        //0
        //null
    }

序列化ID

序列化 ID 問題
情境：兩個(gè)客戶端 A 和 B 試圖通過網(wǎng)絡(luò)傳遞對(duì)象數(shù)據(jù)，A 端將對(duì)象 C 序列化為二進(jìn)制數(shù)據(jù)再傳給 B，B 反序列化得到 C。

問題：C 對(duì)象的全類路徑假設(shè)為 com.inout.Test，在 A 和 B 端都有這么一個(gè)類文件，功能代碼完全一致。也都實(shí)現(xiàn)了 Serializable 接口，但是反序列化時(shí)總是提示不成功。

解決：虛擬機(jī)是否允許反序列化，不僅取決于類路徑和功能代碼是否一致，一個(gè)非常重要的一點(diǎn)是兩個(gè)類的序列化 ID 是否一致（就是 private static final long serialVersionUID = 1L）。清單 1 中，雖然兩個(gè)類的功能代碼完全一致，但是序列化 ID 不同，他們無法相互序列化和反序列化。

package com.inout; 

import java.io.Serializable; 

public class A implements Serializable { 

    private static final long serialVersionUID = 1L; 

    private String name; 

    public String getName() 
    { 
        return name; 
    } 

    public void setName(String name) 
    { 
        this.name = name; 
    } 
} 

package com.inout; 

import java.io.Serializable; 

public class A implements Serializable { 

    private static final long serialVersionUID = 2L; 

    private String name; 

    public String getName() 
    { 
        return name; 
    } 

    public void setName(String name) 
    { 
        this.name = name; 
    } 
}

靜態(tài)變量不參與序列化

清單 2 中的 main 方法，將對(duì)象序列化后，修改靜態(tài)變量的數(shù)值，再將序列化對(duì)象讀取出來，然后通過讀取出來的對(duì)象獲得靜態(tài)變量的數(shù)值并打印出來。依照清單 2，這個(gè) System.out.println(t.staticVar) 語句輸出的是 10 還是 5 呢？

public class Test implements Serializable {

    private static final long serialVersionUID = 1L;

    public static int staticVar = 5;

    public static void main(String[] args) {
        try {
            //初始時(shí)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();
        }
    }
}

最后的輸出是 10，對(duì)于無法理解的讀者認(rèn)為，打印的 staticVar 是從讀取的對(duì)象里獲得的，應(yīng)該是保存時(shí)的狀態(tài)才對(duì)。之所以打印 10 的原因在于序列化時(shí)，并不保存靜態(tài)變量，這其實(shí)比較容易理解，序列化保存的是對(duì)象的狀態(tài)，靜態(tài)變量屬于類的狀態(tài)，因此 序列化并不保存靜態(tài)變量。

探究ArrayList的序列化

ArrayList的序列化
在介紹ArrayList序列化之前，先來考慮一個(gè)問題：

如何自定義的序列化和反序列化策略

帶著這個(gè)問題，我們來看java.util.ArrayList的源碼

public class ArrayList<E> extends AbstractList<E>
        implements List<E>, RandomAccess, Cloneable, java.io.Serializable
{
    private static final long serialVersionUID = 8683452581122892189L;
    transient Object[] elementData; // non-private to simplify nested class access
    private int size;
}

筆者省略了其他成員變量，從上面的代碼中可以知道ArrayList實(shí)現(xiàn)了java.io.Serializable接口，那么我們就可以對(duì)它進(jìn)行序列化及反序列化。

因?yàn)閑lementData是transient的（1.8好像改掉了這一點(diǎn))，所以我們認(rèn)為這個(gè)成員變量不會(huì)被序列化而保留下來。我們寫一個(gè)Demo，驗(yàn)證一下我們的想法：

public class ArrayList的序列化 {
    public static void main(String[] args) throws IOException, ClassNotFoundException {
        ArrayList list = new ArrayList();
        list.add("a");
        list.add("b");
        ObjectOutputStream objectOutputStream = new ObjectOutputStream(new FileOutputStream("arr"));
        objectOutputStream.writeObject(list);
        objectOutputStream.close();
        ObjectInputStream objectInputStream = new ObjectInputStream(new FileInputStream("arr"));
        ArrayList list1 = (ArrayList) objectInputStream.readObject();
        objectInputStream.close();
        System.out.println(Arrays.toString(list.toArray()));
        //序列化成功，里面的元素保持不變。
    }

了解ArrayList的人都知道，ArrayList底層是通過數(shù)組實(shí)現(xiàn)的。那么數(shù)組elementData其實(shí)就是用來保存列表中的元素的。通過該屬性的聲明方式我們知道，他是無法通過序列化持久化下來的。那么為什么code 4的結(jié)果卻通過序列化和反序列化把List中的元素保留下來了呢？

writeObject和readObject方法

在ArrayList中定義了來個(gè)方法： writeObject和readObject。

這里先給出結(jié)論:

在序列化過程中，如果被序列化的類中定義了writeObject 和 readObject 方法，虛擬機(jī)會(huì)試圖調(diào)用對(duì)象類里的 writeObject 和 readObject 方法，進(jìn)行用戶自定義的序列化和反序列化。

如果沒有這樣的方法，則默認(rèn)調(diào)用是 ObjectOutputStream 的 defaultWriteObject 方法以及 ObjectInputStream 的 defaultReadObject 方法。

用戶自定義的 writeObject 和 readObject 方法可以允許用戶控制序列化的過程，比如可以在序列化的過程中動(dòng)態(tài)改變序列化的數(shù)值。

來看一下這兩個(gè)方法的具體實(shí)現(xiàn)：

private void readObject(java.io.ObjectInputStream s)
        throws java.io.IOException, ClassNotFoundException {
        elementData = EMPTY_ELEMENTDATA;

        // Read in size, and any hidden stuff
        s.defaultReadObject();

        // Read in capacity
        s.readInt(); // ignored

        if (size > 0) {
            // be like clone(), allocate array based upon size not capacity
            ensureCapacityInternal(size);

            Object[] a = elementData;
            // Read in all elements in the proper order.
            for (int i=0; i<size; i++) {
                a[i] = s.readObject();
            }
        }
    }

private void writeObject(java.io.ObjectOutputStream s)
        throws java.io.IOException{
        // Write out element count, and any hidden stuff
        int expectedModCount = modCount;
        s.defaultWriteObject();

        // Write out size as capacity for behavioural compatibility with clone()
        s.writeInt(size);

        // Write out all elements in the proper order.
        for (int i=0; i<size; i++) {
            s.writeObject(elementData[i]);
        }

        if (modCount != expectedModCount) {
            throw new ConcurrentModificationException();
        }
    }

那么為什么ArrayList要用這種方式來實(shí)現(xiàn)序列化呢？

why transient
ArrayList實(shí)際上是動(dòng)態(tài)數(shù)組，每次在放滿以后自動(dòng)增長設(shè)定的長度值，如果數(shù)組自動(dòng)增長長度設(shè)為100，而實(shí)際只放了一個(gè)元素，那就會(huì)序列化99個(gè)null元素。為了保證在序列化的時(shí)候不會(huì)將這么多null同時(shí)進(jìn)行序列化，ArrayList把元素?cái)?shù)組設(shè)置為transient。

why writeObject and readObject
前面說過，為了防止一個(gè)包含大量空對(duì)象的數(shù)組被序列化，為了優(yōu)化存儲(chǔ)，所以，ArrayList使用transient來聲明elementData。 但是，作為一個(gè)集合，在序列化過程中還必須保證其中的元素可以被持久化下來，所以，通過重寫writeObject 和 readObject方法的方式把其中的元素保留下來。

writeObject方法把elementData數(shù)組中的元素遍歷的保存到輸出流（ObjectOutputStream）中。

readObject方法從輸入流（ObjectInputStream）中讀出對(duì)象并保存賦值到elementData數(shù)組中。

如何自定義的序列化和反序列化策略

延續(xù)上一部分，剛剛我們明白了ArrayList序列化數(shù)組元素的原理。

至此，我們先試著來回答剛剛提出的問題：

如何自定義的序列化和反序列化策略

答：可以通過在被序列化的類中增加writeObject 和 readObject方法。那么問題又來了：

雖然ArrayList中寫了writeObject 和 readObject 方法，但是這兩個(gè)方法并沒有顯示的被調(diào)用啊。

那么如果一個(gè)類中包含writeObject 和 readObject 方法，那么這兩個(gè)方法是怎么被調(diào)用的呢?

ObjectOutputStream
從code 4中，我們可以看出，對(duì)象的序列化過程通過ObjectOutputStream和ObjectInputputStream來實(shí)現(xiàn)的，那么帶著剛剛的問題，我們來分析一下ArrayList中的writeObject 和 readObject 方法到底是如何被調(diào)用的呢？

為了節(jié)省篇幅，這里給出ObjectOutputStream的writeObject的調(diào)用棧：

writeObject ---> writeObject0 --->writeOrdinaryObject--->writeSerialData--->invokeWriteObject

這里看一下invokeWriteObject：

void invokeWriteObject(Object obj, ObjectOutputStream out)
        throws IOException, UnsupportedOperationException
    {
        if (writeObjectMethod != null) {
            try {
                writeObjectMethod.invoke(obj, new Object[]{ out });
            } catch (InvocationTargetException ex) {
                Throwable th = ex.getTargetException();
                if (th instanceof IOException) {
                    throw (IOException) th;
                } else {
                    throwMiscException(th);
                }
            } catch (IllegalAccessException ex) {
                // should not occur, as access checks have been suppressed
                throw new InternalError(ex);
            }
        } else {
            throw new UnsupportedOperationException();
        }
    }

其中writeObjectMethod.invoke(obj, new Object[]{ out });是關(guān)鍵，通過反射的方式調(diào)用writeObjectMethod方法。官方是這么解釋這個(gè)writeObjectMethod的：

class-defined writeObject method, or null if none

在我們的例子中，這個(gè)方法就是我們?cè)贏rrayList中定義的writeObject方法。通過反射的方式被調(diào)用了。

至此，我們先試著來回答剛剛提出的問題：

如果一個(gè)類中包含writeObject 和 readObject 方法，那么這兩個(gè)方法是怎么被調(diào)用的?

答：在使用ObjectOutputStream的writeObject方法和ObjectInputStream的readObject方法時(shí)，會(huì)通過反射的方式調(diào)用。

為什么要實(shí)現(xiàn)Serializable

至此，我們已經(jīng)介紹完了ArrayList的序列化方式。那么，不知道有沒有人提出這樣的疑問：

Serializable明明就是一個(gè)空的接口，它是怎么保證只有實(shí)現(xiàn)了該接口的方法才能進(jìn)行序列化與反序列化的呢？

Serializable接口的定義：

public interface Serializable {
}
讀者可以嘗試把code 1中的繼承Serializable的代碼去掉，再執(zhí)行code 2，會(huì)拋出java.io.NotSerializableException。

其實(shí)這個(gè)問題也很好回答，我們?cè)倩氐絼倓侽bjectOutputStream的writeObject的調(diào)用棧：

writeObject ---> writeObject0 --->writeOrdinaryObject--->writeSerialData--->invokeWriteObject

writeObject0方法中有這么一段代碼：

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());
                }
            }

在進(jìn)行序列化操作時(shí)，會(huì)判斷要被序列化的類是否是Enum、Array和Serializable類型，如果不是則直接拋出NotSerializableException。

序列化知識(shí)點(diǎn)總結(jié)

1、如果一個(gè)類想被序列化，需要實(shí)現(xiàn)Serializable接口。否則將拋出NotSerializableException異常，這是因?yàn)?，在序列化操作過程中會(huì)對(duì)類型進(jìn)行檢查，要求被序列化的類必須屬于Enum、Array和Serializable類型其中的任何一種。

2、通過ObjectOutputStream和ObjectInputStream對(duì)對(duì)象進(jìn)行序列化及反序列化

3、虛擬機(jī)是否允許反序列化，不僅取決于類路徑和功能代碼是否一致，一個(gè)非常重要的一點(diǎn)是兩個(gè)類的序列化 ID 是否一致（就是 private static final long serialVersionUID）

序列化 ID 在 Eclipse 下提供了兩種生成策略，一個(gè)是固定的 1L，一個(gè)是隨機(jī)生成一個(gè)不重復(fù)的 long 類型數(shù)據(jù)（實(shí)際上是使用 JDK 工具生成），在這里有一個(gè)建議，如果沒有特殊需求，就是用默認(rèn)的 1L 就可以，這樣可以確保代碼一致時(shí)反序列化成功。那么隨機(jī)生成的序列化 ID 有什么作用呢，有些時(shí)候，通過改變序列化 ID 可以用來限制某些用戶的使用。

4、序列化并不保存靜態(tài)變量。

5、要想將父類對(duì)象也序列化，就需要讓父類也實(shí)現(xiàn)Serializable 接口。

6、Transient 關(guān)鍵字的作用是控制變量的序列化，在變量聲明前加上該關(guān)鍵字，可以阻止該變量被序列化到文件中，在被反序列化后，transient 變量的值被設(shè)為初始值，如 int 型的是 0，對(duì)象型的是 null。

7、服務(wù)器端給客戶端發(fā)送序列化對(duì)象數(shù)據(jù)，對(duì)象中有一些數(shù)據(jù)是敏感的，比如密碼字符串等，希望對(duì)該密碼字段在序列化時(shí)，進(jìn)行加密，而客戶端如果擁有解密的密鑰，只有在客戶端進(jìn)行反序列化時(shí)，才可以對(duì)密碼進(jìn)行讀取，這樣可以一定程度保證序列化對(duì)象的數(shù)據(jù)安全。

8、在類中增加writeObject 和 readObject 方法可以實(shí)現(xiàn)自定義序列化策略

參考文章

https://blog.csdn.net/qq_34988624/article/details/86592229

https://www.meiwen.com.cn/subject/slhvhqtx.html

https://blog.csdn.net/qq_34988624/article/details/86592229

https://segmentfault.com/a/1190000012220863

https://my.oschina.net/wuxinshui/blog/1511484

https://blog.csdn.net/hukailee/article/details/81107412