ISerializable ISerializable ISerializable ISerializable Interface

Определение

Позволяет объекту управлять его собственной сериализацией и десериализацией.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. Вызывает метод во время сериализации SerializationInfo и заполняет переданный объект всеми данными, необходимыми для представления объекта. GetObjectData FormatterThe Formatter calls the GetObjectData at serialization time and populates the supplied SerializationInfo with all the data required to represent the object. Объект создает объект SerializationInfo с типом объекта в графе. FormatterThe Formatter creates a SerializationInfo with the type of the object in the graph. Объекты, которым необходимо отправлять собственные прокси-серверы, могут использовать FullTypeName методы AssemblyName и в SerializationInfo для изменения передаваемых данных.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.

Интерфейс подразумевает конструктор с конструктором сигнатуры (SerializationInfo сведения, StreamingContext контекст). ISerializableThe 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 те же типы, что и расширения. ObjectThe 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. Разработчикам следует внимательно думать о возможных сценариях сериализации и удаленного взаимодействия при объединении этих двух характеристик.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.

Дополнительные сведения о сериализации классов, которые расширяются 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) GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext)

Заполняет объект SerializationInfo данными, необходимыми для сериализации целевого объекта.Populates a SerializationInfo with the data needed to serialize the target object.

Применяется к

Дополнительно