ISerializable Interfejs

Definicja

Umożliwia obiektowi kontrolowanie własnej serializacji i deserializacji.

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
Pochodne
Atrybuty

Przykłady

W poniższym przykładzie kodu pokazano użycie interfejsu ISerializable do definiowania niestandardowego zachowania serializacji dla klasy.

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

Uwagi

Każda klasa, która może być serializowana, musi być oznaczona znakiem SerializableAttribute. Jeśli klasa musi kontrolować swój proces serializacji, może zaimplementować ISerializable interfejs. Metoda Formatter wywołuje metodę GetObjectData w czasie serializacji i wypełnia dostarczone SerializationInfo ze wszystkimi danymi wymaganymi do reprezentowania obiektu. Obiekt Formatter tworzy SerializationInfo obiekt z typem obiektu na grafie. Obiekty, które muszą wysyłać serwery proxy dla siebie, mogą używać FullTypeName metod i AssemblyName w SerializationInfo celu zmiany przesyłanych informacji.

W przypadku dziedziczenia klas można serializować klasę, która pochodzi z klasy bazowej, która implementuje ISerializable. W tym przypadku klasa pochodna powinna wywołać implementację klasy bazowej GetObjectData wewnątrz implementacji klasy GetObjectData. W przeciwnym razie dane z klasy bazowej nie będą serializowane.

Interfejs ISerializable implikuje konstruktor z podpisem constructor (SerializationInfo information, StreamingContext context). W czasie deserializacji bieżący konstruktor jest wywoływany tylko wtedy, gdy dane w obiekcie SerializationInfo zostały zdeserializowane przez program formatujący. Ogólnie rzecz biorąc, ten konstruktor powinien być protected , jeśli klasa nie sealedjest .

Nie można zagwarantować kolejności deserializacji obiektów. Jeśli na przykład jeden typ odwołuje się do typu, który nie został jeszcze zdeserializowany, wystąpi wyjątek. Jeśli tworzysz typy, które mają takie zależności, możesz obejść problem, implementując IDeserializationCallback interfejs i metodę OnDeserialization .

Architektura serializacji obsługuje typy obiektów, które rozszerzają MarshalByRefObject te same typy, co typy rozszerzające element Object. Te typy można oznaczyć za SerializableAttribute pomocą elementu i zaimplementować ISerializable interfejs jako dowolny inny typ obiektu. Ich stan obiektu zostanie przechwycony i utrwalone w strumieniu.

Gdy te typy są używane za pośrednictwem System.Runtime.Remotingprogramu , infrastruktura komunikacji zdalniej zapewnia surogatę, która poprzedza typową serializacji i zamiast tego serializuje serwer proxy do .MarshalByRefObject Surogat to pomocnik, który wie, jak serializować i deserializować obiekty określonego typu. Serwer proxy, niewidoczny dla użytkownika w większości przypadków, będzie mieć typ ObjRef.

Jako ogólny wzorzec projektowania nietypowe byłoby oznaczenie klasy atrybutem z możliwością serializacji i rozszerzenie MarshalByRefObjectklasy . Deweloperzy powinni dokładnie zastanowić się nad możliwymi scenariuszami serializacji i komunikacji zdalniej podczas łączenia tych dwóch cech. Jednym z przykładów, w których może to dotyczyć, jest użycie funkcji MemoryStream. Chociaż klasa bazowa MemoryStream (Stream) rozciąga się od MarshalByRefObjectklasy , można przechwycić stan obiektu MemoryStream i przywrócić go do woli. W związku z tym może to mieć znaczenie dla serializacji stanu tego strumienia do bazy danych i przywrócenia go w późniejszym czasie. Jednak w przypadku komunikacji zdalniej obiekt tego typu byłby proporcjonalny.

Aby uzyskać więcej informacji na temat serializacji klas rozszerzających MarshalByRefObjectprogram , zobacz RemotingSurrogateSelector. Aby uzyskać więcej informacji na temat implementowania ISerializableprogramu , zobacz Custom Serialization (Serializacja niestandardowa).

Uwagi dotyczące implementowania

Zaimplementuj ten interfejs, aby umożliwić obiektowi udział we własnej serializacji i deserializacji.

Metody

GetObjectData(SerializationInfo, StreamingContext)

Wypełnia element SerializationInfo danymi wymaganymi do serializacji obiektu docelowego.

Dotyczy

Zobacz też