SoapFormatter Clase

Definición

Serializa o deserializa un objeto o todo un gráfico de objetos conectados, en formato SOAP.Serializes and deserializes an object, or an entire graph of connected objects, in SOAP format.

public ref class SoapFormatter sealed : System::Runtime::Remoting::Messaging::IRemotingFormatter
public sealed class SoapFormatter : System.Runtime.Remoting.Messaging.IRemotingFormatter
type SoapFormatter = class
    interface IRemotingFormatter
    interface IFormatter
Public NotInheritable Class SoapFormatter
Implements IRemotingFormatter
Herencia
SoapFormatter
Implementaciones

Ejemplos

#using <system.dll>
#using <system.runtime.serialization.formatters.soap.dll>

using namespace System;
using namespace System::IO;
using namespace System::Collections;
using namespace System::Runtime::Serialization;
using namespace System::Runtime::Serialization::Formatters::Soap;
void Serialize()
{
   
   // Create a hashtable of values that will eventually be serialized.
   Hashtable^ addresses = gcnew Hashtable;
   addresses->Add( "Jeff", "123 Main Street, Redmond, WA 98052" );
   addresses->Add( "Fred", "987 Pine Road, Phila., PA 19116" );
   addresses->Add( "Mary", "PO Box 112233, Palo Alto, CA 94301" );
   
   // To serialize the hashtable (and its keys/values), 
   // you must first open a stream for writing.
   // We will use a file stream here.
   FileStream^ fs = gcnew FileStream( "DataFile.soap",FileMode::Create );
   
   // Construct a SoapFormatter and use it 
   // to serialize the data to the stream.
   SoapFormatter^ formatter = gcnew SoapFormatter;
   try
   {
      formatter->Serialize( fs, addresses );
   }
   catch ( SerializationException^ e ) 
   {
      Console::WriteLine( "Failed to serialize. Reason: {0}", e->Message );
      throw;
   }
   finally
   {
      fs->Close();
   }

}

void Deserialize()
{
   
   // Declare the hashtable reference.
   Hashtable^ addresses = nullptr;
   
   // Open the file containing the data that we want to deserialize.
   FileStream^ fs = gcnew FileStream( "DataFile.soap",FileMode::Open );
   try
   {
      SoapFormatter^ formatter = gcnew SoapFormatter;
      
      // Deserialize the hashtable from the file and 
      // assign the reference to our local variable.
      addresses = dynamic_cast<Hashtable^>(formatter->Deserialize( fs ));
   }
   catch ( SerializationException^ e ) 
   {
      Console::WriteLine( "Failed to deserialize. Reason: {0}", e->Message );
      throw;
   }
   finally
   {
      fs->Close();
   }

   
   // To prove that the table deserialized correctly, 
   // display the keys/values to the console.
   IEnumerator^ myEnum = addresses->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      DictionaryEntry^ de = safe_cast<DictionaryEntry^>(myEnum->Current);
      Console::WriteLine( " {0} lives at {1}.", de->Key, de->Value );
   }
}


[STAThread]
int main()
{
   Serialize();
   Deserialize();
}

using System;
using System.IO;
using System.Collections;
using System.Runtime.Serialization;

// Note: When building this code, you must reference the
// System.Runtime.Serialization.Formatters.Soap.dll assembly.
using System.Runtime.Serialization.Formatters.Soap;


class App 
{
    [STAThread]
    static void Main() 
    {
        Serialize();
        Deserialize();
    }

    static void Serialize() 
    {
        // Create a hashtable of values that will eventually be serialized.
        Hashtable addresses = new Hashtable();
        addresses.Add("Jeff", "123 Main Street, Redmond, WA 98052");
        addresses.Add("Fred", "987 Pine Road, Phila., PA 19116");
        addresses.Add("Mary", "PO Box 112233, Palo Alto, CA 94301");

        // To serialize the hashtable (and its key/value pairs), 
        // you must first open a stream for writing.
        // Use a file stream here.
        FileStream fs = new FileStream("DataFile.soap", FileMode.Create);

        // Construct a SoapFormatter and use it 
        // to serialize the data to the stream.
        SoapFormatter formatter = new SoapFormatter();
        try 
        {
            formatter.Serialize(fs, addresses);
        }
        catch (SerializationException e) 
        {
            Console.WriteLine("Failed to serialize. Reason: " + e.Message);
            throw;
        }
        finally 
        {
            fs.Close();
        }
    }

   
    static void Deserialize() 
    {
        // Declare the hashtable reference.
        Hashtable addresses  = null;

        // Open the file containing the data that you want to deserialize.
        FileStream fs = new FileStream("DataFile.soap", FileMode.Open);
        try 
        {
            SoapFormatter formatter = new SoapFormatter();

            // Deserialize the hashtable from the file and 
            // assign the reference to the local variable.
            addresses = (Hashtable) formatter.Deserialize(fs);
        }
        catch (SerializationException e) 
        {
            Console.WriteLine("Failed to deserialize. Reason: " + e.Message);
            throw;
        }
        finally 
        {
            fs.Close();
        }

        // To prove that the table deserialized correctly, 
        // display the key/value pairs to the console.
        foreach (DictionaryEntry de in addresses) 
        {
            Console.WriteLine("{0} lives at {1}.", de.Key, de.Value);
        }
    }
}
Imports System.IO
Imports System.Collections
Imports System.Runtime.Serialization

' Note: When building this code, you must reference the
' System.Runtime.Serialization.Formatters.Soap.dll assembly.
Imports System.Runtime.Serialization.Formatters.Soap


Module App

   Sub Main()
      Serialize()
      Deserialize()
   End Sub

   Sub Serialize()
      ' Create a hashtable of values that will eventually be serialized.
      Dim addresses As New Hashtable
      addresses.Add("Jeff", "123 Main Street, Redmond, WA 98052")
      addresses.Add("Fred", "987 Pine Road, Phila., PA 19116")
      addresses.Add("Mary", "PO Box 112233, Palo Alto, CA 94301")

      ' To serialize the hashtable (and its key/value pairs), 
      ' you must first open a stream for writing.
      ' Use a file stream here.
      Dim fs As New FileStream("DataFile.soap", FileMode.Create)

      ' Construct a SoapFormatter and use it 
      ' to serialize the data to the stream.
      Dim formatter As New SoapFormatter
      Try
         formatter.Serialize(fs, addresses)
      Catch e As SerializationException
         Console.WriteLine("Failed to serialize. Reason: " & e.Message)
         Throw
      Finally
         fs.Close()
      End Try
   End Sub


   Sub Deserialize()
      ' Declare the hashtable reference.
      Dim addresses As Hashtable = Nothing

      ' Open the file containing the data that you want to deserialize.
      Dim fs As New FileStream("DataFile.soap", FileMode.Open)
      Try
         Dim formatter As New SoapFormatter

         ' Deserialize the hashtable from the file and 
         ' assign the reference to the local variable.
         addresses = DirectCast(formatter.Deserialize(fs), Hashtable)
      Catch e As SerializationException
         Console.WriteLine("Failed to deserialize. Reason: " & e.Message)
         Throw
      Finally
         fs.Close()
      End Try

      ' To prove that the table deserialized correctly, 
      ' display the key/value pairs to the console.
      Dim de As DictionaryEntry
      For Each de In addresses
         Console.WriteLine("{0} lives at {1}.", de.Key, de.Value)
      Next
   End Sub
End Module

Comentarios

Nota

A partir de la .NET Framework 2,0, esta clase está obsoleta.Beginning with the .NET Framework 2.0, this class is obsolete. Utilice BinaryFormatter en su lugar.Use BinaryFormatter instead.

Las SoapFormatter clases BinaryFormatter y implementan IRemotingFormatter la interfaz para admitir llamadas a procedimientos remotos (RPC) IFormatter y la interfaz (heredada por IRemotingFormatter) para admitir la serialización de un gráfico de objetos.The SoapFormatter and BinaryFormatter classes implement the IRemotingFormatter interface to support remote procedure calls (RPCs), and the IFormatter interface (inherited by the IRemotingFormatter) to support serialization of a graph of objects. La SoapFormatter clase también admite RPC con ISoapMessage objetos, sin usar la IRemotingFormatter funcionalidad.The SoapFormatter class also supports RPCs with ISoapMessage objects, without using the IRemotingFormatter functionality.

Durante las RPC, IRemotingFormatter la interfaz permite la especificación de dos gráficos de objetos independientes: el gráfico de objetos que se van a serializar y un gráfico adicional que contiene una matriz de objetos de encabezado que transmiten información sobre la llamada de función remota (para ejemplo, ID. de transacción o firma de método).During RPCs, the IRemotingFormatter interface allows the specification of two separate object graphs: the graph of objects to serialize, and an additional graph that contains an array of header objects that convey information about the remote function call (for example, transaction ID or a method signature). Para una serialización correcta, el objeto raíz del primer gráfico debe ser un objeto que implemente la IMethodCallMessage interfaz o la IMethodReturnMessage interfaz.For proper serialization, the root object of the first graph must be an object that implements either the IMethodCallMessage interface or the IMethodReturnMessage interface.

Durante la deserialización de una RPC, HeaderHandler se especifica un delegado para Deserialize el método del formateador.During deserialization of an RPC, a HeaderHandler delegate is specified to the Deserialize method of the formatter. La infraestructura de comunicación remota HeaderHandler usa el delegado para generar un objeto que ISerializable admita la interfaz.The remoting infrastructure uses the HeaderHandler delegate to produce an object that supports the ISerializable interface. Este objeto contiene la información almacenada en los encabezados y se convierte en la raíz del gráfico devuelto por el deserializador.This object contains the information stored in the headers, and becomes the root of the graph returned by the deserializer.

También SoapFormatter puede controlar las RPC que se producen con los objetos que implementan la ISoapMessage interfaz.The SoapFormatter can also handle RPCs that are produced with objects that implement the ISoapMessage interface. Para crear una RPC sin usar la IRemotingFormatter funcionalidad, coloque un objeto que admita la ISoapMessage interfaz en la raíz de un gráfico que se está serializando.To create an RPC without using the IRemotingFormatter functionality, place an object that supports the ISoapMessage interface at the root of a graph being serialized. Para deserializar un RPC creado de esta manera, TopObject la propiedad debe establecerse en otro objeto que admita ISoapMessage la interfaz y que contenga la información de la llamada remota pertinente.To deserialize an RPC created in this manner the TopObject property must be set to another object that supports the ISoapMessage interface, and contains the relevant remote call information.

Serialización de TimeSpanTimeSpan Serialization

Los objetos TimeSpan se serializan según la norma ISO 8601: 1998 sección 5.5.3.2.1 "alternativa".TimeSpan objects are serialized according to the ISO 8601: 1998 section 5.5.3.2.1 "Alternative" standard.

Información de versiónVersion Information

No SoapFormatter admite la compatibilidad de serialización entre versiones del .NET Framework.The SoapFormatter does not support serialization compatibility between versions of the .NET Framework. A menudo, se produce un error en la serialización entre los tipos 1,1 y 2,0 del marco.Serialization between versions 1.1 and 2.0 types in the Framework often fails. Se pueden realizar las siguientes acciones para solucionar este problema:The following actions can be taken to remedy this issue:

  • Convierta para usar BinaryFormatter, que proporciona compatibilidad entre 1,1 y 2,0.Convert to use the BinaryFormatter, which provides compatibility between 1.1 and 2.0.

  • Convierta los datos persistentes existentes al nuevo formato.Convert existing persisted data to the new format.

  • Convierta todos los productores y consumidores de datos serializados a la versión 2,0.Convert all producers and consumers of serialized data to version 2.0.

  • Evite el uso de tipos que han cambiado de 1,1 a 2,0.Avoid using types that changed from 1.1 to 2.0.

Constructores

SoapFormatter()

Inicializa una nueva instancia de la clase SoapFormatter con los valores de propiedad predeterminados.Initializes a new instance of the SoapFormatter class with default property values.

SoapFormatter(ISurrogateSelector, StreamingContext)

Inicializa una nueva instancia de la clase SoapFormatter con los parámetros ISurrogateSelector y StreamingContext especificados.Initializes a new instance of the SoapFormatter class with the specified ISurrogateSelector and StreamingContext.

Propiedades

AssemblyFormat

Obtiene o establece el comportamiento del deserializador en lo que respecta a buscar y cargar ensamblados.Gets or sets the behavior of the deserializer with regards to finding and loading assemblies.

Binder

Obtiene o establece el SerializationBinder que controla el enlace entre un objeto serializado y un tipo.Gets or sets the SerializationBinder that controls the binding of a serialized object to a type.

Context

Obtiene o establece el StreamingContext utilizado con este SoapFormatter.Gets or sets the StreamingContext used with this SoapFormatter.

FilterLevel

Obtiene o establece la enumeración TypeFilterLevel de deserialización automática para la comunicación remota de .NET Framework.Gets or sets the TypeFilterLevel of automatic deserialization for .NET Framework remoting.

SurrogateSelector

Obtiene o establece el SurrogateSelector que controla la sustitución de tipos durante el proceso de serialización y deserialización.Gets or sets the SurrogateSelector that controls type substitution during serialization and deserialization.

TopObject

Obtiene o establece ISoapMessage donde se deserializa el objeto SOAP superior.Gets or sets the ISoapMessage into which the SOAP top object is deserialized.

TypeFormat

Obtiene o establece el formato en que se distribuyen las descripciones de tipos en la secuencia serializada.Gets or sets the format in which type descriptions are laid out in the serialized stream.

Métodos

Deserialize(Stream)

Deserializa los datos de la secuencia suministrada y reconstituye el gráfico de objetos.Deserializes the data on the provided stream and reconstitutes the graph of objects.

Deserialize(Stream, HeaderHandler)

Deserializa la secuencia a un gráfico de objetos; el HeaderHandler especificado se encarga de controlar los encabezados que aparecen en la secuencia.Deserializes the stream into an object graph with any headers in that stream being handled by the given HeaderHandler.

Equals(Object)

Determina si el objeto especificado es igual al objeto actual.Determines whether the specified object is equal to the current object.

(Heredado de Object)
GetHashCode()

Sirve como función hash predeterminada.Serves as the default hash function.

(Heredado de Object)
GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Heredado de Object)
MemberwiseClone()

Crea una copia superficial del Object actual.Creates a shallow copy of the current Object.

(Heredado de Object)
Serialize(Stream, Object)

Serializa un objeto o gráfico de objetos con el objeto superior (raíz) especificado al Stream indicado.Serializes an object or graph of objects with the specified root to the given Stream.

Serialize(Stream, Object, Header[])

Serializa un objeto o un gráfico de objetos con la raíz especificada en el Stream especificado en formato RPC (llamada a procedimiento remoto) SOAP.Serializes an object or graph of objects with the specified root to the given Stream in the SOAP Remote Procedure Call (RPC) format.

ToString()

Devuelve un valor de tipo string que representa el objeto actual.Returns a string that represents the current object.

(Heredado de Object)

Se aplica a