オブジェクト入力クラス

トピック:

• ObjectInputStreamクラス
• ObjectInputStream.GetFieldクラス
• ObjectInputValidationインタフェース
• readObjectメソッド
• readExternalメソッド
• readResolveメソッド

3.1 ObjectInputStreamクラス

package java.io;

public class ObjectInputStream
    extends InputStream
    implements ObjectInput, ObjectStreamConstants
{
    public ObjectInputStream(InputStream in)
        throws StreamCorruptedException, IOException;

    public final Object readObject()
        throws OptionalDataException, ClassNotFoundException, 
            IOException;

    public Object readUnshared()
        throws OptionalDataException, ClassNotFoundException, 
            IOException;

    public void defaultReadObject()
        throws IOException, ClassNotFoundException,
            NotActiveException;

    public GetField readFields()
        throws IOException;

    public synchronized void registerValidation(
        ObjectInputValidation obj, int prio)
        throws NotActiveException, InvalidObjectException;

    protected ObjectStreamClass readClassDescriptor()
        throws IOException, ClassNotFoundException;

    protected Class resolveClass(ObjectStreamClass v)
        throws IOException, ClassNotFoundException;

    protected Object resolveObject(Object obj)
        throws IOException;

    protected boolean enableResolveObject(boolean enable)
        throws SecurityException;

    protected void readStreamHeader()
        throws IOException, StreamCorruptedException;

    public int read() throws IOException;

    public int read(byte[] data, int offset, int length)
        throws IOException

    public int available() throws IOException;

    public void close() throws IOException;

    public boolean readBoolean() throws IOException;

    public byte readByte() throws IOException;

    public int readUnsignedByte() throws IOException;

    public short readShort() throws IOException;

    public int readUnsignedShort() throws IOException;

    public char readChar() throws IOException;

    public int readInt() throws IOException;

    public long readLong() throws IOException;

    public float readFloat() throws IOException;

    public double readDouble() throws IOException;

    public void readFully(byte[] data) throws IOException;

    public void readFully(byte[] data, int offset, int size)
        throws IOException;

    public int skipBytes(int len) throws IOException;

    public String readLine() throws IOException;

    public String readUTF() throws IOException;

    // Class to provide access to serializable fields.
    static abstract public class GetField
    {
        public ObjectStreamClass getObjectStreamClass();

        public boolean defaulted(String name)
            throws IOException, IllegalArgumentException;

        public char get(String name, char default)
            throws IOException, IllegalArgumentException;

        public boolean get(String name, boolean default)
            throws IOException, IllegalArgumentException;

        public byte get(String name, byte default)
            throws IOException, IllegalArgumentException;

        public short get(String name, short default)
            throws IOException, IllegalArgumentException;

        public int get(String name, int default)
            throws IOException, IllegalArgumentException;

        public long get(String name, long default)
            throws IOException, IllegalArgumentException;

        public float get(String name, float default)
            throws IOException, IllegalArgumentException;

        public double get(String name, double default)
            throws IOException, IllegalArgumentException;

        public Object get(String name, Object default)
            throws IOException, IllegalArgumentException;
    }

    protected ObjectInputStream()
        throws StreamCorruptedException, IOException;

    protected readObjectOverride()
        throws OptionalDataException, ClassNotFoundException,
            IOException;
}

単一引数のObjectInputStreamコンストラクタにはInputStreamが必要です。このコンストラクタは、readStreamHeaderを呼び出して、対応するObjectOutputStream.writeStreamHeaderメソッドによって書き込まれたヘッダーとバージョンを読み込み、検査します。セキュリティ・マネージャがインストールされている場合、このコンストラクタは、readFieldsまたはreadUnsharedメソッド(あるいはその両方)をオーバーライドするサブクラスのコンストラクタによって直接または間接に呼び出されたときに、"enableSubclassImplementation" SerializablePermissionをチェックします。

プリミティブ型を読む取るためのすべてのメソッドは、ストリームのブロック・データ・レコードからのバイトのみを消費します。ストリーム内の次のアイテムがオブジェクトのときにプリミティブ・データの読込みが行われると、読込みメソッドは-1かEOFExceptionのうちで適切な方を返します。プリミティブ型の値は、DataInputStreamによってブロック・データ・レコードから読み込まれます。

ストリームでリセット・トークンが起こると、ストリームのすべての状態は破棄されます。既知のオブジェクトのセットはクリアされます。

ストリームで例外トークンが起こると、例外が読み込まれ、終了させた例外を引数として新しいWriteAbortedExceptionがスローされます。ストリーム・コンテキストは前に述べたようにリセットされます。

ストリームから非共有オブジェクトを読み込むには、readUnsharedメソッドを使用します。このメソッドはreadObjectと同じですが、後続のreadObjectおよびreadUnsharedの呼出しが、元のreadUnsharedの呼出しによって返される直列化復元インスタンスへの追加参照を返すことができない点が異なります。具体的には、次のようになります。

• readUnsharedを呼び出して逆参照(以前にストリームに書き込まれたオブジェクトのストリーム表現)を直列化復元しようとすると、ObjectStreamExceptionがスローされます。
• readUnsharedが正常に復帰したあとで、readUnsharedが直列化復元したストリーム・ハンドルへの逆参照を直列化復元しようとすると、ObjectStreamExceptionがスローされます。

ストリームからフィールドおよびオブジェクトを読み込むには、defaultReadObjectメソッドを使用します。このメソッドは、ストリーム内のクラス記述子を使って、名前と型による正規順序でストリームからフィールドを読み込みます。値は、現在のクラス内の名前で一致するフィールドに代入されます。バージョン管理メカニズムの詳細については、セクション5.5「互換性のあるJavaの型展開」を参照してください。ストリーム内にないオブジェクトのフィールドは、そのデフォルト値に設定されます。ストリームにあるがオブジェクトにない値は、破棄されます。このような状態は主に、前のバージョンにはなかったフィールドを、クラスのあとのバージョンに追加で書き込んだ場合に起こります。このメソッドは、クラスのフィールドを復元している間にreadObjectメソッドからのみ呼び出すことができます。それ以外のときに呼び出すと、NotActiveExceptionがスローされます。

readFieldsメソッドは、ストリームから直列化可能フィールドの値を読み取り、GetFieldクラスでその値を取得できるようにします。readFieldsメソッドは、直列化可能クラスのreadObjectメソッド内からしか呼び出すことができません。このメソッドは、1回より多く、またはdefaultReadObjectが呼び出されている場合に、呼び出せません。GetFieldsオブジェクトは、現在のオブジェクトのObjectStreamClassを使って、このクラスのために取得できるフィールドを確認します。readFieldsによって返されるGetFieldsオブジェクトは、クラスreadObjectメソッドへのこの呼出しの間だけ有効です。フィールドは、任意の順序で取得できます。追加データの読込みは、readFieldsが呼び出されたあとに、ストリームから直接読み込む場合だけ可能です。

registerValidationメソッドは、グラフ全体が復元されたけれどもオブジェクトがreadObjectの元の呼出し側に返される前のときに、コールバックを要求するために呼び出すことができます。検証コールバックの順序は、優先順位で制御できます。高い値のコールバックは、低い値のものより前に呼び出されます。検証されるオブジェクトは、ObjectInputValidationインタフェースをサポートし、validateObjectメソッドを実装しなければいけません。クラスのreadObjectメソッド呼出し中に検証を登録することのみが正しいです。そうでない場合は、NotActiveExceptionがスローされます。registerValidationに指定されたコールバック・オブジェクトがnullの場合、InvalidObjectExceptionがスローされます。

Java SDK, Standard Edition, v1.3から、すべてのObjectStreamClassオブジェクトを読み取るためにreadClassDescriptorメソッドが使用されています。直列化ストリーム内でObjectInputStreamが次の項目としてクラス記述子を期待する場合は、readClassDescriptorが呼び出されます。非標準の形式で(writeClassDescriptorメソッドをオーバーライドしたObjectOutputStreamのサブクラスによって)記述されたクラス記述子内で読み取るために、ObjectInputStreamのサブクラスがこのメソッドをオーバーライドできます。デフォルトでは、このメソッドは、6.4項「ストリーム形式の文法」で説明している形式に従ってクラス記述子を読み取ります。

resolveClassメソッドは、クラスが直列化復元されている間、かつクラス記述子が読み込まれたあとで呼び出されます。サブクラスは、ObjectOutputStreamの対応するサブクラスで記述された、クラスに関するほかの情報を読み取るために、このメソッドを拡張できます。メソッドは、指定された名前とserialVersionUIDを持つクラスを見つけて返す必要があります。デフォルト実装は、クラス・ローダーを持つreadObjectのもっとも近い呼び出し側のクラス・ローダーを呼び出すことによって、クラスを見つけます。クラスが見つからない場合は、ClassNotFoundExceptionがスローされるはずです。JDK 1.1.6より前では、resolveClassメソッドは、ストリーム内のクラス名と同じ完全修飾クラス名を返す必要がありました。JDK 1.1.6以降のバージョンでは、リリースをまたがったパッケージ名変更に対応するために、method resolveClassに必要なのは、同じ基底クラス名とSerialVersionUIDを持つクラスを返すことだけです。

resolveObjectメソッドは、直列化復元の際に、あるオブジェクトを監視したり別のオブジェクトに置換したりするために、信頼できるサブクラスによって使用されます。最初のオブジェクトを解決するには、readObjectを呼び出す前にenableResolveObjectを呼び出すことでオブジェクトの解決を明示的に有効にする必要があります。有効になったresolveObjectは、各直列化可能オブジェクトがreadObjectから最初に返される直前に、一度だけ呼び出されます。resolveObjectメソッドは、特別に処理されるクラスClass、ObjectStreamClass、String、および配列のオブジェクトの場合は呼び出されません。サブクラスのresolveObjectの実装は、オリジナルの代わりに代入または返される置換オブジェクトを返す場合があります。返されるオブジェクトは、元のオブジェクトのすべての参照と一貫性を持ちそれらに代入可能な型である必要があり、そうでない場合はClassCastExceptionがスローされます。すべての代入は型チェックされます。ストリーム内の、元のオブジェクトへのすべての参照は、置換オブジェクトへの参照によって置き換えられます。

enableResolveObjectメソッドは、直列化復元の際に、あるオブジェクトを監視したり別のオブジェクトに置換したりするために、ObjectOutputStreamの信頼できるサブクラスによって呼び出されます。オブジェクトの置換は、enableResolveObjectがtrue値で呼び出されるまで無効になっています。それ以降は、falseに設定することで無効にできます。前の設定が返されます。enableResolveObjectメソッドは、直列化の際にストリームが置換を要求する権限を持つかどうかを検査します。オブジェクトのprivate状態が意図せずに公開されることがないように、信頼できるストリームだけがresolveObjectを使用できます。信頼できるクラスとは、クラス・ローダーがnullに等しいか、置換を有効にする権限を提供するセキュリティ保護ドメインに属するクラスのことです。

ObjectInputStreamのサブクラスがシステム・ドメインの一部とみなされない場合は、enableResolveObjectを呼び出す権限をObjectInputStreamのサブクラスに提供する行をセキュリティ・ポリシー・ファイルに追加する必要があります。追加するSerializablePermissionは、"enableSubstitution"です。ObjectStreamClassのサブクラスの保護ドメインがenableResolveObjectを呼び出して"enableSubstitution"する権限を持たない場合は、AccessControlExceptionがスローされます。セキュリティ・モデルの詳細は、Javaセキュリティ・アーキテクチャ(JDK 1.2)のドキュメントを参照してください。

readStreamHeaderメソッドは、ストリームのマジック番号とバージョンを読み込み、検査します。それらが一致しない場合、StreamCorruptedMismatchがスローされます。

直列化復元の実装をオーバーライドするには、ObjectInputStreamのサブクラスがprotected引数なしObjectInputStreamコンストラクタを呼び出す必要があります。SerializablePermission "enableSubclassImplementation"用の引数なしコンストラクタ内では、信頼できるクラスだけがデフォルト実装のオーバーライドを許可されるようにセキュリティ・チェックがあります。このコンストラクタは、ObjectInputStreamにprivateデータを割り当てず、final readObjectメソッドがreadObjectOverrideメソッドを呼び出して復帰すべきことを示すフラグを設定します。ほかのすべてのObjectInputStreamメソッドは、finalではないので、サブクラスによって直接オーバーライドできます。

3.2 ObjectInputStream.GetFieldクラス

getObjectStreamClassメソッドは、ストリーム内のクラスを表すObjectStreamClassオブジェクトを返します。これには、直列化可能フィールドのリストが含まれています。

defaultedメソッドは、ストリーム内にフィールドが存在しない場合は、trueを返します。要求されたフィールドが現在のクラスの直列化可能フィールドでない場合は、IllegalArgumentExceptionがスローされます。

各getメソッドは、指定された直列化可能フィールドをストリームから返します。基になるストリームが例外をスローした場合は、入出力例外がスローされます。名前または型が現在のクラスの直列化可能フィールドの名前および型に一致しない場合は、IllegalArgumentExceptionがスローされます。フィールドの明示的な値がストリームに含まれていない場合は、デフォルト値が返されます。

3.3 ObjectInputValidationインタフェース

このインタフェースを使用することで、オブジェクトの完全なグラフ(オブジェクトが構成する完全グラフ)が直列化復元されたときに、オブジェクトを呼び出すことができます。オブジェクトを有効にできない場合は、ObjectInvalidExceptionをスローするはずです。validateObject呼出し中に例外が発生すると、検証処理が終了し、InvalidObjectExceptionがスローされます。

package java.io;

public interface ObjectInputValidation
{
    public void validateObject()
        throws InvalidObjectException;
}

3.4 readObjectメソッド

    private void readObject(ObjectInputStream stream)
        throws IOException, ClassNotFoundException;

クラスのreadObjectメソッドは(実装されている場合)、そのクラスの状態を復元する責任を持ちます。transientかどうかstaticかどうかには関係なく、オブジェクトの各フィールドの値は、フィールド型のデフォルト値に設定されます。ObjectInputStreamのdefaultReadObjectまたはreadFieldsメソッドは、対応するwriteObjectメソッドによって書き出されたオプション・データを読み取る前に、一度のみ呼び出す必要があります。オプション・データを読み取らない場合でも、defaultReadObjectまたはreadFieldsを一度呼び出す必要があります。クラスのreadObjectメソッドが、このクラスのストリームのオプション部分に存在するデータより多くのデータを読み取ろうとすると、ストリームはバイト単位読取りの場合は-1を返し、プリミティブ・データ読取り(readInt、readFloatなど)の場合はEOFExceptionをスローし、オブジェクト読取りの場合はeofフィールドがtrueに設定されたOptionalDataExceptionをスローします。

オプション・データのフォーマット、構造体、バージョン管理の責任は、完全にクラスにあります。オプション・データのフォーマットおよび構造体を文書化する場合は、readObjectメソッドのjavadocコメント内で@serialData javadocタグを使うようにしてください。

復元するクラスが読み取るストリーム内に存在しない場合、readObjectNoDataメソッドが(定義されている場合)呼び出され(readObjectの代わりに)、そうでない場合はそのフィールドは適切なデフォルト値に初期化されます。詳細は、セクション3.5を参照してください。

ObjectInputStreamからのオブジェクトの読込みは、新しいオブジェクトの作成に似ています。新しいオブジェクトのコンストラクタがスーパー・クラスからサブクラスの順番で呼び出されるのと同様に、ストリームから読み込まれるオブジェクトは、スーパー・クラスからサブクラスに直列化復元されます。直列化復元中は、Serializableサブクラスごとに、コンストラクタの代わりにreadObjectまたはreadObjectNoDataメソッドが呼び出されます。

コンストラクタとreadObjectメソッドでもう1つ似ている点は、どちらも、完全に構築されていないオブジェクトでメソッドを呼び出す機会を提供することです。オブジェクトの構築中に呼び出されるオーバーライド可能なメソッド(private、static、finalのどれでもないもの)は、サブクラスによって潜在的にオーバーライドされている場合があります。オブジェクトの構築段階に呼び出されるメソッドは、コンストラクタまたはreadObject/readObjectNoDataメソッドによって現在初期化されている型ではなく、オブジェクトの実際の型によって解決されます。したがって、readObjectまたはreadObjectNoDataメソッド内からオーバーライド可能なメソッドを呼び出すと、スーパー・クラスが完全に初期化される前にサブクラスが意図せずに呼び出される可能性があります。

3.5 readObjectNoDataメソッド

  private void readObjectNoData() throws ObjectStreamException;

直列化可能クラスごとに、独自のreadObjectNoDataメソッドを定義できます。直列化可能クラスがreadObjectNoDataメソッドを定義しない場合、前述の状況では、クラスのフィールドは(「Java Language Specification」に記載された)デフォルト値に初期化されます。この動作は、readObjectNoDataメソッドのサポートが導入されたJava 2 SDK, Standard Edition Version 1.4より前のObjectInputStreamの動作と一致します。直列化可能クラスがreadObjectNoDataメソッドを定義していて、前述の状況が発生した場合は、直列化復元中のその時点でreadObjectNoDataが呼び出されます(そのクラスがストリームによって、直列化復元するインスタンスのスーパー・クラスとしてリストされた場合は、クラス定義のreadObjectメソッドが呼び出される)。

3.6 readExternalメソッド

    public void readExternal(ObjectInput stream)
        throws IOException;

新しいExternalizableストリーム形式には、利用できるExternalデータより多くのデータの読取りをObjectInputStreamが検出し、readExternalメソッドが消費されていないデータをスキップできるという利点もあります。Externalデータの終わりを越えた読取りに対するObjectInputStreamの動作は、クラス定義のreadObjectメソッドがオプション・データの終わりを越えて読み取ろうとしたときの動作と同じです。バイト単位読取りは-1を返し、プリミティブ読取りはEOFExceptionをスローし、オブジェクト読取りはeofフィールドがtrueに設定されたOptionalDataExceptionをスローします。

フォーマット変更のため、JDK 1.1.6以前のリリースは新しいフォーマットを読み取れません。JDK 1.1.6以前がPROTOCOL_VERSION_2で書き込まれたストリームからExternalizableオブジェクトを読み取ろうとすると、StreamCorruptedExceptionがスローされます。互換性の問題については、セクション6.3「ストリーム・プロトコル・バージョン」を参照してください。

3.7 readResolveメソッド

   ANY-ACCESS-MODIFIER Object readResolve()
                throws ObjectStreamException;

たとえば、Symbolクラスを作成して、シンボル・バインディングごとにインスタンスが仮想マシン内に1つだけ存在していたとします。readResolveメソッドは、そのシンボルがすでに定義されているかどうかを判断し、アイデンティティ制約を保持するために既存の等価Symbolオブジェクトを置換するために実装されます。こうすることで、Symbolオブジェクトの一意性を直列化をまたがって保持できます。