SoapFormatter Класс

Определение

Сериализует и десериализует объект или весь граф связанных объектов в формате SOAP.

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
Наследование
SoapFormatter
Реализации

Примеры

#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, этот класс является устаревшим.

Предупреждение

BinaryFormatter является небезопасным и не может быть обеспечена безопасным. Дополнительные сведения см. в разделе BinaryFormatter Security Guide.

SoapFormatterКлассы и BinaryFormatter реализуют IRemotingFormatter интерфейс для поддержки вызовов удаленных процедур (RPC) и IFormatter интерфейс (наследуется IRemotingFormatter ) для поддержки сериализации графа объектов. SoapFormatterКласс также поддерживает вызовы RPC с ISoapMessage объектами без использования IRemotingFormatter функциональности.

Во время вызовов RPC IRemotingFormatter интерфейс позволяет определить два отдельных графа объектов: диаграмму объектов для сериализации и дополнительный граф, содержащий массив объектов заголовков, который передает сведения об удаленном вызове функции (например, идентификатор транзакции или сигнатура метода). Для правильной сериализации корневой объект первого графа должен быть объектом, реализующим IMethodCallMessage интерфейс или IMethodReturnMessage интерфейс.

Во время десериализации RPC в HeaderHandler метод модуля форматирования задается делегат Deserialize . Инфраструктура удаленного взаимодействия использует HeaderHandler делегат для создания объекта, поддерживающего ISerializable интерфейс. Этот объект содержит сведения, хранящиеся в заголовках, и получает корень графа, возвращенного десериализатором.

SoapFormatterТакже может выполнять обработку вызовов RPC, созданных с помощью объектов, реализующих ISoapMessage интерфейс. Чтобы создать RPC без использования IRemotingFormatter функциональности, поместите объект, который поддерживает ISoapMessage интерфейс, в корень сериализуемого графа. Для десериализации RPC, созданного таким образом, TopObject свойству необходимо задать другой объект, который поддерживает ISoapMessage интерфейс, и содержит соответствующие сведения об удаленном вызове.

Сериализация TimeSpan

Объекты TimeSpan сериализуются согласно стандарту ISO 8601:1998 в разделе 5.5.3.2.1 "альтернативный".

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

Не SoapFormatter поддерживает совместимость с сериализацией между версиями платформа .NET Framework. Сериализация между типами версий 1,1 и 2,0 в платформе часто завершается сбоем. Для решения этой проблемы можно предпринять следующие действия:

  • Преобразование для использования BinaryFormatter , что обеспечивает совместимость между 1,1 и 2,0.

  • Преобразование существующих сохраненных данных в новый формат.

  • Преобразуйте всех поставщиков и потребителей сериализованных данных в версию 2,0.

  • Избегайте использования типов, измененных с 1,1 на 2,0.

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

SoapFormatter()

Инициализирует новый экземпляр класса SoapFormatter значениями свойств по умолчанию.

SoapFormatter(ISurrogateSelector, StreamingContext)

Инициализирует новый экземпляр класса SoapFormatter с заданными свойствами ISurrogateSelector и StreamingContext.

Свойства

AssemblyFormat

Получает или задает поведение десериализатора в части, касающейся поиска и загрузки сборок.

Binder

Получает или задает SerializationBinder, управляющий привязкой сериализованного объекта к типу.

Context

Получает или задает StreamingContext, используемый с SoapFormatter.

FilterLevel

Получает или задает TypeFilterLevel автоматической десериализации для удаленной инфраструктуры .NET Framework.

SurrogateSelector

Получает или задает SurrogateSelector, управляющий подстановкой типа при сериализации и десериализации.

TopObject

Получает или задает ISoapMessage, в которое десериализуется верхний объект SOAP.

TypeFormat

Получает или задает формат, в котором описания типов раскладываются в сериализованном потоке.

Методы

Deserialize(Stream)

Десериализует данные в предоставленный поток и воспроизводит граф объектов.

Deserialize(Stream, HeaderHandler)

Десериализует поток в граф объектов, при этом все заголовки в этом потоке обрабатываются заданным HeaderHandler.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.

(Унаследовано от Object)
GetHashCode()

Служит хэш-функцией по умолчанию.

(Унаследовано от Object)
GetType()

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

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.

(Унаследовано от Object)
Serialize(Stream, Object)

Сериализует объект или граф объектов с указанным корнем в заданный поток Stream.

Serialize(Stream, Object, Header[])

Сериализует объект или граф объектов с указанным корнем в заданный поток Stream в формате RPC (удаленный вызов процедур) протокола SOAP.

ToString()

Возвращает строку, представляющую текущий объект.

(Унаследовано от Object)

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