序列化是一種對象持久化的手段。普遍應用在網絡傳輸、RMI等場景中。本文通過分析ArrayList的序列化來介紹Java序列化的相關內容。主要涉及到以下幾個問題:
怎么實現Java的序列化
為什么實現了java.io.Serializable接口才能被序列化
transient的作用是什么
怎么自定義序列化策略
自定義的序列化策略是如何被調用的
ArrayList對序列化的實現有什么好處
Java對象的序列化
Java平台允許我們在內存中創建可復用的Java對象,但一般情況下,只有當JVM處於運行時,這些對象才可能存在,即,這些對象的生命周期不會比JVM的生命周期更長。但在現實應用中,就可能要求在JVM停止運行之后能夠保存(持久化)指定的對象,並在將來重新讀取被保存的對象。Java對象序列化就能夠幫助我們實現該功能。
使用Java對象序列化,在保存對象時,會把其狀態保存為一組字節,在未來,再將這些字節組裝成對象。必須注意地是,對象序列化保存的是對象的”狀態”,即它的成員變量。由此可知,對象序列化不會關注類中的靜態變量。
除了在持久化對象時會用到對象序列化之外,當使用RMI(遠程方法調用),或在網絡中傳遞對象時,都會用到對象序列化。Java序列化API為處理對象序列化提供了一個標准機制,該API簡單易用。
如何對Java對象進行序列化與反序列化
在Java中,只要一個類實現了java.io.Serializable
接口,那么它就可以被序列化。這里先來一段代碼:
code 1 創建一個User類,用於序列化及反序列化
1 package com.chenHao; 2 import java.io.Serializable; 3 import java.util.Date; 4 5 /** 6 * Created by chenHao on 19/2/19. 7 */ 8 public class User implements Serializable{ 9 private String name; 10 private int age; 11 private Date birthday; 12 private transient String gender; 13 private static final long serialVersionUID = -6849794470754667710L; 14 15 public String getName() { 16 return name; 17 } 18 19 public void setName(String name) { 20 this.name = name; 21 } 22 23 public int getAge() { 24 return age; 25 } 26 27 public void setAge(int age) { 28 this.age = age; 29 } 30 31 public Date getBirthday() { 32 return birthday; 33 } 34 35 public void setBirthday(Date birthday) { 36 this.birthday = birthday; 37 } 38 39 public String getGender() { 40 return gender; 41 } 42 43 public void setGender(String gender) { 44 this.gender = gender; 45 } 46 47 @Override 48 public String toString() { 49 return "User{" + 50 "name='" + name + '\'' + 51 ", age=" + age + 52 ", gender=" + gender + 53 ", birthday=" + birthday + 54 '}'; 55 } 56 }
code 2 對User進行序列化及反序列化的Demo
package com.chenHao; import org.apache.commons.io.FileUtils; import org.apache.commons.io.IOUtils; import java.io.*; import java.util.Date; /** * Created by chenHao on 19/2/19. */ public class SerializableDemo { public static void main(String[] args) { //Initializes The Object User user = new User(); user.setName("chenHao"); user.setGender("male"); user.setAge(23); user.setBirthday(new Date()); System.out.println(user); //Write Obj to File ObjectOutputStream oos = null; try { oos = new ObjectOutputStream(new FileOutputStream("tempFile")); oos.writeObject(user); } catch (IOException e) { e.printStackTrace(); } finally { IOUtils.closeQuietly(oos); } //Read Obj from File File file = new File("tempFile"); ObjectInputStream ois = null; try { ois = new ObjectInputStream(new FileInputStream(file)); User newUser = (User) ois.readObject(); System.out.println(newUser); } catch (IOException e) { e.printStackTrace(); } catch (ClassNotFoundException e) { e.printStackTrace(); } finally { IOUtils.closeQuietly(ois); try { FileUtils.forceDelete(file); } catch (IOException e) { e.printStackTrace(); } } } } //output //User{name='chenHao', age=23, gender=male, birthday=Tue Feb 19 17:37:38 CST 2019} //User{name='chenHao', age=23, gender=null, birthday=Tue Feb 19 17:37:38 CST 2019}
序列化及反序列化相關知識
1、在Java中,只要一個類實現了java.io.Serializable
接口,那么它就可以被序列化。
2、通過ObjectOutputStream
和ObjectInputStream
對對象進行序列化及反序列化
3、虛擬機是否允許反序列化,不僅取決於類路徑和功能代碼是否一致,一個非常重要的一點是兩個類的序列化 ID 是否一致(就是 private static final long serialVersionUID
)
4、序列化並不保存靜態變量。
5、要想將父類對象也序列化,就需要讓父類也實現Serializable
接口。
6、Transient 關鍵字的作用是控制變量的序列化,在變量聲明前加上該關鍵字,可以阻止該變量被序列化到文件中,在被反序列化后,transient 變量的值被設為初始值,如 int 型的是 0,對象型的是 null。
7、服務器端給客戶端發送序列化對象數據,對象中有一些數據是敏感的,比如密碼字符串等,希望對該密碼字段在序列化時,進行加密,而客戶端如果擁有解密的密鑰,只有在客戶端進行反序列化時,才可以對密碼進行讀取,這樣可以一定程度保證序列化對象的數據安全。
ArrayList的序列化
在介紹ArrayList序列化之前,先來考慮一個問題:
如何自定義的序列化和反序列化策略
帶着這個問題,我們來看java.util.ArrayList
的源碼
code 3
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
的,所以我們認為這個成員變量不會被序列化而保留下來。我們寫一個Demo,驗證一下我們的想法:
code 4
public static void main(String[] args) throws IOException, ClassNotFoundException { List<String> stringList = new ArrayList<String>(); stringList.add("hello"); stringList.add("world"); stringList.add("hollis"); stringList.add("chuang"); System.out.println("init StringList" + stringList); ObjectOutputStream objectOutputStream = new ObjectOutputStream(new FileOutputStream("stringlist")); objectOutputStream.writeObject(stringList); IOUtils.close(objectOutputStream); File file = new File("stringlist"); ObjectInputStream objectInputStream = new ObjectInputStream(new FileInputStream(file)); List<String> newStringList = (List<String>)objectInputStream.readObject(); IOUtils.close(objectInputStream); if(file.exists()){ file.delete(); } System.out.println("new StringList" + newStringList); } //init StringList[hello, world, hollis, chuang] //new StringList[hello, world, hollis, chuang]
了解ArrayList的人都知道,ArrayList底層是通過數組實現的。那么數組elementData
其實就是用來保存列表中的元素的。通過該屬性的聲明方式我們知道,他是無法通過序列化持久化下來的。那么為什么code 4的結果卻通過序列化和反序列化把List中的元素保留下來了呢?
writeObject和readObject方法
在ArrayList中定義了來個方法: writeObject
和readObject
。
這里先給出結論:
在序列化過程中,如果被序列化的類中定義了writeObject 和 readObject 方法,虛擬機會試圖調用對象類里的 writeObject 和 readObject 方法,進行用戶自定義的序列化和反序列化。
如果沒有這樣的方法,則默認調用是 ObjectOutputStream 的 defaultWriteObject 方法以及 ObjectInputStream 的 defaultReadObject 方法。
用戶自定義的 writeObject 和 readObject 方法可以允許用戶控制序列化的過程,比如可以在序列化的過程中動態改變序列化的數值。
來看一下這兩個方法的具體實現:
code 5
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(); } } }
code 6
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
數組中。
至此,我們先試着來回答剛剛提出的問題:
如何自定義的序列化和反序列化策略
答:可以通過在被序列化的類中增加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方法時,會通過反射的方式調用。
至此,我們已經介紹完了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、在變量聲明前加上該關鍵字,可以阻止該變量被序列化到文件中。
3、在類中增加writeObject 和 readObject 方法可以實現自定義序列化策略