SOAP通信のサンプルをご紹介（ASP.NET Web Service＝ASMXを使ったHelloWorld）

投稿日：2021年8月21日更新日：2021年8月22日

＜目次＞

(１) SOAP通信のサンプルをご紹介（ASP.NET Web Service＝ASMXを使ったHelloWorld）
　(１-１) SOAP通信とは？
　(１-２) SOAP通信のサンプルの概要
　 (１-３) SOAP通信のサンプル作成手順

(１) SOAP通信のサンプルをご紹介（ASP.NET Web Service＝ASMXを使ったHelloWorld）

(１-１) SOAP通信とは？

別記事にて纏めていますので、そちらをご参照頂けたらと思います。
⇒（参考）SOAP通信の仕組みやHTTPプロトコルとの違いなど

＞目次にもどる

(１-２) SOAP通信のサンプルの概要

「SOAP通信とは？」で紹介しているSOAP通信の概要記事でもご紹介した通り、SOAPの代表的な用途としては（図１１１）のように、Webサービスを提供するサーバとそのクライアント間のXML通信などが用途として挙げられます。

流れとしては、クライアント側（例：Webサービスを利用するC#モジュール）ではSOAPプロトコルに準拠したXMLをHTTPリクエストに乗せて送ります。サーバ側はそのリクエストを受け取り、要求されたエンドポイントの処理を行い、その結果を再びXML形式で返却する（レスポンス）ような流れです。

（図１１１）

今回はSOAP通信のイメージを掴むための簡単なサンプルとして、（図１１１）でいう所の「サーバ」側のWebサービスを作ります。

SOAP型式で通信をする簡単なWebサービス（ASP.NET Web Service＝ASMX）を作ってSOAPの通信（XML）で応答が返ってくる様子を見ていきます。「ASP.NET Web Service」はVisual Studioを使って非常に簡単に作る事ができますので、以降で手順をご紹介します。

ちなみに、今回作成するASP.NET Web Service（ASMX）はSOAPプロトコルのV1.1とV1.2をサポートしています。

＞目次にもどる

(１-３) SOAP通信のサンプル作成手順

●STEP1：空のASP.NET Webアプリケーションプロジェクトの作成

まずはWebサービス（ASMX）の入れ物となる空のプロジェクトを作ります。

・①Visual Studioで「ファイル」⇒「新規作成」⇒「プロジェクト」と選択

（図１１１）①

↓

・②テンプレートは「ASP.NET Webアプリケーション（.NET Framework）を選択

（図１２１）②

↓

・③プロジェクトの「名前」や「保存場所」を設定して「作成」押下

（図１２１）③

↓

・④「空」を選択して「作成」押下

（図１２１）④

↓

・⑤作成完了

（図１２１）⑤

●STEP2：ASMX（Webサービス）の追加

次に今回のメインとなるASMX（Webサービス）を追加します。

・①プロジェクトを右クリック⇒「追加」⇒「新規」を押下

（図１２２）①

↓

・②左のツリーから「Web」を選択し、出てきた選択肢から「Webサービス（ASMX）」を選択して「追加」

（図１２２）②

↓

・③追加完了

追加完了するとソリューションエクスプローラー上に表示されます。

（図１２３）①

・[WebService(Namespace=”http://XXXXX/”)]に表示されているURLが、今回のWebサービスのURLです。
（図１２２）③

●STEP3：ASMX（Webサービス）の実行

今回はすぐに結果を見られるよう、簡易的にIIS Express上で実行します。

・①「IIS Express」を押下します。

（図１２３）①

↓

・②サービスの一覧画面が表示されるので、デフォルトで作成されている「Hello World」をクリックします。

（図１２３）②

（補足）

このサービスの定義や処理は「XXXX.asmx.cs」（XXXXはご自身のWebサービスの名前）の中で定義されています。

（図１２４）

（表）

記述	意味
public class WebService1 : System.Web.Services.WebService	Webメソッドをカプセル化するクラスです。通常、クラスファイルがWebサービスの機能のカプセル化の役割を果たしています。
[WebMethod]	メソッドに付与する属性です。この[WebMethod]属性を付与する事で、クライアントアプリケーションから確実に呼び出せるようにします。
public string HelloWorld() { return “Hello World”; }	このメソッドの中で、Webサービスの処理の内容を記述しています。この例では文字列「”Hello World”」をクライアントに対して返却します。

・③Webサービスに対してリクエストを送る

通常、この手順はWebサービスを使いたいクライアントから行いますが（例：外部のC#プログラム等からSOAP準拠のHTTPリクエストを送る）、今回は簡易的にASMX（Webサービス）に標準で付いているHello Worldのサービスに対してPOSTリクエストを送るボタンが付いているので、そちらを押下します。

（図１２５）①