【Java基本功】深入淺出Java中的序列化與反序列化

2019 年 10 月 7 日
筆記

本文介紹了Java序列化的基本概念，序列化和反序列化的使用方法，以及實現原理等，比較全面地總結序列化相關知識點，並且使用具體例子來加以佐證。

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

序列化與反序列化概念

序列化 (Serialization)是將對象的狀態資訊轉換為可以存儲或傳輸的形式的過程。一般將一個對象存儲至一個儲存媒介，例如檔案或是記億體緩衝等。在網路傳輸過程中，可以是位元組或是XML等格式。而位元組的或XML編碼格式可以還原完全相等的對象。這個相反的過程又稱為反序列化。

Java對象的序列化與反序列化

在Java中，我們可以通過多種方式來創建對象，並且只要對象沒有被回收我們都可以復用該對象。但是，我們創建出來的這些Java對象都是存在於JVM的堆記憶體中的。

只有JVM處於運行狀態的時候，這些對象才可能存在。一旦JVM停止運行，這些對象的狀態也就隨之而丟失了。

但是在真實的應用場景中，我們需要將這些對象持久化下來，並且能夠在需要的時候把對象重新讀取出來。Java的對象序列化可以幫助我們實現該功能。

對象序列化機制（object serialization）是Java語言內建的一種對象持久化方式，通過對象序列化，可以把對象的狀態保存為位元組數組，並且可以在有需要的時候將這個位元組數組通過反序列化的方式再轉換成對象。

對象序列化可以很容易的在JVM中的活動對象和位元組數組（流）之間進行轉換。

在Java中，對象的序列化與反序列化被廣泛應用到RMI(遠程方法調用)及網路傳輸中。

相關介面及類

Java為了方便開發人員將Java對象進行序列化及反序列化提供了一套方便的API來支援。其中包括以下介面和類：

java.io.Serializable    java.io.Externalizable    ObjectOutput    ObjectInput    ObjectOutputStream    ObjectInputStream    Serializable 介面

類通過實現 java.io.Serializable 介面以啟用其序列化功能。

未實現此介面的類將無法使其任何狀態序列化或反序列化。可序列化類的所有子類型本身都是可序列化的。序列化介面沒有方法或欄位，僅用於標識可序列化的語義。 (該介面並沒有方法和欄位，為什麼只有實現了該介面的類的對象才能被序列化呢？)

當試圖對一個對象進行序列化的時候，如果遇到不支援 Serializable 介面的對象。在此情況下，將拋出NotSerializableException。

如果要序列化的類有父類，要想同時將在父類中定義過的變數持久化下來，那麼父類也應該集成java.io.Serializable介面。

下面是一個實現了java.io.Serializable介面的類

public class 序列化和反序列化 {          public static void main(String[] args) {        }      //注意，內部類不能進行序列化，因為它依賴於外部類      @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);              //列印結果和序列化之前相同          } catch (IOException e) {              e.printStackTrace();          } catch (ClassNotFoundException e) {              e.printStackTrace();          }      }  }    class A implements Serializable {        int i;      String s;  }

Externalizable介面

除了Serializable 之外，java中還提供了另一個序列化介面Externalizable

為了了解Externalizable介面和Serializable介面的區別，先來看程式碼，我們把上面的程式碼改成使用Externalizable的形式。

class B implements Externalizable {      //必須要有公開無參構造函數。否則報錯      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);          //列印結果為0和null，即初始值，沒有被賦值          //0          //null      }

通過上面的實例可以發現，對B類進行序列化及反序列化之後得到的對象的所有屬性的值都變成了默認值。也就是說，之前的那個對象的狀態並沒有被持久化下來。這就是Externalizable介面和Serializable介面的區別：

Externalizable繼承了Serializable，該介面中定義了兩個抽象方法：writeExternal()與readExternal()。

當使用Externalizable介面來進行序列化與反序列化的時候需要開發人員重寫writeExternal()與readExternal()方法。由於上面的程式碼中，並沒有在這兩個方法中定義序列化實現細節，所以輸出的內容為空。

還有一點值得注意：在使用Externalizable進行序列化的時候，在讀取對象時，會調用被序列化類的無參構造器去創建一個新的對象，然後再將被保存對象的欄位的值分別填充到新對象中。所以，實現Externalizable介面的類必須要提供一個public的無參的構造器。

class C implements Externalizable {      int i;      int j;      String s;      public C() {        }      //實現下面兩個方法可以選擇序列化中需要被複制的成員。      //並且，寫入順序和讀取順序要一致，否則報錯。      //可以寫入多個同類型變數，順序保持一致即可。      @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);          //列印結果為0和null，即初始值，沒有被賦值          //0          //null      }

序列化ID

序列化 ID 問題情境：兩個客戶端 A 和 B 試圖通過網路傳遞對象數據，A 端將對象 C 序列化為二進位數據再傳給 B，B 反序列化得到 C。

問題：C 對象的全類路徑假設為 com.inout.Test，在 A 和 B 端都有這麼一個類文件，功能程式碼完全一致。也都實現了 Serializable 介面，但是反序列化時總是提示不成功。

解決：虛擬機是否允許反序列化，不僅取決於類路徑和功能程式碼是否一致，一個非常重要的一點是兩個類的序列化 ID 是否一致（就是 private static final long serialVersionUID = 1L）。清單 1 中，雖然兩個類的功能程式碼完全一致，但是序列化 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;      }  }

靜態變數不參與序列化

清單 2 中的 main 方法，將對象序列化後，修改靜態變數的數值，再將序列化對象讀取出來，然後通過讀取出來的對象獲得靜態變數的數值並列印出來。依照清單 2，這個 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 {              //初始時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，對於無法理解的讀者認為，列印的 staticVar 是從讀取的對象里獲得的，應該是保存時的狀態才對。之所以列印 10 的原因在於序列化時，並不保存靜態變數，這其實比較容易理解，序列化保存的是對象的狀態，靜態變數屬於類的狀態，因此序列化並不保存靜態變數。

探究ArrayList的序列化

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

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

帶著這個問題，我們來看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實現了java.io.Serializable介面，那麼我們就可以對它進行序列化及反序列化。

因為elementData是transient的（1.8好像改掉了這一點)，所以我們認為這個成員變數不會被序列化而保留下來。我們寫一個Demo，驗證一下我們的想法：

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底層是通過數組實現的。那麼數組elementData其實就是用來保存列表中的元素的。通過該屬性的聲明方式我們知道，他是無法通過序列化持久化下來的。那麼為什麼code 4的結果卻通過序列化和反序列化把List中的元素保留下來了呢？

writeObject和readObject方法

在ArrayList中定義了來個方法： writeObject和readObject。

這裡先給出結論:

在序列化過程中，如果被序列化的類中定義了writeObject 和 readObject 方法，虛擬機會試圖調用對象類里的 writeObject 和 readObject 方法，進行用戶自定義的序列化和反序列化。如果沒有這樣的方法，則默認調用是 ObjectOutputStream 的 defaultWriteObject 方法以及 ObjectInputStream 的 defaultReadObject 方法。用戶自定義的 writeObject 和 readObject 方法可以允許用戶控制序列化的過程，比如可以在序列化的過程中動態改變序列化的數值。

來看一下這兩個方法的具體實現：

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要用這種方式來實現序列化呢？

why transient  ArrayList實際上是動態數組，每次在放滿以後自動增長設定的長度值，如果數組自動增長長度設為100，而實際只放了一個元素，那就會序列化99個null元素。為了保證在序列化的時候不會將這麼多null同時進行序列化，ArrayList把元素數組設置為transient。    why writeObject and readObject  前面說過，為了防止一個包含大量空對象的數組被序列化，為了優化存儲，所以，ArrayList使用transient來聲明elementData。 但是，作為一個集合，在序列化過程中還必須保證其中的元素可以被持久化下來，所以，通過重寫writeObject 和 readObject方法的方式把其中的元素保留下來。    writeObject方法把elementData數組中的元素遍歷的保存到輸出流（ObjectOutputStream）中。    readObject方法從輸入流（ObjectInputStream）中讀出對象並保存賦值到elementData數組中。

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

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

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

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

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

雖然ArrayList中寫了writeObject 和 readObject 方法，但是這兩個方法並沒有顯示的被調用啊。那麼如果一個類中包含writeObject 和 readObject 方法，那麼這兩個方法是怎麼被調用的呢?

ObjectOutputStream 從code 4中，我們可以看出，對象的序列化過程通過ObjectOutputStream和ObjectInputputStream來實現的，那麼帶著剛剛的問題，我們來分析一下ArrayList中的writeObject 和 readObject 方法到底是如何被調用的呢？

為了節省篇幅，這裡給出ObjectOutputStream的writeObject的調用棧：

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 });是關鍵，通過反射的方式調用writeObjectMethod方法。官方是這麼解釋這個writeObjectMethod的：

class-defined writeObject method, or null if none

在我們的例子中，這個方法就是我們在ArrayList中定義的writeObject方法。通過反射的方式被調用了。

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

如果一個類中包含writeObject 和 readObject 方法，那麼這兩個方法是怎麼被調用的?    答：在使用ObjectOutputStream的writeObject方法和ObjectInputStream的readObject方法時，會通過反射的方式調用。

為什麼要實現Serializable

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

Serializable明明就是一個空的介面，它是怎麼保證只有實現了該介面的方法才能進行序列化與反序列化的呢？

Serializable介面的定義：    public interface Serializable {  }  讀者可以嘗試把code 1中的繼承Serializable的程式碼去掉，再執行code 2，會拋出java.io.NotSerializableException。

其實這個問題也很好回答，我們再回到剛剛ObjectOutputStream的writeObject的調用棧：

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

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

序列化知識點總結

1、如果一個類想被序列化，需要實現Serializable介面。否則將拋出NotSerializableException異常，這是因為，在序列化操作過程中會對類型進行檢查，要求被序列化的類必須屬於Enum、Array和Serializable類型其中的任何一種。 2、通過ObjectOutputStream和ObjectInputStream對對象進行序列化及反序列化 3、虛擬機是否允許反序列化，不僅取決於類路徑和功能程式碼是否一致，一個非常重要的一點是兩個類的序列化 ID 是否一致（就是 private static final long serialVersionUID）序列化 ID 在 Eclipse 下提供了兩種生成策略，一個是固定的 1L，一個是隨機生成一個不重複的 long 類型數據（實際上是使用 JDK 工具生成），在這裡有一個建議，如果沒有特殊需求，就是用默認的 1L 就可以，這樣可以確保程式碼一致時反序列化成功。那麼隨機生成的序列化 ID 有什麼作用呢，有些時候，通過改變序列化 ID 可以用來限制某些用戶的使用。 4、序列化並不保存靜態變數。 5、要想將父類對象也序列化，就需要讓父類也實現Serializable 介面。 6、Transient 關鍵字的作用是控制變數的序列化，在變數聲明前加上該關鍵字，可以阻止該變數被序列化到文件中，在被反序列化後，transient 變數的值被設為初始值，如 int 型的是 0，對象型的是 null。 7、伺服器端給客戶端發送序列化對象數據，對象中有一些數據是敏感的，比如密碼字元串等，希望對該密碼欄位在序列化時，進行加密，而客戶端如果擁有解密的密鑰，只有在客戶端進行反序列化時，才可以對密碼進行讀取，這樣可以一定程度保證序列化對象的數據安全。 8、在類中增加writeObject 和 readObject 方法可以實現自定義序列化策略