你真的以為你了解Java的序列化了嗎?
上一篇文章《Java對(duì)象的序列化與反序列化》中,簡(jiǎn)單介紹了Java中對(duì)象的序列化和反序列化的一些基礎(chǔ)知識(shí)。看文那篇文章后,有小伙伴留言說:我終于了解了Java的序列化了。我只想說:小伙子,你真的是圖樣圖森破啊 。
通過那篇文章,讀者可以學(xué)會(huì)如何對(duì)Java對(duì)象進(jìn)行序列化和反序列化。但是,還有些原理性知識(shí)沒有深入講解。本文,在上一篇文章的基礎(chǔ)上,抽絲剝繭,深入底層原理,主要圍繞以下幾個(gè)問題展開:
- 怎么實(shí)現(xiàn)Java的序列化?
- 為什么實(shí)現(xiàn)了java.io.Serializable接口才能被序列化?
- transient的作用是什么?
- 如果在序列化中破壞transitent的限制?
- 怎么自定義序列化策略?
- 自定義的序列化策略是如何被調(diào)用的?
- ArrayList對(duì)序列化的實(shí)現(xiàn)有哪些好處?
序列化基礎(chǔ)知識(shí)
關(guān)于序列化的用法及基礎(chǔ)知識(shí),由于不是本文重點(diǎn),這里不再詳細(xì)介紹了,詳情請(qǐng)參閱Java對(duì)象的序列化與反序列化。這里只做簡(jiǎn)單回顧。
1、在Java中,只要一個(gè)類實(shí)現(xiàn)了java.io.Serializable接口,那么它就可以被序列化。
2、通過ObjectOutputStream和ObjectInputStream對(duì)對(duì)象進(jìn)行序列化及反序列化。
3、虛擬機(jī)是否允許反序列化,不僅取決于類路徑和功能代碼是否一致,一個(gè)非常重要的一點(diǎn)是兩個(gè)類的序列化 ID 是否一致(就是 private static final long serialVersionUID)
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ù)安全。
ArrayList的序列化
為了深入的介紹序列化,我們這篇文章準(zhǔn)備從Java源碼中的ArrayList類入手。看看Java自身是如何使用序列化的。在介紹ArrayList序列化之前,先來考慮一個(gè)問題:
“問:如何自定義的序列化和反序列化策略?”
帶著這個(gè)問題,我們來看java.util.ArrayList的源碼
code 1
- 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)樨?fù)責(zé)保存元素的elementData是transient的,所以我們認(rèn)為這個(gè)成員變量的內(nèi)容不會(huì)被序列化而保留下來。我們寫一個(gè)Demo,驗(yàn)證一下我們的想法:
code 2
- 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底層是通過數(shù)組實(shí)現(xiàn)的。那么數(shù)組elementData其實(shí)就是用來保存列表中的元素的。通過該屬性的聲明方式,我們認(rèn)為,他應(yīng)該是無法通過序列化持久化下來的。
“問:為什么code 2的結(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ù)值。我們發(fā)現(xiàn)ArrayList中有這兩個(gè)方法的實(shí)現(xiàn),那么基本可以確定,elementData能被序列化持久下來,肯定和這兩個(gè)方法有關(guān),雖然他被聲明為transitent,那么我們來看一下ArrayList類中這兩個(gè)方法的具體實(shí)現(xiàn):
code 3
- 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 4
- 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();
- }
- }
通過上面兩段代碼,我們發(fā)現(xiàn),raedObject方法和writeObjec方法中定義了關(guān)于elementData的序列化策略。現(xiàn)在,我們可以回答剛剛的問題了。
“問:為什么code 2的結(jié)果卻通過序列化和反序列化把List中的元素保留下來了呢?
答:ArrayList中定義了raedObject和writeObject方法,這兩個(gè)方法中定義了elementData的序列化及反序列化策略。”
那么,問題又來了。
“問:為什么ArrayList要用這種方式來實(shí)現(xiàn)序列化呢?”
why transient
ArrayList實(shí)際上是動(dòng)態(tài)數(shù)組,每次在放滿以后自動(dòng)增長(zhǎng)設(shè)定的長(zhǎng)度值,如果數(shù)組自動(dòng)增長(zhǎng)長(zhǎ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ù)組中。
至此,我們先試著來回答剛剛提出的問題:
“問:為什么ArrayList要用這種方式來實(shí)現(xiàn)序列化呢?
答:避免elementData數(shù)組中過多的無用的null被序列化。
問:如何自定義的序列化和反序列化策略?
答:可以通過在被序列化的類中增加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();是關(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)用。”
至此,我們已經(jīng)介紹完了ArrayList的序列化方式。那么,不知道有沒有人提出這樣的疑問:
“問:Serializable明明就是一個(gè)空的接口,它是怎么保證只有實(shí)現(xiàn)了該接口的方法才能進(jìn)行序列化與反序列化的呢?”
Serializable接口的定義:
- public interface Serializable {
- }
如果嘗試對(duì)一個(gè)未實(shí)現(xiàn)Serializable接口的類進(jìn)行序列化,會(huì)拋出java.io.NotSerializableException。這是為什么呢?Serializable只是一個(gè)空接口,如何實(shí)現(xiàn)的呢?
其實(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。
“問:Serializable明明就是一個(gè)空的接口,它是怎么保證只有實(shí)現(xiàn)了該接口的方法才能進(jìn)行序列化與反序列化的呢?
答:在類的序列化過程中,會(huì)使用instanceof關(guān)鍵字判斷一個(gè)類是否繼承了Serializable類,如果沒有,則直接拋出NotSerializableException異常。”
總結(jié)
1、如果一個(gè)類想被序列化,需要實(shí)現(xiàn)Serializable接口。否則將拋出NotSerializableException異常,這是因?yàn)椋谛蛄谢僮鬟^程中會(huì)對(duì)類型進(jìn)行檢查,要求被序列化的類必須屬于Enum、Array和Serializable類型其中的任何一種。
2、在變量聲明前加上該關(guān)鍵字,可以阻止該變量被序列化到文件中。
3、在類中增加writeObject 和 readObject 方法可以實(shí)現(xiàn)自定義序列化策略。
【本文是51CTO專欄作者Hollis的原創(chuàng)文章,作者微信公眾號(hào)Hollis(ID:hollischuang)】