ASP.NET AJAX 用の WCF サービスの作成

[アーティクル]
05/10/2023

Microsoft ASP.NET AJAX により、応答性に優れ、使い慣れたユーザーインターフェイス要素を使用して、充実したユーザーエクスペリエンスを提供する Web ページを簡単に作成できます。 ASP.NET AJAX には、ブラウザーに依存しない ECMAScript (JavaScript) テクノロジとダイナミック HTML (DHTML) テクノロジを組み込んだクライアントスクリプトライブラリが用意されており、これらのライブラリが ASP.NET 2.0 サーバーベース開発プラットフォームと統合されます。 ASP.NET AJAX を使用することで、Web アプリケーションのユーザーエクスペリエンスと効率を向上させることができます。

ASP.NET AJAX は、クライアントスクリプトライブラリとサーバーコンポーネントを統合した強固な開発フレームワークです。 ASP.NET ページからサービスにアクセスする場合、サービス URL をページ上の ASP.NET スクリプトマネージャーに追加すると、標準の JavaScript 関数の呼び出しとまったく同じに見える JavaScript コードを使い、サービス操作を呼び出すことができます。

適切な ASP.NET AJAX エンドポイントを追加すると、ほとんどの Windows Communication Foundation (WCF) サービスを、ASP.NET AJAX 互換のサービスとして公開できます。

Visual Studio を使用する場合は、AJAX 対応 WCF サービス用のビルド済みテンプレートを使用できます。これは、ASP.NET Web サイトまたは Web アプリケーションでの作業中に [新しい項目の追加] ダイアログボックスで選択できます。

Visual Studio テンプレートを使用しない場合、ASP.NET AJAX エンドポイントを作成するには次の 2 つの方法があります。

構成を使用せずに、動的ホストアクティブ化を使用してエンドポイントを作成する。これは、WCF 構成システムの操作に慣れていない場合の最も簡単な方法です。詳細については、「方法: 構成を使用せずに ASP.NET AJAX エンドポイントを追加する」を参照してください。
構成を使用して、AJAX 対応のエンドポイントを WCF サービスに追加する。詳細については、「方法: 構成を使用して ASP.NET AJAX エンドポイントを追加する」を参照してください。

「WCF Web HTTP プログラミングモデルの概要」で説明されている Web プログラミングモデルは、ASP.NET AJAX サービスで使用できます。具体的には次のとおりです。

WebGetAttribute および WebInvokeAttribute 属性を使用して、HTTP GET 動詞と HTTP POST 動詞のいずれかを選択できます。正しく使用すれば、アプリケーションのパフォーマンスを大幅に向上させることができます。詳細については、「方法: ASP.NET AJAX エンドポイントのために HTTP POST または HTTP GET を選択する」を参照してください。
ResponseFormat および ResponseFormat プロパティを使用して、サービスが返すデータを、既定の JSON (JavaScript Object Notation) ではなく XML データにすることができます。これを ASP.NET AJAX フレームワークで行うと、JavaScript クライアントは XML DOM オブジェクトを受け取ります。

警告

この動作を機能させるには、コンテンツタイプを text/xml に設定する必要があります。設定しない場合、JavaScript クライアントは XML DOM オブジェクトではなく XML を含む文字列を受け取ります。

コンテンツタイプが適切に設定された XML データを返す操作の例を次に示します。
```
[OperationContract, WebGet(ResponseFormat=WebMessageFormat.Xml)]
public XElement GetData()
{
    XElement x;
    //Get some data here...

    WebOperationContext.Current.OutgoingResponse.ContentType = "text/xml";
    return x;
}
```
ASP.NET AJAX との互換性が必要な場合、WebGetAttribute および WebInvokeAttribute 属性の他の属性は変更できません。 ASP.NET AJAX 呼び出し規約に違反しない限り、Web プログラミングモデルのその他の機能を使用できます。

より高度なシナリオでは、WCF での AJAX サポートについて、他にいくつかの詳細な事項を理解する必要があります。

JavaScript を使用して AJAX ページクライアントと WCF サービス間でデータを転送する方法と、.NET Framework の型を JavaScript の型に割り当てる方法の詳細については、「JSON などのデータ転送形式のサポート」を参照してください。
たとえば、URL ベースの認証や ASP.NET セッション情報へのアクセスなどの ASP.NET 機能を活用するには、構成で ASP.NET 互換モードを有効にします。

WCF の AJAX エンドポイントは、ASP.NET AJAX フレームワークなしで使用できます。これを行うには、WCF での AJAX サポートのサポートアーキテクチャに関する知識が必要です。このアーキテクチャについては、「WCF Web HTTP プログラミングオブジェクトモデル」を参照してください。この方法を実行するコードサンプルについては、JSON および XML 形式の AJAX サービスに関するページを参照してください。

ASP.NET AJAX 用の WCF サービスの作成

関連項目

その他のリソース