ISerializable ISerializable ISerializable ISerializable Interface

정의

개체가 자체 serialization 및 deserialization을 제어할 수 있도록 합니다.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 클래스에 대 한 사용자 지정 serialization 동작을 정의 하는 인터페이스입니다.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

설명

Serialize 할 수 있는 모든 클래스를 사용 하 여 표시 되어야 합니다는 SerializableAttribute합니다.Any class that might be serialized must be marked with the SerializableAttribute. 클래스를 해당 serialization 프로세스를 제어 해야 하는 경우 구현할 수는 ISerializable 인터페이스입니다.If a class needs to control its serialization process, it can implement the ISerializable interface. Formatter 호출을 GetObjectData serialization 시 제공 된 채웁니다 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. 직접 사용 하 여 수에 대 한 프록시를 보내야 하는 개체를 FullTypeNameAssemblyName 메서드를 SerializationInfo 전송 된 정보를 변경 합니다.Objects that need to send proxies for themselves can use the FullTypeName and AssemblyName methods on SerializationInfo to change the transmitted information.

클래스 상속의 경우 구현 하는 기본 클래스에서 파생 되는 클래스를 serialize 할 수 있기 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. 그렇지 않은 경우 기본 클래스에서 데이터 serialize 되지 않습니다.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). Deserialization 시 데이터를 한 후에 현재 생성자가 호출 된 SerializationInfo 포맷터에 의해 deserialize 된 합니다.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.

개체가 deserialize 될 순서를 보장할 수 없습니다.The order in which objects are deserialized cannot be guaranteed. 예를 들어, 아직 deserialize 되지 않는 형식을 참조 하는 형식, 예외가 발생 합니다.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.

확장 하는 개체 형식을 처리 하는 serialization 아키텍처 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, 일반적인 serialization 보다 우선 하 고 대신에 프록시를 serialize 하는 서로게이트를 제공 하는 원격 인프라는 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. 서로게이트는 특정 유형의 개체 serialize 및 deserialize 하는 방법을 아는 도우미입니다.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. 개발자는 이러한 두 가지 특성을 결합 하는 경우 가능한 직렬화 및 원격 시나리오에 대 한 신중 하 게 생각해 야 합니다.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 (Stream)에서 확장 MarshalByRefObject의 상태를 캡처할 수 있기를 MemoryStream 를 복원 합니다.While 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.

확장 하는 클래스의 serialization에 대 한 자세한 내용은 MarshalByRefObject를 참조 하세요 RemotingSurrogateSelector합니다.For more information about serialization of classes that extend MarshalByRefObject, see RemotingSurrogateSelector. 구현에 대 한 자세한 내용은 ISerializable를 참조 하세요 사용자 지정 Serialization합니다.For more information about implementing ISerializable, see Custom Serialization.

구현자 참고

개체가 자체 serialization 및 deserialization에 참여할 수 있도록 하려면이 인터페이스를 구현 합니다.Implement this interface to allow an object to take part in its own serialization and deserialization.

메서드

GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext)

대상 개체를 직렬화하는 데 필요한 데이터로 SerializationInfo를 채웁니다.Populates a SerializationInfo with the data needed to serialize the target object.

적용 대상

추가 정보