ISerializable Schnittstelle

  • Referenz

Definition

Namespace:
System.Runtime.Serialization
Assembly:
System.Runtime.dll
Assembly:
System.Runtime.Serialization.Formatters.dll
Assembly:
mscorlib.dll
Assembly:
netstandard.dll

Ermöglicht es einem Objekt, seine eigene Serialisierung und Deserialisierung durch binäre und XML-Serialisierung zu steuern.

public interface class ISerializable
public interface ISerializable
[System.Runtime.InteropServices.ComVisible(true)]
public interface ISerializable
type ISerializable = interface
[<System.Runtime.InteropServices.ComVisible(true)>]
type ISerializable = interface
Public Interface ISerializable
Abgeleitet
Attribute
ComVisibleAttribute

Beispiele

Im folgenden Codebeispiel wird die Verwendung der ISerializable -Schnittstelle zum Definieren des benutzerdefinierten binären Serialisierungsverhaltens für eine Klasse veranschaulicht.

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 mithilfe der binären oder XML-Serialisierung serialisiert werden kann, muss mit SerializableAttributegekennzeichnet werden. Wenn eine Klasse ihren binären oder XML-Serialisierungsprozess steuern muss, kann sie die ISerializable -Schnittstelle implementieren. 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. Der Formatter erstellt eine SerializationInfo mit dem Typ des Objekts im Diagramm. 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.

Im Fall der Klassenvererbung ist es möglich, eine Klasse zu serialisieren, die von einer Basisklasse abgeleitet wird, die implementiert ISerializable. In diesem Fall sollte die abgeleitete Klasse die Basisklassenimplementierung von innerhalb ihrer GetObjectData Implementierung von GetObjectDataaufrufen. Andernfalls werden die Daten aus der Basisklasse nicht serialisiert.

Die ISerializable -Schnittstelle impliziert einen Konstruktor mit der Signatur constructor (SerializationInfo information, StreamingContext context). Zur Deserialisierungszeit wird der aktuelle Konstruktor erst aufgerufen, nachdem die Daten in vom SerializationInfo Formatierer deserialisiert wurden. Im Allgemeinen sollte dieser Konstruktor sein protected , wenn die Klasse nicht sealedist.

Die Reihenfolge, in der Objekte deserialisiert werden, kann nicht garantiert werden. Wenn beispielsweise ein Typ auf einen Typ verweist, der noch nicht deserialisiert wurde, tritt eine Ausnahme auf. Wenn Sie Typen mit solchen Abhängigkeiten erstellen, können Sie das Problem umgehen, indem Sie die IDeserializationCallback Schnittstelle und die OnDeserialization Methode implementieren.

Die Serialisierungsarchitektur behandelt Objekttypen, die dasselbe wie Typen erweitern MarshalByRefObject , die erweitern Object. Diese Typen können mit dem SerializableAttribute markiert werden und die ISerializable Schnittstelle als jeden anderen Objekttyp implementieren. Ihr Objektzustand wird erfasst und im Stream beibehalten.

Wenn diese Typen über System.Runtime.Remotingverwendet werden, stellt die Remotinginfrastruktur eine Ersatzlösung bereit, die die typische Serialisierung ausrottet und stattdessen einen Proxy an die MarshalByRefObjectserialisiert. Ein Ersatz ist ein Hilfsprogramm, das weiß, wie Objekte eines bestimmten Typs serialisiert und deserialisiert werden. Der Für den Benutzer in den meisten Fällen unsichtbare Proxy ist vom Typ ObjRef.

Als allgemeines Entwurfsmuster wäre es ungewöhnlich, dass eine Klasse sowohl mit dem serialisierbaren Attribut gekennzeichnet ist als auch erweitern MarshalByRefObjectwürde. Entwickler sollten bei der Kombination dieser beiden Merkmale sorgfältig über die möglichen Serialisierungs- und Remotingszenarien nachdenken. Ein Beispiel, in dem dies zutrifft, ist mit .MemoryStream Während die Basisklasse von MemoryStream (Stream) von MarshalByRefObjecterweitert wird, ist es möglich, den Zustand eines MemoryStream zu erfassen und nach Bewill wiederzugeben. Daher kann es sinnvoll sein, den Status dieses Datenstroms in eine Datenbank zu serialisieren und zu einem späteren Zeitpunkt wiederherzustellen. Wenn sie jedoch über Remoting verwendet wird, wird ein Objekt dieses Typs per Proxy verwendet.

Weitere Informationen zur Serialisierung von Klassen, die erweitern MarshalByRefObject, finden Sie unter RemotingSurrogateSelector. Weitere Informationen zur Implementierung ISerializablefinden Sie unter Benutzerdefinierte Serialisierung.

Hinweis

Diese Schnittstelle gilt nicht für die JSON-Serialisierung mit System.Text.Json.

Hinweise für Ausführende

Implementieren Sie diese Schnittstelle, damit ein Objekt an seiner eigenen Serialisierung und Deserialisierung teilnehmen kann.

Methoden

GetObjectData(SerializationInfo, StreamingContext)
Veraltet.

Füllt eine SerializationInfo mit den Daten auf, die zum Serialisieren des Zielobjekts erforderlich sind.

Gilt für:

Weitere Informationen