ISerializable Interface

  • Référence

Définition

Espace de noms:
System.Runtime.Serialization
Assembly:
System.Runtime.dll
Assembly:
System.Runtime.Serialization.Formatters.dll
Assembly:
mscorlib.dll
Assembly:
netstandard.dll

Permet à un objet de contrôler sa propre sérialisation et désérialisation via la sérialisation binaire et XML.

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
Dérivé
Attributs
ComVisibleAttribute

Exemples

L’exemple de code suivant illustre l’utilisation de l’interface pour définir un ISerializable comportement de sérialisation binaire personnalisé pour une classe.

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

Remarques

Toute classe qui peut être sérialisée à l’aide de la sérialisation binaire ou XML doit être marquée avec le SerializableAttribute. Si une classe doit contrôler son processus de sérialisation binaire ou XML, elle peut implémenter l’interface ISerializable . Le Formatter appelle au moment de GetObjectData la sérialisation et remplit le fourni SerializationInfo avec toutes les données nécessaires pour représenter l’objet. Crée Formatter un SerializationInfo avec le type de l’objet dans le graphe. Les objets qui doivent envoyer des proxys pour eux-mêmes peuvent utiliser les FullTypeName méthodes et AssemblyName sur SerializationInfo pour modifier les informations transmises.

Dans le cas de l’héritage de classe, il est possible de sérialiser une classe qui dérive d’une classe de base qui implémente ISerializable. Dans ce cas, la classe dérivée doit appeler l’implémentation de la classe de base de à l’intérieur de GetObjectData son implémentation de GetObjectData. Sinon, les données de la classe de base ne seront pas sérialisées.

L’interface ISerializable implique un constructeur avec la signature constructor (SerializationInfo information, StreamingContext context). Au moment de la désérialisation, le constructeur actuel est appelé uniquement après que les données du SerializationInfo ont été désérialisées par le formateur. En général, ce constructeur doit être protected si la classe n’est pas sealed.

L’ordre dans lequel les objets sont désérialisés ne peut pas être garanti. Par exemple, si un type fait référence à un type qui n’a pas encore été désérialisé, une exception se produit. Si vous créez des types qui ont de telles dépendances, vous pouvez contourner le problème en implémentant l’interface IDeserializationCallback et la OnDeserialization méthode .

L’architecture de sérialisation gère les types d’objets qui s’étendent MarshalByRefObject de la même façon que les types qui étendent Object. Ces types peuvent être marqués avec et SerializableAttribute implémentent l’interface ISerializable comme n’importe quel autre type d’objet. Leur état d’objet est capturé et conservé dans le flux.

Lorsque ces types sont utilisés via System.Runtime.Remoting, l’infrastructure de communication à distance fournit un substitut qui préempte la sérialisation classique et sérialise à la place un proxy vers le MarshalByRefObject. Un substitut est une assistance qui sait sérialiser et désérialiser des objets d’un type particulier. Le proxy, invisible pour l’utilisateur dans la plupart des cas, sera de type ObjRef.

En tant que modèle de conception général, il serait inhabituel qu’une classe soit à la fois marquée avec l’attribut sérialisable et étendre MarshalByRefObject. Les développeurs doivent réfléchir soigneusement aux scénarios possibles de sérialisation et de communication à distance lors de la combinaison de ces deux caractéristiques. Un exemple où cela peut s’appliquer est avec un MemoryStream. Alors que la classe de base de MemoryStream (Stream) s’étend à partir de MarshalByRefObject, il est possible de capturer l’état d’un MemoryStream et de le restaurer à volonté. Il peut donc être utile de sérialiser l’état de ce flux dans une base de données et de le restaurer ultérieurement. Toutefois, lorsqu’il est utilisé par le biais de la communication à distance, un objet de ce type est proxié.

Pour plus d’informations sur la sérialisation des classes qui étendent MarshalByRefObject, consultez RemotingSurrogateSelector. Pour plus d’informations sur l’implémentation ISerializablede , consultez Sérialisation personnalisée.

Notes

Cette interface ne s’applique pas à la sérialisation JSON à l’aide de System.Text.Json.

Notes pour les responsables de l’implémentation

Implémentez cette interface pour permettre à un objet de participer à sa propre sérialisation et désérialisation.

Méthodes

GetObjectData(SerializationInfo, StreamingContext)

Remplit SerializationInfo avec les données nécessaires pour sérialiser l'objet cible.

S’applique à

Voir aussi