ITEM 87: CONSIDER USING A CUSTOM SERIALIZED FORM
??當(dāng)您在時(shí)間壓力下編寫(xiě)類時(shí)，通常應(yīng)該將精力集中在設(shè)計(jì)最佳API上蝇摸。有時(shí)，這意味著發(fā)布一個(gè)“一次性”實(shí)現(xiàn)，您知道它將在未來(lái)的版本中被替換眉反。通常這不是問(wèn)題昙啄，但是如果類實(shí)現(xiàn)Serializable 并使用默認(rèn)的序列化形式，您將永遠(yuǎn)無(wú)法完全擺脫一次性實(shí)現(xiàn)寸五。它將永遠(yuǎn)指定序列化的表單梳凛。這不僅僅是一個(gè)理論問(wèn)題。這種情況發(fā)生在 Java 庫(kù)中的幾個(gè)類上梳杏，包括BigInteger韧拒。
??不考慮默認(rèn)的序列化表單是否合適，就不要接受它十性。從靈活性叛溢、性能和正確性的角度來(lái)看，接受默認(rèn)的序列化形式應(yīng)該是一種明智的決定劲适。一般來(lái)說(shuō)楷掉，只有當(dāng)默認(rèn)的序列化表單與設(shè)計(jì)自定義序列化表單時(shí)所選擇的編碼基本相同時(shí)，才應(yīng)該接受默認(rèn)的序列化表單霞势。
??對(duì)象的默認(rèn)序列化形式是以對(duì)象為根的對(duì)象圖的物理表示的相當(dāng)有效的編碼烹植。換句話說(shuō)，它描述了對(duì)象中包含的數(shù)據(jù)以及從該對(duì)象可訪問(wèn)的每個(gè)對(duì)象中的數(shù)據(jù)愕贡。它還描述了所有這些對(duì)象相互連接的拓?fù)洳莸瘛＠硐氲膶?duì)象序列化形式只包含由對(duì)象表示的邏輯數(shù)據(jù)。它獨(dú)立于物理表征固以。
??如果對(duì)象的物理表示與其邏輯內(nèi)容相同墩虹，則可能使用默認(rèn)的序列化形式。例如憨琳，對(duì)于以下類來(lái)說(shuō)诫钓，默認(rèn)的序列化形式是合理的，它簡(jiǎn)單地表示一個(gè)人的名字:

// Good candidate for default serialized form
public class Name implements Serializable { 
  /**
  * Last name. Must be non-null. 
  * @serial
  */
  private final String lastName;
  /**
  * First name. Must be non-null. 
  * @serial
  */
  private final String firstName; 
  /**
  * Middle name, or null if there is none. 
  * @serial
  */
  private final String middleName;
  ... // Remainder omitted 
}

??從邏輯上講栽渴，名稱由三個(gè)字符串組成尖坤，分別表示姓、名和中間名闲擦。Name中的實(shí)例字段精確地反映了這個(gè)邏輯內(nèi)容慢味。
??即使您確定默認(rèn)的序列化形式是合適的，您通常也必須提供一個(gè) readObject 方法來(lái)確保不變量和安全性墅冷。對(duì)于 Name, readObject 方法必須確保字段 lastName 和firstName 是非空的纯路。item 88 和 item 90 詳細(xì)討論了這個(gè)問(wèn)題。
??注意寞忿，有關(guān)于 lastName驰唬、firstName 和 middleName 字段的文檔注釋，即使它們是私有的。這是因?yàn)檫@些私有字段定義了一個(gè)公共API叫编，它是類的序列化形式辖佣，并且這個(gè)公共 API 必須被記錄。@serial 標(biāo)記的存在告訴 Javadoc 將該文檔放在一個(gè)記錄序列化表單的特殊頁(yè)面上搓逾。
??與 Name 相反卷谈，考慮下面的類，它表示一個(gè)字符串列表(暫時(shí)忽略你可能最好使用一個(gè)標(biāo)準(zhǔn)列表實(shí)現(xiàn)):

// Awful candidate for default serialized form
public final class StringList implements Serializable { 
  private int size = 0;
  private Entry head = null;
  private static class Entry implements Serializable { 
    String data;
    Entry next;
    Entry previous;
  }
  ... // Remainder omitted 
}

??從邏輯上講霞篡，這個(gè)類表示一個(gè)字符串序列世蔗。在物理上，它將序列表示為雙鏈表朗兵。如果您接受默認(rèn)的序列化表單污淋，那么序列化表單將在兩個(gè)方向上辛苦地鏡像鏈表中的每個(gè)條目以及條目之間的所有鏈接。
??當(dāng)對(duì)象的物理表示形式與其邏輯數(shù)據(jù)內(nèi)容有本質(zhì)區(qū)別時(shí)余掖，使用默認(rèn)的序列化形式有四個(gè)缺點(diǎn):
? 它將導(dǎo)出的API永久地綁定到當(dāng)前的內(nèi)部表示寸爆。在上面的例子中，是私有的StringList浊吏。入口類成為公共 API 的一部分而昨。如果表示法在將來(lái)的版本中發(fā)生了更改救氯，StringList 類仍然需要在輸入時(shí)接受鏈表表示法找田，并在輸出時(shí)生成它。類永遠(yuǎn)不會(huì)擺脫所有處理鏈表?xiàng)l目的代碼着憨，即使它不再使用它們墩衙。
? 它會(huì)占用過(guò)多的空間。在上面的示例中甲抖，序列化的表單不必要地表示鏈表中的每個(gè)條目和所有鏈接漆改。這些條目和鏈接只是實(shí)現(xiàn)細(xì)節(jié)，不值得包含在序列化的形式中准谚。由于序列化的表單過(guò)于龐大挫剑，將其寫(xiě)入磁盤(pán)或通過(guò)網(wǎng)絡(luò)發(fā)送將會(huì)非常緩慢。
? 它會(huì)消耗過(guò)多的時(shí)間柱衔。序列化邏輯不了解對(duì)象圖的拓?fù)浣Y(jié)構(gòu)樊破，因此它必須經(jīng)歷一次代價(jià)高昂的圖遍歷。在上面的示例中唆铐，只要考慮 next 引用就足夠了哲戚。
? 它會(huì)導(dǎo)致堆棧溢出。默認(rèn)的序列化過(guò)程對(duì)對(duì)象圖執(zhí)行遞歸遍歷艾岂，這可能導(dǎo)致堆棧溢出顺少，即使對(duì)于中等大小的對(duì)象圖也是如此。序列化包含 1,000-1,800 個(gè)元素的StringList 實(shí)例會(huì)在我的機(jī)器上生成 StackOverflowError。令人驚訝的是脆炎，串行化導(dǎo)致堆棧溢出的最小列表大小(在我的機(jī)器上)因運(yùn)行而異梅猿。顯示這個(gè)問(wèn)題的最小列表大小可能取決于平臺(tái)實(shí)現(xiàn)和命令行標(biāo)志;有些實(shí)現(xiàn)可能根本沒(méi)有這個(gè)問(wèn)題。
??合理的 StringList 序列化形式是列表中的字符串?dāng)?shù)量秒裕，后面跟著字符串本身粒没。這構(gòu)成了由 StringList 表示的邏輯數(shù)據(jù)，去掉了其物理表示的細(xì)節(jié)簇爆。下面是修改后的StringList癞松，帶有 writeobject 和 readObject 方法，它們實(shí)現(xiàn)了這個(gè)序列化的表單入蛆。提醒一下响蓉，transient 修飾符表示一個(gè)實(shí)例字段將從類的默認(rèn)序列化形式中被省略:

// StringList with a reasonable custom serialized form
public final class StringList implements Serializable { 
  private transient int size = 0;
  private transient Entry head = null;
  // No longer Serializable!
  private static class Entry { 
    String data;
    Entry next;
    Entry previous;
  }
  // Appends the specified string to the list 
  public final void add(String s) { ... }
  /**
  * Serialize this {@code StringList} instance. *
  * @serialData The size of the list (the number of strings
  * it contains) is emitted ({@code int}), followed by all of
  * its elements (each a {@code String}), in the proper
  * sequence. */
  private void writeObject(ObjectOutputStream s) throws IOException {
    s.defaultWriteObject(); 
    s.writeInt(size);
    // Write out all elements in the proper order.
    for (Entry e = head; e != null; e = e.next) 
      s.writeObject(e.data);
  }
  private void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException {
    s.defaultReadObject();
    int numElements = s.readInt();
    // Read in all elements and insert them in list 
    for (int i = 0; i < numElements; i++)
      add((String) s.readObject()); 
  }
    ... // Remainder omitted 
}

??writeObject 做的第一件事是調(diào)用 defaultWriteObject, readObject 做的第一件事是調(diào)用 defaultReadObject，盡管所有 StringList 的字段都是瞬時(shí)的哨毁。您可能聽(tīng)說(shuō)過(guò)枫甲，如果一個(gè)類的所有實(shí)例字段都是瞬態(tài)的，那么您可以不必調(diào)用 defaultWriteObject 和defaultReadObject扼褪，但是序列化規(guī)范要求您無(wú)論如何都要調(diào)用它們想幻。這些調(diào)用的存在使得在以后的版本中添加非瞬態(tài)實(shí)例字段成為可能，同時(shí)保持向后和向前的兼容性话浇。如果實(shí)例在以后的版本中序列化脏毯，在以前的版本中反序列化，添加的字段將被忽略幔崖。如果早期版本的 readObject 方法未能調(diào)用 defaultReadObject食店，反序列化將失敗，并出現(xiàn) StreamCorruptedException.
??請(qǐng)注意赏寇，writeObject 方法有一個(gè)文檔注釋吉嫩，盡管它是私有的。這類似于對(duì) Name 類中的私有字段的文檔注釋嗅定。這個(gè)私有方法定義了一個(gè)公共 API自娩，它是序列化的形式，并且這個(gè)公共API應(yīng)該被記錄下來(lái)渠退。與字段的 @serial 標(biāo)記一樣忙迁，方法的 @serialData 標(biāo)記告訴 Javadoc 實(shí)用程序?qū)⒃撐臋n放在序列化的表單頁(yè)面上。
??為了給前面的性能討論增加一些伸縮性智什，如果字符串的平均長(zhǎng)度是 10 個(gè)字符动漾，那么修改后的 StringList 序列化形式所占的空間大約是原始序列化形式的一半。在我的機(jī)器上荠锭，序列化修改后的 StringList 版本的速度是序列化原始版本(列表長(zhǎng)度為10)的兩倍多旱眯。最后，修改后的格式不存在堆棧溢出問(wèn)題，因此可以序列化的 StringList 的大小實(shí)際上沒(méi)有上限删豺。
??雖然默認(rèn)的序列化形式對(duì) StringList 不好共虑，但對(duì)于某些類來(lái)說(shuō)，它可能更糟呀页。對(duì)于StringList妈拌，默認(rèn)的序列化形式是不靈活的，性能也很差蓬蝶，但是它是正確的尘分，因?yàn)樾蛄谢头葱蛄谢粋€(gè) StringList 實(shí)例會(huì)產(chǎn)生一個(gè)原始對(duì)象的忠實(shí)副本，并且它的所有不變量都保持不變丸氛。不變量綁定到特定于實(shí)現(xiàn)的細(xì)節(jié)的任何對(duì)象都不是這樣培愁。
??例如，考慮哈希表的情況缓窜。物理表示是包含鍵-值項(xiàng)的散列桶序列定续。條目所在的bucket 是其鍵的哈希碼的函數(shù)，通常不能保證在各個(gè)實(shí)現(xiàn)中都是相同的禾锤。事實(shí)上私股，它甚至不能保證每次運(yùn)行都是相同的。因此恩掷，接受哈希表的默認(rèn)序列化形式會(huì)造成嚴(yán)重的錯(cuò)誤倡鲸。對(duì)哈希表進(jìn)行序列化和反序列化會(huì)產(chǎn)生一個(gè)不變量嚴(yán)重?fù)p壞的對(duì)象。
??無(wú)論您是否接受默認(rèn)的序列化表單螃成，當(dāng)調(diào)用 defaultWriteObject 方法時(shí)旦签，每個(gè)沒(méi)有標(biāo)記為 transient 的實(shí)例字段都將被序列化。因此寸宏，每個(gè)可以聲明為 transient 的實(shí)例字段都應(yīng)該是。這包括派生字段偿曙，它們的值可以從主要數(shù)據(jù)字段計(jì)算氮凝，比如緩存的哈希值。它還包括一些字段望忆，這些字段的值綁定到 JVM 的一個(gè)特定運(yùn)行罩阵，例如表示本地?cái)?shù)據(jù)結(jié)構(gòu)指針的長(zhǎng)字段。在決定使字段非瞬態(tài)之前启摄，請(qǐng)確信它的值是對(duì)象邏輯狀態(tài)的一部分稿壁。如果使用自定義序列化表單，那么大多數(shù)或所有實(shí)例字段都應(yīng)該標(biāo)記為transient歉备，如上面的 StringList 示例所示傅是。
??如果您使用默認(rèn)的序列化形式，并且已經(jīng)將一個(gè)或多個(gè)字段標(biāo)記為 transient，請(qǐng)記住喧笔，當(dāng)實(shí)例被反序列化時(shí)帽驯，這些字段將被初始化為默認(rèn)值:對(duì)象引用字段為 null，數(shù)值基元字段為零书闸，布爾字段為false [JLS, 4.12.5]尼变。如果這些值對(duì)于任何臨時(shí)字段都是不可接受的，那么必須提供一個(gè) readObjectmethod 來(lái)調(diào)用 defaultReadObject 方法浆劲，然后將臨時(shí)字段恢復(fù)為可接受的值(item 88)嫌术。或者牌借，這些字段可以在第一次使用時(shí)惰性地初始化(item 83)蛉威。
??無(wú)論是否使用默認(rèn)的序列化形式，都必須在對(duì)象序列化上強(qiáng)加任何同步走哺，而這種同步可能會(huì)強(qiáng)加在讀取對(duì)象的整個(gè)狀態(tài)的任何其他方法上蚯嫌。例如，如果你有一個(gè)線程安全的對(duì)象(item 82)丙躏，它通過(guò)同步每個(gè)方法來(lái)實(shí)現(xiàn)線程安全择示，你選擇使用默認(rèn)的序列化形式，使用下面的 write-Object 方法:

// writeObject for synchronized class with default serialized form
private synchronized 
void writeObject(ObjectOutputStream s) throws IOException { 
  s.defaultWriteObject(); 
}

??如果您將同步放到 writeObject 方法中晒旅，您必須確保它與其他活動(dòng)遵循相同的鎖順序約束栅盲，否則您將面臨資源順序死鎖的風(fēng)險(xiǎn)[Goetz06, 10.1.5]。
??無(wú)論選擇哪種序列化形式废恋，都要在編寫(xiě)的每個(gè)可序列化類中聲明一個(gè)顯式的串行版本UID谈秫。這消除了串行版本 UID 作為不兼容性的潛在來(lái)源(item 86)。還有一個(gè)小小的性能好處鱼鼓。如果沒(méi)有提供串行版本 UID拟烫，則在運(yùn)行時(shí)執(zhí)行昂貴的計(jì)算來(lái)生成一個(gè) UID。聲明一個(gè)串行版本的 UID 很簡(jiǎn)單迄本。只需將這一行添加到您的類:
private static final long serialVersionUID = randomLongValue;
??如果您編寫(xiě)一個(gè)新類硕淑，為 randomLongValue 選擇什么值并不重要。您可以通過(guò)在類上運(yùn)行 serialver 實(shí)用程序來(lái)生成值嘉赎，但也可以憑空選擇一個(gè)數(shù)字置媳。串行版本 uid 不需要是唯一的。如果修改缺少串行版本 UID 的現(xiàn)有類公条，并且希望新版本接受現(xiàn)有串行化實(shí)例拇囊，則必須使用為舊版本自動(dòng)生成的值。您可以通過(guò)在舊版本的類上運(yùn)行serialver 實(shí)用程序來(lái)獲得這個(gè)數(shù)字靶橱，舊版本的類即存在序列化實(shí)例的類寥袭。
??如果您希望創(chuàng)建與現(xiàn)有版本不兼容的類的新版本路捧，只需更改串行版本 UID 聲明中的值。這將導(dǎo)致試圖反序列化以前版本的序列化實(shí)例時(shí)拋出 InvalidClassException 異常纠永。不要更改串行版本 UID鬓长，除非您想破壞與一個(gè)類的所有現(xiàn)有序列化實(shí)例的兼容性。
??總而言之尝江，如果您決定一個(gè)類應(yīng)該是可序列化的(item 86)涉波，請(qǐng)認(rèn)真考慮序列化的形式應(yīng)該是什么。只有當(dāng)該默認(rèn)序列化形式是對(duì)象邏輯狀態(tài)的合理描述時(shí)炭序，才使用該默認(rèn)序列化形式;否則啤覆，設(shè)計(jì)一個(gè)適合描述對(duì)象的自定義序列化表單。您應(yīng)該分配與設(shè)計(jì)導(dǎo)出方法相同的時(shí)間來(lái)設(shè)計(jì)類的序列化形式(item 51)惭聂。就像你不能從以后的版本中刪除導(dǎo)出的方法一樣窗声，你也不能從序列化的表單中刪除字段;它們必須被永久保存，以確保序列化的兼容性辜纲。選擇錯(cuò)誤的序列化形式會(huì)對(duì)類的復(fù)雜性和性能產(chǎn)生永久性的負(fù)面影響笨觅。