.NET クライアントライブラリ (ADO.NET Data Services フレームワーク)

[アーティクル]
09/17/2008

ADO.NET Data Services には、.NET Framework と ADO.NET Data Services を使用するアプリケーションのための .NET クライアントライブラリが含まれています。クライアントライブラリを使用するアプリケーションは、データサービスから返された結果を .NET オブジェクトとして操作できます。関連付けの走査は、共通言語ランタイム (CLR) オブジェクトによって管理されます。

.NET クライアントライブラリは、HTTP および AtomPub 形式を使用します。クライアントライブラリは、企業ネットワークとインターネット環境で問題なく実行できます。実行するのに必要なのは、直接またはプロキシ経由のいずれかによる、データサービスへの HTTP レベルの接続だけです。

System.Data.Services.Client

クライアントライブラリを使用するには、System.Data.Services.Client アセンブリへの参照をプロジェクトに追加します。クライアントライブラリは、Windows フォーム、Windows Presentation Foundation、Web サイトプロジェクトなどのプロジェクトの種類から使用できます。

クライアントライブラリの 2 つの主な構造は、DataServiceContext クラスおよび DataServiceQuery クラスです。DataServiceContext は、指定されたデータサービスを使用してランタイムコンテキストを表します。データサービスはステートレスですが、コンテキストはステートレスではありません。クライアントでの状態は、変更管理などの機能をサポートするために、対話間で維持されます。

DataServiceQuery クラスは、ADO.NET Data Services の URI 構文を使用して指定されたストレージに対するクエリを表します。クエリを実行して .NET オブジェクトの形式で結果を取得するには、たとえば、C# の foreach 構造または Visual Basic の For Each を使用して、クエリオブジェクトを列挙します。

.NET オブジェクトとしてデータサービスで定義された各エンティティを表すには、対応するクラスをクライアントアプリケーションに対して定義する必要があります。これを行う方法の 1 つは、手動でクラスを定義することです。別の方法としては、次のセクションで説明する DataSvcUtil.exe ツールを使用します。

次の例は、SQL Server 2005 に付属する AdventureWorks サンプルデータベースのデータに基づいた、Address クラスの手書きの定義を示しています。この例では、Address エンティティと、サービスに対してクエリを実行する小さなコードを使用します。返された Address のプロパティが出力として表示されます。

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using System.Data.Services.Client;
    

namespace DataServiceClient
{

    public class Address
    {
        public int AddressID { get; set; }
        public string AddressLine1 { get; set; }
        public string AddressLine2 { get; set; }
        public string City { get; set; }
        public DateTime ModifiedDate { get; set; }
        public string PostalCode { get; set; }
        public Guid rowguid { get; set; }       
        public int StateProvinceID { get; set; }

    }

    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }       


        private void button_Click(object sender, EventArgs e)
        {
            DataServiceContext ctx = new
                 DataServiceContext(new Uri("https://localhost:1492/AdvWksSales.svc/"));


          // This example expects the user to enter
             // an integer representing AddressID in textBox1.

             DataServiceQuery<Address> query =
                 ctx.CreateQuery<Address>(
                   "SalesOrderHeader(45678)/Address");

             StringBuilder output = new StringBuilder();
            
             foreach (Address address in query)
             {
                output.Append("Id: " + address.AddressID +
                        " Line 1: " + address.AddressLine1 + "\r\n");
                
             }

            richTextBox1.Text = output.ToString();
            


        }

出力は次のとおりです。

Id: 70 Address Line1: 1792 Belmont Rd. City: Monroe

DataSvcUtil ツールの使用

クラスを手動で記述する方法は、種類の少ない場合は適していますが、データサービススキーマがより複雑な場合、維持するクラスの数とサイズが増大するため、手動で維持するには複雑すぎます。ADO.NET Data Services に付属する DataSvcUtil.exe というコード生成ツールを使用する方が便利です。このツールは、データサービス定義から .NET クラスを生成します。

DataSvcUtil.exe は、\WINDOWS\Microsoft.NET\Framework\v3.5\ ディレクトリにあります。コマンドラインでは、生成される種類のデータサービスの基本 URL を引数として指定します。たとえば、Northwind サービスが、https://localhost:1234/Northwind.svc にある Visual Studio 開発サーバーで実行されている場合、クラスを生成するコマンドラインは次のようになります。

C:\Program Files\Microsoft Visual Studio 9.0\VC>"C:\WINDOWS\Microsoft.NET\Framework\v3.5\DataSvcUtil.exe"
 /out:c:\northwind.cs /uri:https://localhost:1365/Northwind.svc

コマンドの出力は、データサービスにある各エンティティ型のクラスが含まれる C# ファイルです (/language:VB スイッチを使用すると Visual Basic の型を生成できます)。

生成されたクラスには、プリミティブ型の値を表すメンバと、オブジェクトモデルを通じたナビゲーションを容易にする関連付けが含まれます。

LINQ to ADO.NET Data Services

.NET クライアントライブラリは、「Microsoft Data Web Client」で示されている DataServiceContext.CreateQuery の呼び出しでデータサービスをクエリすることに加えて、統合言語クエリ (LINQ) を使用したデータサービスのクエリをサポートします。LINQ の詳細については、「LINQ to Entities」を参照してください。クライアントライブラリは、ターゲットデータサービスで URI に LINQ ステートメントをマッピングし、指定されたリソースを .NET オブジェクトとして取得する場合の詳細を処理します。次の例は、返される結果セットにおいて、London 市内のすべての顧客を会社名順で取得する方法を示しています。

using System;
using System.Data.Services.Client;
using System.Linq;
using NorthwindModel;

namespace TestApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            NorthwindEntities ctx = new 
            NorthwindEntities(
              new Uri("https://localhost:1365/Northwind.svc"));

            var q = from c in ctx.Customers 
                    where c.City == "London"
                    orderby c.CompanyName
                    select c;

            foreach (var cust in q)
            {
                Console.WriteLine(cust.CompanyName);
            }
        }
    }
}

[!メモ]

LINQ 構文で表現できるクエリのセットは、データサービスによって使用される Representational State Transfer (REST) ベースの URI 構文で有効なクエリのセットよりも範囲が広くなります。クエリを対象のデータサービスの URI にマップできない場合、例外がスローされます。REST の詳細については、「REST サービスおよびセマンティクス (ADO.NET Data Services フレームワーク)」を参照してください。

[!メモ]

このセクションと次の 2 つのセクションの例では、Northwind サンプルデータベースを使用します。Northwind サンプルは、https://go.microsoft.com/fwlink/?linkid=24758 からダウンロードできます。

更新のサポート

データサービスで新しいインスタンスを作成するには、次のコード例に示すように、.NET オブジェクトを作成し、使用される DataServiceContext インスタンスの AddObject を呼び出して、オブジェクトと対象エンティティのセットを渡します。

using System;
using Microsoft.Data.WebClient;
using NorthwindModel;

namespace TestApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            DataServiceContext ctx = new
              DataServiceContext(
                  new Uri("https://localhost:1365/Northwind.svc"));

            Categories cNew = new Categories();
            cNew.CategoryName = "NewCategory1";
            cNew.Description = "Add Item Test.";

            ctx.AddObject("Categories",cNew);
            ctx.SaveChanges();
        }
    }
}

データサービスでエンティティが作成または変更されると、サービスは、データベースまたは自動生成キーでトリガの結果として更新された可能性のあるプロパティ値を含む、エンティティの新しいコピーを返します。クライアントライブラリは、これらの新しい値を使用して .NET オブジェクトを自動的に更新します。

既存のエンティティインスタンスを変更するには、まず、そのオブジェクトをクエリしてそのプロパティに必要な変更を行い、UpdateObject メソッドを呼び出して、オブジェクトの更新を送信する必要があることをクライアントライブラリに示します。

[!メモ]

次の例では、上記のコード生成ツールによって作成され、DataServiceContext から派生したコンテキストクラス NorthwindEntities を使用します。この派生クラスは、サービスに対するコーディングを簡略化するサービス固有のプロパティを提供します。

次のコード例は、UpdateObject メソッドを使用した更新の構文を示しています。

using System;
using Microsoft.Data.WebClient;
using System.Linq;
using NorthwindModel;

namespace TestApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            NorthwindEntities ctxN =
               new NorthwindEntities(
                     new Uri("https://localhost:1365/Northwind.svc"));

            var c1 = (from c in ctxN.Categories
                     where c.CategoryName == "NewCategory1"
                     select c).First();
                               
            c1.CategoryName = "UpdatedCategory";

            //ctxN.AttachTo("Categories", c1);
            ctxN.UpdateObject(c1);
            ctxN.SaveChanges();
        }
    }
}

エンティティインスタンスを削除するには、DataServiceContext オブジェクトの Delete メソッドを呼び出します。

変更は、DataServiceContext インスタンスで追跡されますが、サーバーには直ちに送信されません。指定されたアクティビティに対して必要な変更が完了したら、SaveChanges を呼び出して、すべての変更をデータサービスに送信します。

クライアントライブラリの認証

.NET クライアントライブラリは、HTTP プロトコルに対する .NET Framework サポートを使用します。その際、一連の資格情報が指定されると、フレームワークインフラストラクチャは HTTP を通じて認証スキームを自動的に処理します。

既定では、クライアントライブラリからは、HTTP スタックに資格情報が提供されません。ただし、DataServiceContext で Credentials プロパティを設定して、ICredentials インターフェイスを実装するオブジェクトを指定できます。資格情報の詳細については、「WebRequest.Credentials」を参照してください。

データサービスとの非同期の対話

Web アプリケーションは、内部ネットワーク内で実行するアプリケーションより長い、クライアントとサーバー間の待機時間に対応するようにデザインする必要があります。サーバーとの非同期の対話を使用すると、アプリケーションがサーバーからの応答を待機している間、ユーザーインターフェイスの応答性を維持することができます。

このリリースでは、ADO.NET クライアントライブラリが、DataServiceContext クラスで利用可能な多くの操作 (変更の取得や変更の保存など) に対して非同期モードの操作をサポートしています。次の例は、コードでクライアントライブラリの非同期の API を使用する方法を示しています。

using System;
using Microsoft.Data.WebClient;
using System.Linq;
using NorthwindModel;

namespace TestApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            NorthwindEntities ctx = new 
                NorthwindEntities(new Uri(https://localhost:51905/nw.svc));

            DataServiceQuery<Customers> q = ctx.Customers;

            q.BeginExecute(
                    delegate(IAsyncResult ar)
                    {
                        foreach (Customers c in q.EndExecute(ar))
                        {
                            Console.WriteLine(c.CompanyName);
                        }
                    },
                    null);


            Console.ReadKey();
        }
    }
}

参照

概念

HttpWebRequest GET (ADO.NET Data Services フレームワーク)
ADO.NET Data Services の作成

その他のリソース

エンティティデータモデル

対象エンティティ → ソースエンティティ ↓	null	Added	Modified	Deleted	Unchanged
Added	SetLink	AddLink SetLink	AddLink SetLink	なし	AddLink SetLink
Modified	SetLink	AddLink SetLink	AddLink AttachLink DeleteLink SetLink	DeleteLink	AddLink AttachLink DeleteLink SetLink
Deleted	SetLink	なし	DeleteLink	DeleteLink	DeleteLink
Unchanged	SetLink	AddLink	AddLink AttachLink DeleteLink SetLink	DeleteLink	AddLink AttachLink DeleteLink SetLink

次の方法で共有

.NET クライアントライブラリ (ADO.NET Data Services フレームワーク)

System.Data.Services.Client

DataSvcUtil ツールの使用

LINQ to ADO.NET Data Services

関連付け

更新のサポート

関連付けの更新

クライアントライブラリの認証

データサービスとの非同期の対話

参照

概念

その他のリソース

その他のリソース

次の方法で共有

.NET クライアント ライブラリ (ADO.NET Data Services フレームワーク)

System.Data.Services.Client

DataSvcUtil ツールの使用

LINQ to ADO.NET Data Services

関連付け

更新のサポート

関連付けの更新

クライアント ライブラリの認証

データ サービスとの非同期の対話

参照

概念

その他のリソース

その他のリソース

.NET クライアントライブラリ (ADO.NET Data Services フレームワーク)

クライアントライブラリの認証

データサービスとの非同期の対話