SoapFormatter SoapFormatter SoapFormatter SoapFormatter Class

Определение

Сериализует и десериализует объект или весь граф связанных объектов в формате 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
Наследование
SoapFormatterSoapFormatterSoapFormatterSoapFormatter
Реализации

Примеры

#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

Комментарии

Примечание

Начиная с .NET Framework 2,0, этот класс является устаревшим.Beginning with the .NET Framework 2.0, this class is obsolete. Взамен рекомендуется использовать BinaryFormatter.Use BinaryFormatter instead.

IFormatter IRemotingFormatterКлассы SoapFormatter иBinaryFormatter реализуютIRemotingFormatter интерфейс для поддержки вызовов удаленных процедур (RPC) и интерфейс (наследуется) для поддержки сериализации графа объектов.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. Класс также поддерживает вызовы RPC с ISoapMessage IRemotingFormatter объектами без использования функциональности. SoapFormatterThe SoapFormatter class also supports RPCs with ISoapMessage objects, without using the IRemotingFormatter functionality.

Во время вызовов RPC IRemotingFormatter интерфейс позволяет определить два отдельных графа объектов: граф объектов для сериализации и дополнительный граф, содержащий массив объектов заголовков, передающий сведения об удаленном вызове функции (для пример, идентификатор транзакции или сигнатура метода).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). Для правильной сериализации корневой объект первого графа должен быть объектом, реализующим IMethodCallMessage интерфейс IMethodReturnMessage или интерфейс.For proper serialization, the root object of the first graph must be an object that implements either the IMethodCallMessage interface or the IMethodReturnMessage interface.

Во время десериализации RPC HeaderHandler в Deserialize метод модуля форматирования задается делегат.During deserialization of an RPC, a HeaderHandler delegate is specified to the Deserialize method of the formatter. Инфраструктура удаленного взаимодействия использует HeaderHandler делегат для создания объекта, ISerializable поддерживающего интерфейс.The remoting infrastructure uses the HeaderHandler delegate to produce an object that supports the ISerializable interface. Этот объект содержит сведения, хранящиеся в заголовках, и получает корень графа, возвращенного десериализатором.This object contains the information stored in the headers, and becomes the root of the graph returned by the deserializer.

Также может выполнять обработку вызовов RPC, созданных с помощью объектов, ISoapMessage реализующих интерфейс. SoapFormatterThe SoapFormatter can also handle RPCs that are produced with objects that implement the ISoapMessage interface. Чтобы создать RPC без использования IRemotingFormatter функциональности, поместите объект, который ISoapMessage поддерживает интерфейс, в корень сериализуемого графа.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. Для десериализации RPC, созданного таким образом TopObject , свойству необходимо задать другой объект, который ISoapMessage поддерживает интерфейс, и содержит соответствующие сведения об удаленном вызове.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.

Сериализация TimeSpanTimeSpan Serialization

Объекты TimeSpan сериализуются в соответствии с ISO 8601: 1998 раздел 5.5.3.2.1 "альтернативный" Standard.TimeSpan objects are serialized according to the ISO 8601: 1998 section 5.5.3.2.1 "Alternative" standard.

Сведения о версииVersion Information

SoapFormatter Не поддерживает совместимость с сериализацией между версиями .NET Framework.The SoapFormatter does not support serialization compatibility between versions of the .NET Framework. Сериализация между типами версий 1,1 и 2,0 в платформе часто завершается сбоем.Serialization between versions 1.1 and 2.0 types in the Framework often fails. Для решения этой проблемы можно предпринять следующие действия:The following actions can be taken to remedy this issue:

  • Преобразование для использования BinaryFormatter, что обеспечивает совместимость между 1,1 и 2,0.Convert to use the BinaryFormatter, which provides compatibility between 1.1 and 2.0.

  • Преобразование существующих сохраненных данных в новый формат.Convert existing persisted data to the new format.

  • Преобразуйте всех поставщиков и потребителей сериализованных данных в версию 2,0.Convert all producers and consumers of serialized data to version 2.0.

  • Избегайте использования типов, измененных с 1,1 на 2,0.Avoid using types that changed from 1.1 to 2.0.

Конструкторы

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

Инициализирует новый экземпляр класса SoapFormatter значениями свойств по умолчанию.Initializes a new instance of the SoapFormatter class with default property values.

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

Инициализирует новый экземпляр класса SoapFormatter с заданными свойствами ISurrogateSelector и StreamingContext.Initializes a new instance of the SoapFormatter class with the specified ISurrogateSelector and StreamingContext.

Свойства

AssemblyFormat AssemblyFormat AssemblyFormat AssemblyFormat

Получает или задает поведение десериализатора в части, касающейся поиска и загрузки сборок.Gets or sets the behavior of the deserializer with regards to finding and loading assemblies.

Binder Binder Binder Binder

Получает или задает SerializationBinder, управляющий привязкой сериализованного объекта к типу.Gets or sets the SerializationBinder that controls the binding of a serialized object to a type.

Context Context Context Context

Получает или задает StreamingContext, используемый с SoapFormatter.Gets or sets the StreamingContext used with this SoapFormatter.

FilterLevel FilterLevel FilterLevel FilterLevel

Получает или задает TypeFilterLevel автоматической десериализации для удаленной инфраструктуры .NET Framework.Gets or sets the TypeFilterLevel of automatic deserialization for .NET Framework remoting.

SurrogateSelector SurrogateSelector SurrogateSelector SurrogateSelector

Получает или задает SurrogateSelector, управляющий подстановкой типа при сериализации и десериализации.Gets or sets the SurrogateSelector that controls type substitution during serialization and deserialization.

TopObject TopObject TopObject TopObject

Получает или задает ISoapMessage, в которое десериализуется верхний объект SOAP.Gets or sets the ISoapMessage into which the SOAP top object is deserialized.

TypeFormat TypeFormat TypeFormat TypeFormat

Получает или задает формат, в котором описания типов раскладываются в сериализованном потоке.Gets or sets the format in which type descriptions are laid out in the serialized stream.

Методы

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

Десериализует данные в предоставленный поток и воспроизводит граф объектов.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)

Десериализует поток в граф объектов, при этом все заголовки в этом потоке обрабатываются заданным HeaderHandler.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)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

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

Служит хэш-функцией по умолчанию.Serves as the default hash function.

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

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

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

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

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

Сериализует объект или граф объектов с указанным корнем в заданный поток 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[])

Сериализует объект или граф объектов с указанным корнем в заданный поток Stream в формате RPC (удаленный вызов процедур) протокола 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() ToString() ToString() ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

Применяется к