3.8 Web 2.0時代のWebServices 〜SOAP/REST使い分けの指針

GET /WebSite1/WebService.asmx/getHello?str=string HTTP/1.1
Host: localhost

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://tempuri.org/">string</string>

POST /WebSite1/WebService.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/getHello"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getHello xmlns="http://tempuri.org/">
      <str>string</str>
    </getHello>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getHelloResponse xmlns="http://tempuri.org/">
      <getHelloResult>string</getHelloResult>
    </getHelloResponse>
  </soap:Body>
</soap:Envelope>

• 通信内容がすべてテキストであることによる可読性
• HTTPSを使っての暗号化（サーバ証明／クライアント証明）
• HTTPプロキシを使ってFirewallを越える
• リアルタイムな応答
• HTTP, XMLをターゲットにしたライブラリやアプライアンスの流用
• XMLに対してXSLTを使ってのフォーマット変換

• HTTPは長時間の接続維持ができないので、すぐに応答を返す必要がある
• XMLの構造をスキーマに定義する必要がある

<?xml version="1.0" encoding="utf-8"?>
<s:schema xmlns:s="http://www.w3.org/2001/XMLSchema" 
          elementFormDefault="qualified" targetNamespace="http://tempuri.org/">
  <s:element name="getHello">
    <s:complexType>
      <s:sequence>
        <s:element minOccurs="0" maxOccurs="1" name="str" type="s:string" />
      </s:sequence>
    </s:complexType>
  </s:element>
  <s:element name="getHelloResponse">
    <s:complexType>
      <s:sequence>
        <s:element minOccurs="0" maxOccurs="1" name="getHelloResult" type="s:string" />
      </s:sequence>
    </s:complexType>
  </s:element>
  <s:element name="string" nillable="true" type="s:string" />
</s:schema>

例．	http://hostname/hoge.cgi?id=1234
	http://hostname/hoge.cgi/id/1234/
	改行、スペース、日本語などはエンコード

サーバ側
入力	Java：request.getParameter("param1") PHP：$_GET['param1'] その他：QUERY_STRINGなど
出力	HTMLではなくXMLを返す
クライアント側
リクエスト	HTTPかTCPを操作するメソッドを利用 JavaScript：XMLHttpRequest、ActiveXObject ("Microsoft.XMLHTTP") Java：HttpURLConnection
レスポンス	XMLが返ってくるので、DOM APIで操作

• WS-Security
  
• WS-Policy
  
• WS-PolicyAttachment
• WS-SecurityPolicy
  
• WS-Addressing
  
• WS-Trust
• WS-MetadataExchange
• WS-ReliableMessaging
• WS-RM Policy
• WS-Federation
• WS-Transfer
• WS-Transaction
• WS-AtomicTransaction
• WS-SecureConversation
• これら以外にも、修正・追加され続けている
  

1. 送受信するXMLデータの構造を定義する
   まずは、送受信するXMLデータの構造（＝スキーマ）を定義する。ここで入力パラメータが単純であればRESTにも対応できるし、複雑であればSOAPのみとなってしまう。
   利用できる標準化されたスキーマ定義があれば良いのだが、無い場合にはスキーマを作成する必要がある。Javaなどの開発言語で書いたデータBeanによってスキーマ定義を自動生成してくれるツールもあるが、そのツールに依存した記述方法で出力する危険がある。「できるだけ多くの人に利用して欲しい」のであれば、平易な記述方法だけを使い、複数のツールで正常に読み込めて、想定通りの動きをするか確認するのが確実である。
   
   
2. SOAPに対応するのであれば、WSDLを記述する
   スキーマを使って、WSDLを記述する。WSDLを作成することでインターフェイスが明確になる。
   WSDLをミドルウエアに読み込ませれば、スケルトンを自動生成してくれるので、あとは実際の処理やDBアクセスなどの中身を開発するだけである。
   スキーマやWSDLを記述するのは大変だが、特定のツールに依存しないためにも、後のメンテナンス性を確保するためにも、自動生成に頼らない方が確実である。
   提供側が受信するパラメータが単純であれば、『SOAPを作成すれば自動的にRESTにも対応してくれる』ミドルウエア（Axis2, .net Framework等）もある。
   中身の開発については、各開発言語ごとの開発手法を使うこと。
   
   
3. RESTに対応するのであれば、入出力のサンプルを作成する
   WADLも書いた方がもちろん良いのだが、今のところ利用できるツールが少ないため、ドキュメントとしてしか利用できないだろう。
   指定されるURLと結果のXMLのサンプルデータを作成する。サンプルデータを作っておけば「仕様が明確になる」「テストデータとして使える」「利用者へサンプルとして提供する」と活用できるので、作っておいて損はない。
   SOAPの場合も、サンプルのSOAPメッセージを作成しておくと、色々と便利である。
   
   
4. テスト
   RESTであればブラウザでアクセスしてみるのが簡単である。
   また、ミドルウエアが提供してくれるテスト画面を使う方法もあるが、HTTPを使っているメリットの１つとして、Webサイト用のテストツールがそのまま使える。Webサイトのテストや負荷試験のために、無料／有料のさまざまなツールがあるが、そのほとんどが使える。SOAPであっても、POSTデータとしてXMLを送信すれば結果のXMLを受信できるし、パラメータを動的に変化させるテストもWebサイトの場合と同様である。
   

・RESTアクセスのサンプル（JavaScript）

function requestRest(){ var endpoint = "http://ホスト名/WebSite1/WebService.asmx"; // 送信先 var param1 = "keywork"; // パラメータ // URLを生成 var url = endpoint + "/getHello?str=" + encodeURI(param1) + "&dummy="+(new Date().getTime()); // XMLHttpRequestを作成 try { xmlhttp = new XMLHttpRequest(); // Netscape, Firefoxなど } catch (e){ try { xmlhttp = new ActiveXObject ("Msxml2.XMLHTTP"); // IE } catch (e){ try { xmlhttp = new ActiveXObject ("Microsoft.XMLHTTP"); // IE } catch (e){ // XMLHttpRequestの作成に失敗 } } } xmlhttp.onreadystatechange = method1; // レスポンスを受け取った時に呼ばれるメソッドを指定 xmlhttp.open('GET', url, true); xmlhttp.setRequestHeader ("Content-Type","text/xml; charset=utf-8"); xmlhttp.send(); // RESTで送信 } function method1() { if (xmlhttp.readyState == 4 && xmlhttp.status == 200) { alert(xmlhttp.responseText); // 結果をデバッグ表示 } }

・SOAPアクセスのサンプル（JavaScript）

function requestSoap(){ var endpoint = "http://ホスト名/WebSite1/WebService.asmx"; // 送信先 var param1 = "keywork"; // パラメータ // SOAPメッセージを作成 var msg = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n\ <soap:Envelope xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" \n\ xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" \n\ xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\">\n\ <soap:Body>\n\ <getHello xmlns=\"http://tempuri.org/\">\n\ <str>" + param1 + "</str>\n\ </getHello>\n\ </soap:Body>\n\ </soap:Envelope>"; // XMLHttpRequestを作成 try { xmlhttp = new XMLHttpRequest(); // Netscape, Firefoxなど } catch (e){ try { xmlhttp = new ActiveXObject ("Msxml2.XMLHTTP"); // IE } catch (e){ try { xmlhttp = new ActiveXObject ("Microsoft.XMLHTTP"); // IE } catch (e){ // XMLHttpRequestの作成に失敗 } } } xmlhttp.onreadystatechange = method2; // レスポンスを受け取った時に呼ばれるメソッドを指定 xmlhttp.open('POST', endpoint, true); xmlhttp.setRequestHeader ("Content-Type","text/xml; charset=utf-8"); xmlhttp.setRequestHeader ("SOAPAction","\"http://tempuri.org/getHello\""); xmlhttp.send(msg); // SOAPメッセージを送信 } function method2() { if (xmlhttp.readyState == 4 && xmlhttp.status == 200) { xmlDoc = xmlhttp.responseXML; // 結果をDOMオブジェクトとして取得 } }

• HTML
• JSON
• JSONP
• ライブラリの提供

・各方式の比較

	SOAP	REST	JSON
学習容易性	×	○	○
コーディング量（自動生成分は除く）	○	×	○
テストのし易さ	×	◎	×
開発ツール	○	×	×
導入の容易性	×	○	○
開発にかかるトータル時間	×	○	◎
複雑なデータの入力	○	×	×
複雑なデータの出力	○	○	△
厳密な型チェック	○	×	×
汎用性（扱える開発言語の種類）	○	○	×
標準化団体	W3C	-	ecma
拡張性（WS-*）	◎	×	×

1. リクエストとレスポンスの生メッセージの提示
2. WSDL,WADLなどの提供
3. クライアント用ライブラリの提供

• ユーザー認証方式
• サービスの粒度
• ドメイン境界
• セキュリティ

• RESTを使いたいのに、提供されているサービスはSOAPしかない→ゲートウエイ
• １画面に表示したい情報を取得するために、何度もサービスを呼び出す必要がある→ゲートウエイ
• マッシュアップするサービス群が、REST/SOAPがバラバラで、スキーマも全然違う→アグリゲーション
• 過去のある時点でのレスポンスが欲しい→アーカイブサービス、REST向き
• 応答が遅い→キャッシュサービス、REST向き

Copyright (c) XML コンソーシアム 2007 All rights reserved.
Copyright (c) アドソル日進株式会社  2007 All rights reserved.

　　「エンタープライズ・システムのためのWeb 2.0」目次に戻る