ISerializable ISerializable ISerializable ISerializable Interface

Definition

Ermöglicht einem Objekt, die eigene Serialisierung und Deserialisierung zu überwachen.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
Abgeleitet
Attribute

Beispiele

Das folgende Codebeispiel veranschaulicht die Verwendung der Schnittstelle ISerializable, um das benutzerdefinierte Serialisierungsverhalten für eine Klasse zu definieren.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

Hinweise

Jede Klasse, die möglicherweise serialisiert werden muss, muss mit dem SerializableAttribute markiert werden.Any class that might be serialized must be marked with the SerializableAttribute. Wenn eine Klasse ihren Serialisierungsprozess steuern muss, kann sie die Schnittstelle ISerializable implementieren.If a class needs to control its serialization process, it can implement the ISerializable interface. Der Namespace Formatter ruft GetObjectData während der Serialisierung auf und füllt die angegebene SerializationInfo mit allen Daten auf, die zur Darstellung des Objekts erforderlich sind.The Formatter calls the GetObjectData at serialization time and populates the supplied SerializationInfo with all the data required to represent the object. Der Formatter erstellt eine SerializationInfo mit dem Typ des Objekts im Diagramm.The Formatter creates a SerializationInfo with the type of the object in the graph. Objekte, die Proxys für sich selbst senden müssen, können die Methoden FullTypeName und AssemblyName unter SerializationInfo verwenden, um die übermittelten Informationen zu ändern.Objects that need to send proxies for themselves can use the FullTypeName and AssemblyName methods on SerializationInfo to change the transmitted information.

Bei der Klassen Vererbung ist es möglich, eine Klasse zu serialisieren, die von einer Basisklasse abgeleitet ist, ISerializabledie implementiert.In the case of class inheritance, it is possible to serialize a class that derives from a base class that implements ISerializable. In diesem Fall sollte die abgeleitete Klasse die Basisklassen Implementierung von GetObjectData innerhalb der Implementierung von GetObjectDataaufzurufen.In this case, the derived class should call the base class implementation of GetObjectData inside its implementation of GetObjectData. Andernfalls werden die Daten aus der Basisklasse nicht serialisiert.Otherwise, the data from the base class will not be serialized.

Die ISerializable -Schnittstelle impliziert einen Konstruktor mit dem Signatur-SerializationInfo Konstruktor StreamingContext (Informationen, Kontext).The ISerializable interface implies a constructor with the signature constructor (SerializationInfo information, StreamingContext context). Zum Zeitpunkt der Deserialisierung wird der aktuelle Konstruktor erst aufgerufen, nachdem die Daten in SerializationInfo der vom Formatierer deserialisiert wurden.At deserialization time, the current constructor is called only after the data in the SerializationInfo has been deserialized by the formatter. Im Allgemeinen sollte dieser Konstruktor geschützt werden, wenn die Klasse nicht versiegelt ist.In general, this constructor should be protected if the class is not sealed.

Die Reihenfolge, in der Objekte deserialisiert werden, kann nicht garantiert werden.The order in which objects are deserialized cannot be guaranteed. Wenn ein Typ z. b. auf einen Typ verweist, der noch nicht deserialisiert wurde, wird eine Ausnahme ausgelöst.For example, if one type references a type that has not been deserialized yet, an exception will occur. Wenn Sie Typen erstellen, die solche Abhängigkeiten aufweisen, können Sie das Problem umgehen, indem Sie die IDeserializationCallback -Schnittstelle OnDeserialization und die-Methode implementieren.If you are creating types that have such dependencies, you can work around the problem by implementing the IDeserializationCallback interface and the OnDeserialization method.

Die serialisierungstechnologie behandelt Objekt MarshalByRefObject Typen, die den gleichen Wert Objectwie Typen erweitern, die erweitern.The serialization architecture handles object types that extend MarshalByRefObject the same as types that extend Object. Diese Typen können mit dem SerializableAttribute gekennzeichnet werden und implementieren die ISerializable -Schnittstelle wie ein beliebiger anderer Objekttyp.These types can be marked with the SerializableAttribute and implement the ISerializable interface as any other object type. Der Objektzustand wird aufgezeichnet und im Stream persistent gespeichert.Their object state will be captured and persisted onto the stream.

Wenn diese Typen über System.Runtime.Remotingverwendet werden, stellt die Remoting-Infrastruktur ein Ersatz Zeichen bereit, das eine typische Serialisierung vorzeitig verwendet und stattdessen einen Proxy in den MarshalByRefObjectserialisiert.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. Ein Ersatz Zeichen ist ein Hilfsprogramm, das die Serialisierung und Deserialisierung von Objekten eines bestimmten Typs weiß.A surrogate is a helper that knows how to serialize and deserialize objects of a particular type. Der Proxy, der für den Benutzer in den meisten Fällen unsichtbar ist, ist ObjRefvom Typ.The proxy, invisible to the user in most cases, will be of type ObjRef.

Als allgemeines Entwurfsmuster wäre es nicht ungewöhnlich, dass eine Klasse mit dem serialisierbaren Attribut gekennzeichnet und erweitert MarshalByRefObjectwird.As a general design pattern, it would be unusual for a class to be both marked with the serializable attribute and extend MarshalByRefObject. Entwickler sollten bei der Kombination dieser beiden Eigenschaften sorgfältig die möglichen Serialisierungs-und Remotingszenarien berücksichtigen.Developers should think carefully about the possible serialization and remoting scenarios when combining these two characteristics. Ein MemoryStreamBeispiel hierfür ist die Verwendung von.One example where this might be applicable is with a MemoryStream. Obwohl die Basisklasse von MemoryStream (Stream) von MarshalByRefObjecterweitert wird, ist es möglich, den Zustand eines zu MemoryStream erfassen und ihn nach dem Willen wiederherzustellen.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. Daher kann es sinnvoll sein, den Zustand dieses Streams in eine Datenbank zu serialisieren und zu einem späteren Zeitpunkt wiederherzustellen.It might, therefore, be meaningful to serialize the state of this stream into a database and restore it at some later point in time. Wenn Sie jedoch über Remoting verwendet wird, würde ein Objekt dieses Typs per Proxy verwendet werden.However, when used through remoting, an object of this type would be proxied.

Weitere Informationen zur Serialisierung von Klassen, die erweitern MarshalByRefObject, finden RemotingSurrogateSelectorSie unter.For more information about serialization of classes that extend MarshalByRefObject, see RemotingSurrogateSelector. Weitere Informationen zum Implementieren ISerializablevon finden Sie unter benutzerdefinierte Serialisierung.For more information about implementing ISerializable, see Custom Serialization.

Hinweise für Ausführende

Implementieren Sie diese Schnittstelle, damit ein Objekt an der eigenen Serialisierung und Deserialisierung teilnehmen kann.Implement this interface to allow an object to take part in its own serialization and deserialization.

Methoden

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

Füllt eine SerializationInfo mit den Daten auf, die zum Serialisieren des Zielobjekts erforderlich sind.Populates a SerializationInfo with the data needed to serialize the target object.

Gilt für:

Siehe auch