SoapFormatter SoapFormatter SoapFormatter SoapFormatter Class

Definition

Serialisiert und deserialisiert ein Objekt oder ein vollständiges Diagramm verbundener Objekte im SOAP-Format.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
Vererbung
SoapFormatterSoapFormatterSoapFormatterSoapFormatter
Implementiert

Beispiele

#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

Hinweise

Hinweis

Ab .NET Framework 2,0 ist diese Klasse veraltet.Beginning with the .NET Framework 2.0, this class is obsolete. Verwenden Sie stattdessen BinaryFormatter.Use BinaryFormatter instead.

Die SoapFormatter Klassen BinaryFormatter und implementieren die IRemotingFormatter -Schnittstelle zur Unterstützung von Remote Prozedur aufrufen (Remote Procedure IFormatter Calls IRemotingFormatter, RPCs) und die-Schnittstelle (geerbt von) zur Unterstützung der Serialisierung eines Diagramms von Objekten.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. Die SoapFormatter -Klasse unterstützt auch RPCs mit-Objekten, IRemotingFormatter ohne die-Funktionalität zu ISoapMessage verwenden.The SoapFormatter class also supports RPCs with ISoapMessage objects, without using the IRemotingFormatter functionality.

Bei RPCs ermöglicht die IRemotingFormatter -Schnittstelle die Angabe von zwei separaten Objekt Diagrammen: das Diagramm der zu serialisierenden Objekte und ein zusätzliches Diagramm, das ein Array von Header Objekten enthält, die Informationen über den Remote Funktionsaufruf übermitteln (für Beispiel, Transaktions-ID oder eine Methoden Signatur).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). Bei einer ordnungsgemäßen Serialisierung muss das Stamm Objekt des ersten Diagramms ein Objekt sein, das entweder IMethodCallMessage die-Schnitt IMethodReturnMessage Stelle oder die-Schnittstelle implementiert.For proper serialization, the root object of the first graph must be an object that implements either the IMethodCallMessage interface or the IMethodReturnMessage interface.

Während der Deserialisierung eines RPC wird ein HeaderHandler Delegat für die Deserialize -Methode des Formatierers angegeben.During deserialization of an RPC, a HeaderHandler delegate is specified to the Deserialize method of the formatter. Die Remoting-Infrastruktur verwendet HeaderHandler den-Delegaten zum Entwickeln eines Objekts ISerializable , das die-Schnittstelle unterstützt.The remoting infrastructure uses the HeaderHandler delegate to produce an object that supports the ISerializable interface. Dieses Objekt enthält die in den Headern gespeicherten Informationen und wird zum Stamm des vom Deserialisierungsprogramm zurückgegebenen Diagramms.This object contains the information stored in the headers, and becomes the root of the graph returned by the deserializer.

Der SoapFormatter kann auch RPCs verarbeiten, die mit Objekten erstellt werden, die ISoapMessage die-Schnittstelle implementieren.The SoapFormatter can also handle RPCs that are produced with objects that implement the ISoapMessage interface. Um einen RPC ohne Verwendung der IRemotingFormatter -Funktion zu erstellen, platzieren Sie ein Objekt, das die ISoapMessage -Schnittstelle unterstützt, im Stamm eines zu serialisierenden Diagramms.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. Zum Deserialisieren eines auf diese Weise erstellten RPC muss TopObject die-Eigenschaft auf ein anderes Objekt festgelegt werden ISoapMessage , das die-Schnittstelle unterstützt, und enthält die relevanten Remote Aufruf Informationen.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.

TimeSpan-SerialisierungTimeSpan Serialization

TimeSpan-Objekte werden gemäß ISO 8601 serialisiert: 1998 section 5.5.3.2.1 "Alternative" Standard.TimeSpan objects are serialized according to the ISO 8601: 1998 section 5.5.3.2.1 "Alternative" standard.

VersionsinformationenVersion Information

Unter SoapFormatter stützt die Serialisierungskompatibilität zwischen den Versionen der .NET Framework nicht.The SoapFormatter does not support serialization compatibility between versions of the .NET Framework. Die Serialisierung zwischen den Typen 1,1 und 2,0 im Framework schlägt häufig fehl.Serialization between versions 1.1 and 2.0 types in the Framework often fails. Die folgenden Aktionen können ausgeführt werden, um dieses Problem zu beheben:The following actions can be taken to remedy this issue:

  • Konvertieren Sie, um BinaryFormatterden zu verwenden, der die Kompatibilität zwischen 1,1 und 2,0 bereitstellt.Convert to use the BinaryFormatter, which provides compatibility between 1.1 and 2.0.

  • Konvertieren Sie vorhandene persistente Daten in das neue Format.Convert existing persisted data to the new format.

  • Konvertieren Sie alle Producer und Consumer der serialisierten Daten in Version 2,0.Convert all producers and consumers of serialized data to version 2.0.

  • Vermeiden Sie die Verwendung von Typen, die von 1,1 zu 2,0 geändert wurden.Avoid using types that changed from 1.1 to 2.0.

Konstruktoren

SoapFormatter() SoapFormatter() SoapFormatter() SoapFormatter()

Initialisiert eine neue Instanz der SoapFormatter-Klasse mit Standardeigenschaftswerten.Initializes a new instance of the SoapFormatter class with default property values.

SoapFormatter(ISurrogateSelector, StreamingContext) SoapFormatter(ISurrogateSelector, StreamingContext) SoapFormatter(ISurrogateSelector, StreamingContext) SoapFormatter(ISurrogateSelector, StreamingContext)

Initialisiert eine neue Instanz der SoapFormatter-Klasse mit den angegebenen ISurrogateSelector und dem angegebenen StreamingContext.Initializes a new instance of the SoapFormatter class with the specified ISurrogateSelector and StreamingContext.

Eigenschaften

AssemblyFormat AssemblyFormat AssemblyFormat AssemblyFormat

Ruft das Verhalten des Deserialisierungsprogramms bezüglich des Suchens und Ladens von Assemblys ab oder legt dieses fest.Gets or sets the behavior of the deserializer with regards to finding and loading assemblies.

Binder Binder Binder Binder

Ruft den SerializationBinder ab, der die Bindung eines serialisierten Objekts an einen Typ steuert, oder legt diesen fest.Gets or sets the SerializationBinder that controls the binding of a serialized object to a type.

Context Context Context Context

Ruft den StreamingContext ab, der mit diesem SoapFormatter verwendet wird, oder legt diesen fest.Gets or sets the StreamingContext used with this SoapFormatter.

FilterLevel FilterLevel FilterLevel FilterLevel

Ruft das TypeFilterLevel der automatischen Deserialisierung für .NET Framework Remoting ab oder legt dieses fest.Gets or sets the TypeFilterLevel of automatic deserialization for .NET Framework remoting.

SurrogateSelector SurrogateSelector SurrogateSelector SurrogateSelector

Ruft den SurrogateSelector ab, der die Typersetzung während der Serialisierung und Deserialisierung steuert, oder legt diesen fest.Gets or sets the SurrogateSelector that controls type substitution during serialization and deserialization.

TopObject TopObject TopObject TopObject

Ruft die ISoapMessage ab, in die das oberste SOAP-Objekt deserialisiert wird, oder legt diese fest.Gets or sets the ISoapMessage into which the SOAP top object is deserialized.

TypeFormat TypeFormat TypeFormat TypeFormat

Ruft das Format für das Layout von Typbeschreibungen im serialisierten Stream ab oder legt dieses fest.Gets or sets the format in which type descriptions are laid out in the serialized stream.

Methoden

Deserialize(Stream) Deserialize(Stream) Deserialize(Stream) Deserialize(Stream)

Deserialisiert die Daten im bereitgestellten Stream und stellt das Diagramm von Objekten wieder her.Deserializes the data on the provided stream and reconstitutes the graph of objects.

Deserialize(Stream, HeaderHandler) Deserialize(Stream, HeaderHandler) Deserialize(Stream, HeaderHandler) Deserialize(Stream, HeaderHandler)

Deserialisiert den Stream in ein Objektdiagramm, wobei sämtliche Header im betreffenden Stream durch den angegebenen HeaderHandler behandelt werden.Deserializes the stream into an object graph with any headers in that stream being handled by the given HeaderHandler.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Bestimmt, ob das angegebene Objekt mit dem aktuellen Objekt identisch ist.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Fungiert als Standardhashfunktion.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Inherited from Object)
Serialize(Stream, Object) Serialize(Stream, Object) Serialize(Stream, Object) Serialize(Stream, Object)

Serialisiert ein Objekt oder ein Objektdiagramm mit dem angegebenen Stamm in den angegebenen Stream.Serializes an object or graph of objects with the specified root to the given Stream.

Serialize(Stream, Object, Header[]) Serialize(Stream, Object, Header[]) Serialize(Stream, Object, Header[]) Serialize(Stream, Object, Header[])

Serialisiert ein Objekt oder ein Objektdiagramm mit dem angegeben Stammobjekt im SOAP-RPC-Format (Remote Procedure Call, Remoteprozeduraufruf) in den angegebenen Stream.Serializes an object or graph of objects with the specified root to the given Stream in the SOAP Remote Procedure Call (RPC) format.

ToString() ToString() ToString() ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Inherited from Object)

Gilt für: