JSONP

このサンプルでは、WCF REST サービスの JSONP (JSON with Padding) をサポートする方法を示します。JSONP とは、現在のドキュメントでスクリプト タグを生成してドメイン間スクリプトを呼び出す際に使用される変換です。結果は、指定したコールバック関数で返されます。JSONP は、<script src=”http://...” > などのタグで任意のドメインからのスクリプトを評価でき、このようなタグによって取得されたスクリプトを既に他の関数が定義されている範囲で評価するという考えに基づいています。

使用例

JSONP によるドメイン間スクリプト。

説明

このサンプルには、ブラウザーで表示された後にスクリプト ブロックを動的に追加する Web ページが含まれています。このスクリプト ブロックは、GetCustomer 操作を 1 つ持つ WCF REST サービスを呼び出します。WCF REST サービスは、コールバック関数名でラップされた顧客の名前とアドレスを返します。WCF REST サービスが応答を返すと、顧客データを使用して Web ページ上のコールバック関数が呼び出され、このコールバック関数によって Web ページ上に顧客データが表示されます。スクリプト タグの挿入とコールバック関数の実行は、ASP.NET AJAX ScriptManager コントロールによって自動的に処理されます。次のコードに示すように、使用パターンはすべての ASP.NET AJAX プロキシと同じで、JSONP を有効にするための行が 1 つ追加されます。

var proxy = new JsonpAjaxService.CustomerService();
proxy.set_enableJsonp(true);
proxy.GetCustomer(onSuccess, onFail, null);

Web ページでは、WCF REST サービスを呼び出すことができます。これは、WCF REST サービスが、crossDomainScriptAccessEnabled が true に設定された WebScriptEndpoint を使用しているからです。これらの構成は、Web.config ファイルの <system.serviceModel> 要素で行います。

<system.serviceModel>
  <serviceHostingEnvironment aspNetCompatibilityEnabled="true"/>
  <standardEndpoints>
    <webScriptEndpoint>
      <standardEndpoint name="" crossDomainScriptAccessEnabled="true"/>
    </webScriptEndpoint>
  </standardEndpoints>
</system.serviceModel>

ScriptManager はサービスとのやり取りを管理し、JSONP アクセスの手動実装の複雑さを隠蔽します。crossDomainScriptAccessEnabled が true に設定されていて、操作の応答形式が JSON である場合、WCF インフラストラクチャは要求の URI からコールバック クエリ文字列パラメーターを検出し、そのコールバック クエリ文字列パラメーターの値で JSON 応答をラップします。このサンプルでは、Web ページは次の URI を使用して WCF REST サービスを呼び出します。

https://localhost:33695/CustomerService/GetCustomer?callback=Sys._json0

コールバック クエリ文字列パラメーターには JsonPCallback の値が含まれているため、WCF サービスは次の例に示す JSONP 応答を返します。

Sys._json0({"__type":"Customer:#Microsoft.Samples.Jsonp","Address":"1 Example Way","Name":"Bob"});

JSONP 応答には、JSON として書式設定され、Web ページが要求したコールバック関数名でラップされた顧客データが含まれています。ScriptManager は、ドメイン間要求を実現するスクリプト タグを使用してこのコールバックを実行し、ASP.NET AJAX プロキシの GetCustomer 操作に渡された onSuccess ハンドラーに結果を渡します。

このサンプルは 2 つの ASP.NET Web アプリケーションで構成されます。1 つは WCF サービスのみを含み、もう 1 つはサービスを呼び出す .aspx Web ページを含みます。ソリューションの実行中、Visual Studio 2010 は 2 つの Web サイトの別々のポート上にホストします。これにより、サービスとクライアントが別々のドメインに存在する環境が作成されます。

注 :
サンプルは、既にコンピューターにインストールされている場合があります。続行する前に、次の (既定の) ディレクトリを確認してください。 <InstallDrive>:\WF_WCF_Samples このディレクトリが存在しない場合は、「.NET Framework 4 向けの Windows Communication Foundation (WCF) および Windows Workflow Foundation (WF) のサンプル」にアクセスして、Windows Communication Foundation (WCF) および WF のサンプルをすべてダウンロードしてください。このサンプルは、次のディレクトリに格納されます。 <InstallDrive>:\WF_WCF_Samples\WCF\Basic\AJAX\JSONP

サンプルを実行するには

1. JSONP サンプルのソリューションを開きます。

2. F5 キーを押して、https://localhost:26648/JSONPClientPage.aspx をブラウザーで開きます。

3. ページが読み込まれた後、"Name" および "Address" のテキスト入力に値が設定されます。これらの値は、ブラウザーがページを表示した後に WCF サービスの呼び出しから提供されたものです。