ISerializable ISerializable ISerializable ISerializable Interface

Definizione

Consente a un oggetto di controllare la propria serializzazione e deserializzazione.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
Derivato
Attributi

Esempi

Esempio di codice seguente viene illustrato l'utilizzo del ISerializable interfaccia per definire il comportamento di serializzazione personalizzata per una classe.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

Commenti

Qualsiasi classe che potrebbe essere serializzati deve essere contrassegnati con il SerializableAttribute.Any class that might be serialized must be marked with the SerializableAttribute. Se una classe deve controllare il processo di serializzazione, è possibile implementare il ISerializable interfaccia.If a class needs to control its serialization process, it can implement the ISerializable interface. Il Formatter chiama il GetObjectData in fase di serializzazione e popola l'oggetto fornito SerializationInfo con tutti i dati necessari per rappresentare l'oggetto.The Formatter calls the GetObjectData at serialization time and populates the supplied SerializationInfo with all the data required to represent the object. Il Formatter crea un SerializationInfo con il tipo dell'oggetto nel grafico.The Formatter creates a SerializationInfo with the type of the object in the graph. Gli oggetti che devono inviare i proxy per se stessi possono utilizzare il FullTypeName e AssemblyName metodi su SerializationInfo per modificare le informazioni trasmesse.Objects that need to send proxies for themselves can use the FullTypeName and AssemblyName methods on SerializationInfo to change the transmitted information.

Nel caso di ereditarietà di classe, è possibile serializzare una classe che deriva da una classe di base che implementa ISerializable.In the case of class inheritance, it is possible to serialize a class that derives from a base class that implements ISerializable. In questo caso, la classe derivata deve chiamare l'implementazione della classe base GetObjectData all'interno dell'implementazione di GetObjectData.In this case, the derived class should call the base class implementation of GetObjectData inside its implementation of GetObjectData. In caso contrario, i dati dalla classe di base non essere serializzati.Otherwise, the data from the base class will not be serialized.

Il ISerializable interfaccia implica un costruttore con il costruttore di firma (SerializationInfo informazioni, StreamingContext contesto).The ISerializable interface implies a constructor with the signature constructor (SerializationInfo information, StreamingContext context). In fase di deserializzazione, il costruttore corrente viene chiamato solo dopo che i dati nel SerializationInfo è stato deserializzato dal formattatore.At deserialization time, the current constructor is called only after the data in the SerializationInfo has been deserialized by the formatter. In generale, questo costruttore deve essere protetti, se la classe non sealed.In general, this constructor should be protected if the class is not sealed.

Non è possibile garantire l'ordine in cui gli oggetti vengono deserializzati.The order in which objects are deserialized cannot be guaranteed. Ad esempio, se un tipo fa riferimento a un tipo che non è ancora stato deserializzato, verificherà un'eccezione.For example, if one type references a type that has not been deserialized yet, an exception will occur. Se si creano tipi dotati di queste dipendenze, è possibile risolvere il problema mediante l'implementazione di IDeserializationCallback interfaccia e OnDeserialization (metodo).If you are creating types that have such dependencies, you can work around the problem by implementing the IDeserializationCallback interface and the OnDeserialization method.

L'architettura della serializzazione gestisce i tipi di oggetti che estendono MarshalByRefObject quello utilizzato per i tipi che estendono Object.The serialization architecture handles object types that extend MarshalByRefObject the same as types that extend Object. Questi tipi possono essere contrassegnati con il SerializableAttribute e implementare il ISerializable interfaccia come qualsiasi altro tipo di oggetto.These types can be marked with the SerializableAttribute and implement the ISerializable interface as any other object type. Stato oggetto sarà acquisito e salvati in modo permanente nel flusso.Their object state will be captured and persisted onto the stream.

Quando vengono utilizzati questi tipi attraverso System.Runtime.Remoting, l'infrastruttura .NET remoting fornisce un surrogato che ha la precedenza sulla serializzazione tipici e invece serializza un proxy per il 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. Un surrogato è un helper che sa come serializzare e deserializzare gli oggetti di un determinato tipo.A surrogate is a helper that knows how to serialize and deserialize objects of a particular type. Il proxy, invisibile all'utente nella maggior parte dei casi, sarà di tipo ObjRef.The proxy, invisible to the user in most cases, will be of type ObjRef.

Come un modello di progettazione generale, sarebbe insolito per una classe di essere contrassegnato con l'attributo serializable ed estendere MarshalByRefObject.As a general design pattern, it would be unusual for a class to be both marked with the serializable attribute and extend MarshalByRefObject. Gli sviluppatori devono considerare con attenzione i possibili scenari di serializzazione e la comunicazione remota quando si combinano queste due caratteristiche.Developers should think carefully about the possible serialization and remoting scenarios when combining these two characteristics. È un esempio in cui potrebbe essere applicabile con un MemoryStream.One example where this might be applicable is with a MemoryStream. Quando la classe di base MemoryStream (Stream) si estende dal MarshalByRefObject, è possibile acquisire lo stato di un MemoryStream e ripristinarlo in base alle esigenze.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. Potrebbe, pertanto, essere significativa per serializzare lo stato del flusso in un database e ripristinarlo in un punto successivo nel tempo.It might, therefore, be meaningful to serialize the state of this stream into a database and restore it at some later point in time. Tuttavia, quando utilizzato tramite i servizi remoti, un oggetto di questo tipo sarebbe trasmessa tramite proxy.However, when used through remoting, an object of this type would be proxied.

Per altre informazioni sulla serializzazione di classi che estendono MarshalByRefObject, vedere RemotingSurrogateSelector.For more information about serialization of classes that extend MarshalByRefObject, see RemotingSurrogateSelector. Per altre informazioni sull'implementazione ISerializable, vedere serializzazione personalizzata.For more information about implementing ISerializable, see Custom Serialization.

Note per gli implementatori

Implementare questa interfaccia per consentire a un oggetto di partecipare alla propria serializzazione e deserializzazione.Implement this interface to allow an object to take part in its own serialization and deserialization.

Metodi

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

Popola un oggetto SerializationInfo con i dati necessari per serializzare l'oggetto di destinazione.Populates a SerializationInfo with the data needed to serialize the target object.

Si applica a

Vedi anche