ASP.NET を使用せずに WCF AJAX サービスを作成する方法

  • [アーティクル]

Windows Communication Foundation (WCF) AJAX サービスには、JavaScript 対応の Web ページからアクセスできます。ASP.NET AJAX は必要ありません。 このトピックでは、このような WCF サービスを作成する方法について説明します。

ASP.NET AJAX で WCF を使用する方法については、「ASP.NET AJAX 用の WCF サービスの作成」を参照してください。

WCF AJAX サービスを作成する手順は、次の 3 つに分けられます。

  • ブラウザーからアクセスできる AJAX エンドポイントの作成

  • AJAX 互換サービス コントラクトの作成

  • WCF AJAX サービスへのアクセス

AJAX エンドポイントの作成

WCF サービスで AJAX のサポートを有効にする最も基本的な方法は、次の例に示すように、サービスに関連付けられた .svc ファイルの WebServiceHostFactory を使用することです。

<%ServiceHost
    language=c#  
    Debug="true"  
    Service="Microsoft.Ajax.Samples.CityService"  
    Factory=System.ServiceModel.Activation.WebServiceHostFactory  
%>

構成を使用して AJAX エンドポイントを追加することもできます。 次のコード スニペットに示すように、サービス エンドポイントで WebHttpBinding を使用し、WebHttpBehavior を使用してこのエンドポイントを構成します。

<configuration>  
  <system.serviceModel>  
    <behaviors>  
      <endpointBehaviors>  
        <behavior name="AjaxBehavior">  
          <webHttp/>  
        </behavior>  
      </endpointBehaviors>  
    </behaviors>  
    <services>  
      <service name="Microsoft.Ajax.Samples.CityService">  
        <endpoint
          address="ajaxEndpoint"  
          behaviorConfiguration="AjaxBehavior"  
          binding="webHttpBinding"  
          contract="Microsoft.Ajax.Samples.ICityService" />  
      </service>  
    </services>  
  </system.serviceModel>  
</configuration>

実際の例については、JSON と XML を使用した AJAX サービスに関するページを参照してください。

AJAX 互換サービス コントラクトの作成

既定では、AJAX エンドポイントを介して公開されるサービス コントラクトは、XML 形式でデータを返します。 また、次の例に示すように、既定では、エンドポイント アドレスの後に操作名を追加した URL に対する HTTP POST 要求によって、サービス操作にアクセスできます。

[OperationContract]  
string[] GetCities(string firstLetters);

この操作には、http://serviceaddress/endpointaddress/GetCities に対して HTTP POST を使用することによってアクセスでき、XML メッセージが返されます。

Web プログラミング モデルを活用することで、これらの基本的な部分をカスタマイズできます。 たとえば、WebGetAttribute 属性または WebInvokeAttribute 属性を使用して、操作が応答する HTTP 動詞を制御したり、これらの属性の UriTemplate プロパティを使用して、カスタム URI を指定したりできます。 詳細については、「WCF Web HTTP プログラミング モデル」のトピックを参照してください。

AJAX サービスでは、JSON データ形式がよく使用されます。 XML ではなく JSON を返す操作を作成するには、ResponseFormat (または ResponseFormat) プロパティを Json に設定します。 スタンドアロンの JSON シリアル化に関するトピックには、組み込みの .NET 型やデータ コントラクト型を JSON にマッピングする方法が示されています。

JSON の要求と応答は、通常 1 つの項目のみで構成されます。 前述の GetCities 操作の場合、要求は次のようなステートメントになります。

"na"

この要求に対する応答は、次のようなステートメントになります。

["Nairobi", "Naples", "Nashville"]

操作で追加のパラメーターを受け取る場合は、両方のパラメーターを 1 つの JSON オブジェクトにラップするために、要求スタイルをラップする必要があります。 このスタイルの JSON メッセージの一例を次に示します。

{"firstLetters": "na", "maxNumber": 2}

次のコントラクトがこのメッセージを受け入れます。

[WebInvoke(BodyStyle=WebMessageBodyStyle.WrappedRequest, ResponseFormat=WebMessageFormat.Json)]  
[OperationContract]  
string[] GetCities(string firstLetters, int maxNumber);

AJAX サービスへのアクセス

WCF AJAX エンドポイントでは、常に JSON と XML の両方の要求を受け入れます。

コンテンツ タイプが "application/json" である HTTP POST 要求は JSON として処理され、コンテンツ タイプが XML を示している ("text/xml" など) ものは XML として処理されます。

HTTP GET 要求では、URL 自体にすべての要求パラメーターが含まれています。

エンドポイントに対して HTTP 要求を作成する方法は、ユーザーが自由に決定できます。 また、要求の本文を構成する JSON の作成についても、ユーザーが完全に制御できます。 JavaScript から要求を作成する例については、JSON および XML 形式の AJAX サービスに関するページを参照してください。