オブジェクト直列化ストリーム・プロトコル

トピック:

• 概要
• ストリーム要素
• ストリーム・プロトコル・バージョン
• ストリーム形式の文法
• 例

6.1 概要

このストリーム形式は、次の設計目標を実現しました。

• 効率的な読取りを実現するためのコンパクト化および構造化。
• ストリームの構造と形式の知識だけを使ってストリーム内をスキップ可能。クラスごとにコードを呼び出す必要がない。
• データへのストリーム・アクセスだけが必要。

6.2 ストリーム要素

クラス・オブジェクトは、次の要素によって表されます。

• そのObjectStreamClassオブジェクト。

ダイナミック・プロキシ・クラス以外のClassのObjectStreamClassオブジェクトは、次の要素によって表されます。

• 互換クラスのストリーム固有識別子(SUID)。
• クラスのさまざまなプロパティを表すフラグのセット(クラスがwriteObjectメソッドを定義しているか、クラスが直列化可能、外部化可能、またはenum型か、など)。
• 直列化可能フィールドの数
• デフォルトのメカニズムによって直列化された、クラスのフィールドの配列。配列やオブジェクト・フィールドの場合、フィールドの型が文字列(Java仮想マシン仕様に指定されているフィールド記述子形式(Ljava/lang/Object;など)でなければいけない)として含まれる。
• annotateClassメソッドによって書き込まれるオプションのブロック・データ・レコードまたはオブジェクト
• スーパー・タイプのObjectStreamClass (スーパー・クラスが直列化可能でなければnull)

ダイナミック・プロキシ・クラスのObjectStreamClassオブジェクトは、次の要素によって表されます。

• ダイナミック・プロキシ・クラスが実装するインタフェース数
• ダイナミック・プロキシ・クラスが実装するすべてのインタフェースの名前。そのClassオブジェクト上でgetInterfacesメソッドを呼び出すことで返される順番にリストする。
• annotateProxyClassメソッドによって書き込まれるオプションのブロック・データ・レコードまたはオブジェクト。
• スーパー・タイプjava.lang.reflect.ProxyのObjectStreamClass。

配列は次の要素によって表されます。

• そのObjectStreamClassオブジェクト。
• 要素数。
• 値のシーケンス。値の型は配列の型で暗示されます。たとえば、byte配列の値の型はbyteです。

enum定数は次の要素によって表されます。

• 定数の基底enum型のObjectStreamClassオブジェクト。
• 定数の名前文字列。

ストリーム内の新規オブジェクトは次の要素によって表されます。

• オブジェクトのもっとも多く派生されたクラス。
• オブジェクトの各直列化可能クラスのデータ(最上位のスーパー・クラスから順に)。各クラスについて、ストリームは次のものを含みます。
  • 直列化可能フィールド。セクション1.5「クラスの直列化可能なフィールドの指定」を参照してください。
  • クラスがwriteObject/readObjectメソッドを持つ場合、writeObjectメソッドによって書き込まれたプリミティブ型のオプション・オブジェクトまたはブロック・データ・レコード、あるいはその両方と、endBlockDataがある場合があります。

クラスによって書き込まれたすべてのプリミティブ・データは、バッファリングされてブロック・データ・レコードにラップされます(データがwriteObjectメソッド内でストリームに書き込まれたか、writeObjectメソッドの外部から直接ストリームに書き込まれたのかに関係なく)。このデータは、対応するreadObjectメソッドによって読み込むか、ストリームから直接読み込むことができます。writeObjectメソッドによって書き込まれるオブジェクトは、既存のブロック・データ・レコードを終了し、必要に応じて通常のオブジェクト、null、または逆参照として書き込まれます。ブロック・データ・レコードでは、エラー回復によってオプション・データを破棄できます。クラス内から呼び出された場合には、ストリームはデータやオブジェクトをendBlockDataまで破棄できます。

6.3 ストリーム・プロトコル・バージョン

ストリーム・プロトコル・バージョンを次に示します。

• ObjectStreamConstants.PROTOCOL_VERSION_1: 初期ストリーム形式を示します。

• ObjectStreamConstants.PROTOCOL_VERSION_2: 新しい外部データ形式を示します。プリミティブ・データはブロック・データ・モードで書き込まれ、TC_ENDBLOCKDATAで終了します。

  ブロック・データ境界が標準化されました。ブロック・データ・モードで書き込まれたプリミティブ・データは、1024バイト・チャンクを超えないように正規化されます。この変更の利点は、ストリーム内の直列化データ形式の仕様を厳しくすることでした。この変更は、完全に下位および上位互換です。

JDK 1.1は、デフォルトでPROTOCOL_VERSION_1を書き込みます。

JDK 1.1.7以降は、両方のバージョンを読み取ることができます。

JDK 1.1.7より前のリリースは、PROTOCOL_VERSION_1のみを読み取れます。

6.4 ストリーム形式の文法

以下の表は、ストリーム形式の文法を示しています。非ターミナル・シンボルは、イタリックで示されます。ターミナル・シンボルは固定幅フォントで示されます。非ターミナルの定義は、その後に「:」が続きます。定義のあとには1つまたは複数の代替定義が続き、それぞれが別の行に示されます。次の表に表記法を示します。

シンボル(utf)は、2バイトの長さ情報を使用して書き込まれた文字列を示すために使用され、(long-utf)は、8バイトの長さ情報を使用して書き込まれた文字列を示すために使用されます。詳細については、セクション6.2「ストリーム要素」を参照してください。

6.4.1 文法規則

直列化されたストリームは、ストリーム規則を満たすストリームによって表されます。

stream:
  magic version contents

contents:
  content
  contents content

content:
  object
  blockdata

object:
  newObject
  newClass
  newArray
  newString
  newEnum
  newClassDesc
  prevObject
  nullReference
  exception
  TC_RESET

newClass:
  TC_CLASS classDesc newHandle

classDesc:
  newClassDesc
  nullReference
  (ClassDesc)prevObject      // an object required to be of type
                             // ClassDesc

superClassDesc:
  classDesc

newClassDesc:
  TC_CLASSDESC className serialVersionUID newHandle classDescInfo
  TC_PROXYCLASSDESC newHandle proxyClassDescInfo

classDescInfo:
  classDescFlags fields classAnnotation superClassDesc 

className:
  (utf)

serialVersionUID:
  (long)

classDescFlags:
  (byte)                  // Defined in Terminal Symbols and
                            // Constants

proxyClassDescInfo:
  (int)<count> proxyInterfaceName[count] classAnnotation
      superClassDesc

proxyInterfaceName:

  (utf)

fields:
  (short)<count>  fieldDesc[count]

fieldDesc:
  primitiveDesc
  objectDesc

primitiveDesc:
  prim_typecode fieldName

objectDesc:
  obj_typecode fieldName className1

fieldName:
  (utf)

className1:
  (String)object             // String containing the field's type,
                             // in field descriptor format

classAnnotation:
  endBlockData
  contents endBlockData      // contents written by annotateClass

prim_typecode:
  `B'       // byte
  `C'       // char
  `D'       // double
  `F'       // float
  `I'       // integer
  `J'       // long
  `S'       // short
  `Z'       // boolean

obj_typecode:
  `[`   // array
  `L'       // object

newArray:
  TC_ARRAY classDesc newHandle (int)<size> values[size]

newObject:
  TC_OBJECT classDesc newHandle classdata[]  // data for each class

classdata:
  nowrclass                 // SC_SERIALIZABLE & classDescFlag &&
                            // !(SC_WRITE_METHOD & classDescFlags)
  wrclass objectAnnotation  // SC_SERIALIZABLE & classDescFlag &&
                            // SC_WRITE_METHOD & classDescFlags
  externalContents          // SC_EXTERNALIZABLE & classDescFlag &&
                            // !(SC_BLOCKDATA  & classDescFlags
  objectAnnotation          // SC_EXTERNALIZABLE & classDescFlag&& 
                            // SC_BLOCKDATA & classDescFlags

nowrclass:
  values                    // fields in order of class descriptor

wrclass:
  nowrclass

objectAnnotation:
  endBlockData
  contents endBlockData     // contents written by writeObject
                            // or writeExternal PROTOCOL_VERSION_2.

blockdata:
  blockdatashort
  blockdatalong

blockdatashort:
  TC_BLOCKDATA (unsigned byte)<size> (byte)[size]

blockdatalong:
  TC_BLOCKDATALONG (int)<size> (byte)[size]

endBlockData   :
  TC_ENDBLOCKDATA

externalContent:          // Only parseable by readExternal
  ( bytes)                // primitive data
    object

externalContents:         // externalContent written by 
  externalContent         // writeExternal in PROTOCOL_VERSION_1.
  externalContents externalContent

newString:
  TC_STRING newHandle (utf)
  TC_LONGSTRING newHandle (long-utf)

newEnum:
  TC_ENUM classDesc newHandle enumConstantName

enumConstantName:
  (String)object

prevObject
  TC_REFERENCE (int)handle

nullReference
  TC_NULL

exception:
  TC_EXCEPTION reset (Throwable)object         reset 

magic:
  STREAM_MAGIC

version
  STREAM_VERSION

values:          // The size and types are described by the
                 // classDesc for the current object

newHandle:       // The next number in sequence is assigned
                 // to the object being serialized or deserialized

reset:           // The set of known objects is discarded
                 // so the objects of the exception do not
                 // overlap with the previously sent objects 
                 // or with objects that may be sent after 
                 // the exception

6.4.2 ターミナル・シンボルと定数

    final static short STREAM_MAGIC = (short)0xaced;
    final static short STREAM_VERSION = 5;
    final static byte TC_NULL = (byte)0x70;
    final static byte TC_REFERENCE = (byte)0x71;
    final static byte TC_CLASSDESC = (byte)0x72;
    final static byte TC_OBJECT = (byte)0x73;
    final static byte TC_STRING = (byte)0x74;
    final static byte TC_ARRAY = (byte)0x75;
    final static byte TC_CLASS = (byte)0x76;
    final static byte TC_BLOCKDATA = (byte)0x77;
    final static byte TC_ENDBLOCKDATA = (byte)0x78;
    final static byte TC_RESET = (byte)0x79;
    final static byte TC_BLOCKDATALONG = (byte)0x7A;
    final static byte TC_EXCEPTION = (byte)0x7B;
    final static byte TC_LONGSTRING = (byte) 0x7C;
    final static byte TC_PROXYCLASSDESC = (byte) 0x7D;
    final static byte TC_ENUM = (byte) 0x7E;
    final static  int   baseWireHandle = 0x7E0000;

    final static byte SC_WRITE_METHOD = 0x01; //if SC_SERIALIZABLE
     final static byte SC_BLOCK_DATA = 0x08;    //if SC_EXTERNALIZABLE
    final static byte SC_SERIALIZABLE = 0x02;
    final static byte SC_EXTERNALIZABLE = 0x04;
    final static byte SC_ENUM = 0x10;

フラグSC_BLOCKDATAは、STREAM_PROTOCOL_2を使ってExternalizableクラスがストリームに書き込まれる場合に設定されます。デフォルトでは、これがJDK 1.2でExternalizableオブジェクトをストリームに書き込むために使用されるプロトコルです。JDK 1.1は、STREAM_PROTOCOL_1を書き込みます。

フラグSC_SERIALIZABLEは、ストリームを書き込んだクラスがjava.io.Serializableを拡張したけれども、java.io.Externalizableは拡張しなかった場合に設定されます。そのストリームを読み込むクラスもjava.io.Serializableを拡張してデフォルト直列化メカニズムを使用しなければいけません。

フラグSC_EXTERNALIZABLEは、ストリームを書き込んだクラスがjava.io.Externalizableを拡張した場合に設定されます。そのデータを読み込むクラスもExternalizableを拡張する必要があり、データはそのwriteExternalおよびreadExternalメソッドを使って読み込まれます。

フラグSC_ENUMは、ストリームを書き込んだクラスがenum型だった場合に設定されます。受け取り側の対応するクラスもenum型でなければいけません。enum型の定数のデータは、セクション1.12「Enum定数の直列化」で説明するように読み書きされます。

例

class List implements java.io.Serializable {
    int value;
    List next;
    public static void main(String[] args) {
        try {
            List list1 = new List();
            List list2 = new List();
            list1.value = 17;
            list1.next = list2;
            list2.value = 19;
            list2.next = null;

            ByteArrayOutputStream o = new ByteArrayOutputStream();
            ObjectOutputStream out = new ObjectOutputStream(o);
            out.writeObject(list1);
            out.writeObject(list2);
            out.flush();
            ...
        } catch (Exception ex) {
            ex.printStackTrace();
        }
    }
}

00: ac ed 00 05 73 72 00 04 4c 69 73 74 69 c8 8a 15 >....sr..Listi...<

10: 40 16 ae 68 02 00 02 49 00 05 76 61 6c 75 65 4c >Z......I..valueL<

20: 00 04 6e 65 78 74 74 00 06 4c 4c 69 73 74 3b 78 >..nextt..LList;x<

30: 70 00 00 00 11 73 71 00 7e 00 00 00 00 00 13 70 >p....sq.~......p<

40: 71 00 7e 00 03                                  >q.~..<