ISerializable インターフェイス

定義

オブジェクトが独自のシリアル化および逆シリアル化を制御できるようにします。Allows an object to control its own serialization and deserialization.

public interface class ISerializable
[System.Runtime.InteropServices.ComVisible(true)]
public interface ISerializable
type ISerializable = interface
Public Interface ISerializable
派生
属性

次のコード例は、 ISerializableインターフェイスを使用して、クラスのカスタムシリアル化動作を定義する方法を示しています。The following code example demonstrates the use of the ISerializable interface to define custom serialization behavior for a class.

using namespace System;
using namespace System::IO;
using namespace System::Collections;
using namespace System::Runtime::Serialization::Formatters::Binary;
using namespace System::Runtime::Serialization;

ref class SingletonSerializationHelper;

// There should be only one instance of this type per AppDomain.

[Serializable]
public ref class Singleton sealed: public ISerializable
{
private:

   // This is the one instance of this type.
   static Singleton^ theOneObject = gcnew Singleton;

public:

   // Here are the instance fields.
   String^ someString;
   Int32 someNumber;

private:

   // Private constructor allowing this type to construct the singleton.
   Singleton()
   {
      
      // Do whatever is necessary to initialize the singleton.
      someString = "This is a String* field";
      someNumber = 123;
   }

public:

   // A method returning a reference to the singleton.
   static Singleton^ GetSingleton()
   {
      return theOneObject;
   }

   // A method called when serializing a Singleton.
   [System::Security::Permissions::SecurityPermissionAttribute
   (System::Security::Permissions::SecurityAction::LinkDemand, 
   Flags=System::Security::Permissions::SecurityPermissionFlag::SerializationFormatter)]
   virtual void GetObjectData( SerializationInfo^ info, StreamingContext context )
   {
      // Instead of serializing this Object*, we will  
      // serialize a SingletonSerializationHelp instead.
      info->SetType( SingletonSerializationHelper::typeid );

      // No other values need to be added.
   }

   // NOTE: ISerializable*'s special constructor is NOT necessary 
   // because it's never called
};

[Serializable]
private ref class SingletonSerializationHelper sealed: public IObjectReference
{
public:

   // This Object* has no fields (although it could).
   // GetRealObject is called after this Object* is deserialized
   virtual Object^ GetRealObject( StreamingContext context )
   {
      // When deserialiing this Object*, return a reference to 
      // the singleton Object* instead.
      return Singleton::GetSingleton();
   }
};

[STAThread]
int main()
{
   FileStream^ fs = gcnew FileStream( "DataFile.dat",FileMode::Create );
   try
   {
      // Construct a BinaryFormatter and use it 
      // to serialize the data to the stream.
      BinaryFormatter^ formatter = gcnew BinaryFormatter;

      // Create an array with multiple elements refering to 
      // the one Singleton Object*.
      array<Singleton^>^a1 = {Singleton::GetSingleton(),Singleton::GetSingleton()};

      // This displays S"True".
      Console::WriteLine( "Do both array elements refer to the same Object? {0}", (a1[ 0 ] == a1[ 1 ]) );

      // Serialize the array elements.
      formatter->Serialize( fs, a1 );

      // Deserialize the array elements.
      fs->Position = 0;
      array<Singleton^>^a2 = (array<Singleton^>^)formatter->Deserialize( fs );

      // This displays S"True".
      Console::WriteLine( "Do both array elements refer to the same Object? {0}", (a2[ 0 ] == a2[ 1 ]) );

      // This displays S"True".
      Console::WriteLine( "Do all  array elements refer to the same Object? {0}", (a1[ 0 ] == a2[ 0 ]) );
   }
   catch ( SerializationException^ e ) 
   {
      Console::WriteLine( "Failed to serialize. Reason: {0}", e->Message );
      throw;
   }
   finally
   {
      fs->Close();
   }

   return 0;
}
using System;
using System.Text;
using System.IO;
// Add references to Soap and Binary formatters.
using System.Runtime.Serialization.Formatters.Binary;
using System.Runtime.Serialization.Formatters.Soap ;
using System.Runtime.Serialization;


[Serializable]
public class MyItemType : ISerializable
{
    public MyItemType()
    {
        // Empty constructor required to compile.
    }

    // The value to serialize.
    private string myProperty_value;

    public string MyProperty
    {
        get { return myProperty_value; }
        set { myProperty_value = value; }
    }
        
    // Implement this method to serialize data. The method is called 
    // on serialization.
    public void GetObjectData(SerializationInfo info, StreamingContext context)
    {
        // Use the AddValue method to specify serialized values.
        info.AddValue("props", myProperty_value, typeof(string));

    }

    // The special constructor is used to deserialize values.
    public MyItemType(SerializationInfo info, StreamingContext context)
    {
        // Reset the property value using the GetValue method.
        myProperty_value = (string) info.GetValue("props", typeof(string));
    }
}

// This is a console application. 
public static class Test
{
    static void Main()
    {
        // This is the name of the file holding the data. You can use any file extension you like.
        string fileName = "dataStuff.myData";

        // Use a BinaryFormatter or SoapFormatter.
        IFormatter formatter = new BinaryFormatter();
        //IFormatter formatter = new SoapFormatter();
            
        Test.SerializeItem(fileName, formatter); // Serialize an instance of the class.
        Test.DeserializeItem(fileName, formatter); // Deserialize the instance.
        Console.WriteLine("Done");
        Console.ReadLine();
    }

    public static void SerializeItem(string fileName, IFormatter formatter)
    {
        // Create an instance of the type and serialize it.
        MyItemType t = new MyItemType();
        t.MyProperty = "Hello World";

        FileStream s = new FileStream(fileName , FileMode.Create);
        formatter.Serialize(s, t);            
        s.Close();
    }


    public static void DeserializeItem(string fileName, IFormatter formatter)
    {
        FileStream s = new FileStream(fileName, FileMode.Open);
        MyItemType t = (MyItemType)formatter.Deserialize(s);
        Console.WriteLine(t.MyProperty);            
    }       
}
Imports System.Text
Imports System.IO

' Add references to Soap and Binary formatters.
Imports System.Runtime.Serialization.Formatters.Binary
Imports System.Runtime.Serialization.Formatters.Soap
Imports System.Runtime.Serialization


<Serializable()> _
Public Class MyItemType
    Implements ISerializable
    ' Empty constructor required to compile.
    Public Sub New()
    End Sub

    ' The value to serialize.
    Private myProperty_value As String

    Public Property MyProperty() As String
        Get
            Return myProperty_value
        End Get
        Set(value As String)
            myProperty_value = value
        End Set
    End Property

    ' Implement this method to serialize data. The method is called 
    ' on serialization.
    Public Sub GetObjectData(info As SerializationInfo, context As StreamingContext) Implements ISerializable.GetObjectData
        ' Use the AddValue method to specify serialized values.
        info.AddValue("props", myProperty_value, GetType(String))

    End Sub

    ' The special constructor is used to deserialize values.
    Public Sub New(info As SerializationInfo, context As StreamingContext)
        ' Reset the property value using the GetValue method.
        myProperty_value = DirectCast(info.GetValue("props", GetType(String)), String)
    End Sub
End Class

' This is a console application. 
Public Class Test


    Public Shared Sub Main()
        ' This is the name of the file holding the data. You can use any file extension you like.
        Dim fileName As String = "dataStuff.myData"

        ' Use a BinaryFormatter or SoapFormatter.
        Dim formatter As IFormatter = New BinaryFormatter()
        ' Dim formatter As IFormatter = New SoapFormatter()

        Test.SerializeItem(fileName, formatter)
        ' Serialize an instance of the class.
        Test.DeserializeItem(fileName, formatter)
        ' Deserialize the instance.
        Console.WriteLine("Done")
        Console.ReadLine()
    End Sub

    Public Shared Sub SerializeItem(fileName As String, formatter As IFormatter)
        ' Create an instance of the type and serialize it.
        Dim myType As New MyItemType()
        myType.MyProperty = "Hello World"

        Dim fs As New FileStream(fileName, FileMode.Create)
        formatter.Serialize(fs, myType)
        fs.Close()
    End Sub


    Public Shared Sub DeserializeItem(fileName As String, formatter As IFormatter)
        Dim fs As New FileStream(fileName, FileMode.Open)

        Dim myType As MyItemType = DirectCast(formatter.Deserialize(fs), MyItemType)
        Console.WriteLine(myType.MyProperty)
    End Sub
End Class

注釈

シリアル化される可能性のあるすべてのクラスはSerializableAttribute、でマークされている必要があります。Any class that might be serialized must be marked with the SerializableAttribute. クラスがシリアル化プロセスを制御する必要がある場合は、 ISerializableインターフェイスを実装できます。If a class needs to control its serialization process, it can implement the ISerializable interface. Formatter 、シリアルGetObjectData化時にを呼び出し、指定SerializationInfoされたに、オブジェクトを表すために必要なすべてのデータを設定します。The Formatter calls the GetObjectData at serialization time and populates the supplied SerializationInfo with all the data required to represent the object. Formatter 、グラフSerializationInfo内のオブジェクトの型を使用して、を作成します。The Formatter creates a SerializationInfo with the type of the object in the graph. プロキシを送信する必要があるオブジェクトは、でFullTypeName SerializationInfoメソッドAssemblyNameとメソッドを使用して、送信される情報を変更できます。Objects that need to send proxies for themselves can use the FullTypeName and AssemblyName methods on SerializationInfo to change the transmitted information.

クラスの継承の場合、を実装ISerializableする基本クラスから派生したクラスをシリアル化することができます。In the case of class inheritance, it is possible to serialize a class that derives from a base class that implements ISerializable. この場合、派生クラスは、のGetObjectData GetObjectData実装内での基底クラスの実装を呼び出す必要があります。In this case, the derived class should call the base class implementation of GetObjectData inside its implementation of GetObjectData. それ以外の場合、基本クラスのデータはシリアル化されません。Otherwise, the data from the base class will not be serialized.

インターフェイスISerializableは、シグネチャコンストラクター (SerializationInfo情報、 StreamingContextコンテキスト) を持つコンストラクターを意味します。The ISerializable interface implies a constructor with the signature constructor (SerializationInfo information, StreamingContext context). 逆シリアル化時には、のSerializationInfoデータがフォーマッタによって逆シリアル化された後にのみ、現在のコンストラクターが呼び出されます。At deserialization time, the current constructor is called only after the data in the SerializationInfo has been deserialized by the formatter. 一般に、クラスがシールされていない場合は、このコンストラクターを保護する必要があります。In general, this constructor should be protected if the class is not sealed.

オブジェクトを逆シリアル化する順序を保証することはできません。The order in which objects are deserialized cannot be guaranteed. たとえば、ある型がまだ逆シリアル化されていない型を参照している場合、例外が発生します。For example, if one type references a type that has not been deserialized yet, an exception will occur. このような依存関係を持つ型を作成する場合は、 IDeserializationCallbackインターフェイスOnDeserializationとメソッドを実装することで問題を回避できます。If you are creating types that have such dependencies, you can work around the problem by implementing the IDeserializationCallback interface and the OnDeserialization method.

シリアル化アーキテクチャは、を拡張MarshalByRefObject Objectする型と同じを拡張するオブジェクト型を処理します。The serialization architecture handles object types that extend MarshalByRefObject the same as types that extend Object. これらの型は、 SerializableAttributeでマークし、その他のオブジェクト型としてISerializableインターフェイスを実装できます。These types can be marked with the SerializableAttribute and implement the ISerializable interface as any other object type. オブジェクトの状態がキャプチャされ、ストリームに保持されます。Their object state will be captured and persisted onto the stream.

これらの型がによってSystem.Runtime.Remoting使用されている場合、リモート処理インフラストラクチャは、一般的なシリアル化をプリエンプションMarshalByRefObjectし、代わりにプロキシをにシリアル化するサロゲートを提供します。When these types are being used through System.Runtime.Remoting, the remoting infrastructure provides a surrogate that preempts typical serialization and instead serializes a proxy to the MarshalByRefObject. サロゲートは、特定の型のオブジェクトをシリアル化および逆シリアル化する方法を認識するヘルパーです。A surrogate is a helper that knows how to serialize and deserialize objects of a particular type. プロキシは、ほとんどの場合、ユーザーには表示されませんObjRefが、型になります。The proxy, invisible to the user in most cases, will be of type ObjRef.

一般的な設計パターンとして、クラスが serializable 属性でマークされ、拡張MarshalByRefObjectされることは珍しくありません。As a general design pattern, it would be unusual for a class to be both marked with the serializable attribute and extend MarshalByRefObject. 開発者は、これら2つの特性を組み合わせるときに、考えられるシリアル化とリモート処理のシナリオについて慎重に検討する必要がありますDevelopers should think carefully about the possible serialization and remoting scenarios when combining these two characteristics. これが適用される例としてはMemoryStream、があります。One example where this might be applicable is with a MemoryStream. ( MemoryStream MarshalByRefObject MemoryStream ) の基本クラスはから拡張されますが、の状態をキャプチャして、その時点で復元することができます。StreamWhile the base class of MemoryStream (Stream) extends from MarshalByRefObject, it is possible to capture the state of a MemoryStream and restore it at will. このため、このストリームの状態をデータベースにシリアル化して、後で復元することは意味があるかもしれません。It might, therefore, be meaningful to serialize the state of this stream into a database and restore it at some later point in time. ただし、リモート処理によって使用される場合、この型のオブジェクトはプロキシ化されます。However, when used through remoting, an object of this type would be proxied.

を拡張MarshalByRefObjectするクラスのシリアル化の詳細についRemotingSurrogateSelectorては、「」を参照してください。For more information about serialization of classes that extend MarshalByRefObject, see RemotingSurrogateSelector. の実装ISerializableの詳細については、「カスタムシリアル化」を参照してください。For more information about implementing ISerializable, see Custom Serialization.

注意 (実装者)

オブジェクトが独自のシリアル化と逆シリアル化に参加できるようにするには、このインターフェイスを実装します。Implement this interface to allow an object to take part in its own serialization and deserialization.

メソッド

GetObjectData(SerializationInfo, StreamingContext)

SerializationInfo に、オブジェクトをシリアル化するために必要なデータを設定します。Populates a SerializationInfo with the data needed to serialize the target object.

適用対象

こちらもご覧ください