SoapFormatter クラス

[アーティクル]
03/28/2008

オブジェクト、または連結された複数のオブジェクトから成るグラフ全体を、SOAP 形式でシリアル化および逆シリアル化します。

この型のすべてのメンバの一覧については、SoapFormatter メンバを参照してください。

System.Object
System.Runtime.Serialization.Formatters.Soap.SoapFormatter

NotInheritable Public Class SoapFormatter
   Implements IRemotingFormatter, IFormatter
[C#]
public sealed class SoapFormatter : IRemotingFormatter, IFormatter
[C++]
public __gc __sealed class SoapFormatter : public
   IRemotingFormatter, IFormatter
[JScript]
public class SoapFormatter implements IRemotingFormatter,
   IFormatter

スレッドセーフ

この型の public static (Visual Basicでは Shared) のすべてのメンバは、マルチスレッド操作で安全に使用できます。インスタンスのメンバの場合は、スレッドセーフであるとは限りません。

解説

SoapFormatter クラスおよび BinaryFormatter クラスは、 IRemotingFormatter インターフェイスを実装してリモートプロシージャコール (RPC: Remote Procedure Call) をサポートし、 IFormatter インターフェイス (IRemotingFormatter によって継承される) を実装してオブジェクトグラフのシリアル化をサポートしています。 SoapFormatter クラスは ISoapMessage オブジェクトを使用した RPC もサポートしますが、この場合は IRemotingFormatter 機能は使用しません。

IRemotingFormatter インターフェイスでは、RPC 時に、シリアル化するオブジェクトのグラフと、リモート関数呼び出しに関する情報 (トランザクション ID やメソッドシグネチャなど) を伝達するヘッダーオブジェクトの配列を格納する追加のグラフという、2 つの別個のグラフを指定できます。シリアル化を適切に実行するには、最初のグラフのルートオブジェクトを IMethodCallMessage インターフェイスまたは IMethodReturnMessage インターフェイスを実装するオブジェクトにする必要があります。

RPC の逆シリアル化時には、 HeaderHandler デリゲートがフォーマッタの Deserialize メソッドに対して指定されます。リモート処理インフラストラクチャは、 HeaderHandler デリゲートを使用して、 ISerializable インターフェイスをサポートするオブジェクトを生成します。このオブジェクトは、ヘッダーに格納されている情報を保持し、デシリアライザによって返されるグラフのルートになります。

SoapFormatter は、 ISoapMessage インターフェイスを実装しているオブジェクトを使用して生成された RPC も処理できます。 IRemotingFormatter 機能を使用せずに RPC を作成するには、 ISoapMessage インターフェイスをサポートするオブジェクトを、シリアル化されるグラフのルートに配置します。この方法で作成した RPC を逆シリアル化するには、 ISoapMessage インターフェイスをサポートし、関連するリモート呼び出し情報を格納した別のオブジェクトを TopObject プロパティに指定する必要があります。

使用例

 
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

[C#] 
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);
        }
    }
}

[C++] 
#using <mscorlib.dll>
#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 = new Hashtable();
   addresses->Add(S"Jeff", S"123 Main Street, Redmond, WA 98052");
   addresses->Add(S"Fred", S"987 Pine Road, Phila., PA 19116");
   addresses->Add(S"Mary", S"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 = new FileStream(S"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(S"Failed to serialize. Reason: {0}", e->Message);
      throw;
   }
   __finally 
   {
      fs->Close();
   }
}

void Deserialize() 
{
   // Declare the hashtable reference.
   Hashtable* addresses = 0;

   // Open the file containing the data that we want to deserialize.
   FileStream* fs = new FileStream(S"DataFile.soap", FileMode::Open);
   try 
   {
      SoapFormatter* formatter = new 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(S"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 = __try_cast<DictionaryEntry*>(myEnum->Current);
      Console::WriteLine(S" {0} lives at {1}.", de->Key, de->Value);
   }
}

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

[JScript] JScript のサンプルはありません。Visual Basic、C#、および C++ のサンプルを表示するには、このページの左上隅にある言語のフィルタボタンをクリックします。

必要条件

名前空間: System.Runtime.Serialization.Formatters.Soap

プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ

アセンブリ: System.Runtime.Serialization.Formatters.Soap (System.Runtime.Serialization.Formatters.Soap.dll 内)

参照

SoapFormatter メンバ | System.Runtime.Serialization.Formatters.Soap 名前空間

次の方法で共有

SoapFormatter クラス

スレッドセーフ

解説

使用例

必要条件

参照

その他のリソース