チュートリアル : ローカルデータベースキャッシュを n 層アプリケーションに追加する

[アーティクル]
08/09/2011

Visual Studio におけるローカルデータベースキャッシュとは、Microsoft Synchronization Services for ADO.NET を使用してリモートデータベースとの間でデータを同期するために構成された SQL Server Compact 3.5 データベースです。このチュートリアルでは、「チュートリアル : n 層データアプリケーションの作成」のトピックで作成したアプリケーションに SQL Server Compact 3.5 データベースを追加する方法の詳細な手順について説明します。

このチュートリアルでは、次のタスクを実行する方法を学習します。

ローカルデータベースキャッシュ項目をプロジェクトに追加する。
データ同期を構成する。
同期操作を既存のデータサービスに組み込む。
ローカルデータベースキャッシュから Customers テーブルを取得するために、データをロードするコードを変更する。
同期処理を開始するコードを追加する。

必須コンポーネント

このチュートリアルを実行するための要件は次のとおりです。

「チュートリアル : n 層データアプリケーションの作成」で作成したソリューションおよび関連するプロジェクト。
Northwind サンプルデータベースにアクセスします。詳細については、「方法 : サンプルデータベースをインストールする」を参照してください。

注意

お使いのマシンで、Visual Studio ユーザーインターフェイスの一部の要素の名前や場所が、次の手順とは異なる場合があります。これらの要素は、使用している Visual Studio のエディションや独自の設定によって決まります。詳細については、「Visual Studio の設定」を参照してください。

NTierWalkthrough ソリューションを開く

NTierWalkthrough ソリューションを開くには

[ファイル] メニューの [開く] をポイントし、[プロジェクト/ソリューション] をクリックして、NTierWalkthrough.sln ファイルの場所に移動します。

注意

NTierWalkthrough.sln ファイルは「チュートリアル : n 層データアプリケーションの作成」トピックで作成され、このチュートリアルを実行するための前提条件となっています。まだ行っていない場合は、「チュートリアル : n 層データアプリケーションの作成」トピックを完了し、終了時にすべてのプロジェクトを保存してください。

ローカルデータベースキャッシュを NTierWalkthrough に追加する

ローカルデータベースキャッシュは、クライアントに配置されている SQL Server Compact 3.5 データベースであるため、ローカルデータベースキャッシュの追加先は PresentationTier プロジェクトになります。このチュートリアルでは Customers テーブルをキャッシュに入れる方法を取り上げることから、このローカルデータベースキャッシュには CustomersCache という名前を付けます。

注意

このチュートリアルでは、Customers テーブルだけを使用するため、ローカルデータベースキャッシュの名前を CustomersCache にしますが、1 つのローカルデータベースキャッシュに複数のテーブルを追加することも可能です。

プレゼンテーション層にローカルデータキャッシュを追加するには

ソリューションエクスプローラーで、PresentationTier を右クリックし、[新しい項目の追加] をクリックします。
[ローカルデータベースキャッシュ] テンプレートをクリックします。
[名前] に「CustomersCache」と入力します。
[追加] をクリックします。

[データ同期の構成] ダイアログボックスが開きます。

データ同期の構成

データ同期を構成するには、サーバーへのデータ接続を選択し、アプリケーションでローカルキャッシュに追加するテーブルを選択します。このチュートリアルでは、サーバー接続を SQL Server バージョンの Northwind データベースに設定し、Customers テーブルをローカルキャッシュに追加します。さらに、ローカルデータベースキャッシュを n 層アプリケーションに追加するため、詳細オプションを設定して、別個のプロジェクト DataService にサーバー同期コンポーネントを生成することも必要です。

n 層アプリケーションでデータ同期を構成するには

[サーバー接続] を SQL Server バージョンの Northwind データベースに設定します。
[追加] ボタンをクリックして [オフライン使用のためのテーブルの構成] ダイアログボックスを開きます。
Customers テーブルに関連付けられているチェックボックスをオンにし、[OK] をクリックします。 (既定値をそのままにします。)
[詳細] をクリックします。
[サーバープロジェクトの場所] の一覧で [DataService] を選択します。
[OK] をクリックします。

同期コンポーネントが生成され、データの初回の同期が実行され (つまり、ローカルデータベースがプロジェクト内に作成されてデータが取り込まれ)、データソース構成ウィザードが開きます。
Customers テーブルを選択し、[データベースオブジェクトの選択] ページで、そのテーブルに関連付けられているチェックボックスをオンにします。
[データセット名] に LocalNorthwindCustomers と入力し、[完了] をクリックします。

既存のデータサービスで同期を有効にする

生成された同期コンポーネントは DataService プロジェクトに追加されましたが、これからサービスによって実装する必要があります。生成された SyncContract にはサービスにとって必要な情報が含まれています。その情報は、ファイル内ではコメントになっています。サービスの App.config ファイルの該当するセクションに必要な情報をコピーする必要があります。

App.config ファイルにサービス情報を追加するには

ソリューションエクスプローラーで CustomersCache.Server.SyncContract ファイルをダブルクリックして開きます。
以下のようなコメント行を探します。

<endpoint address ="" binding="wsHttpBinding" contract="DataService.ICustomersCacheSyncContract"/>
コメント文字を含めずにその行をコピーします。
ソリューションエクスプローラーで DataService の App.config ファイルをダブルクリックして開きます。
コメントを探します。手順 3 でコピーした行を <endpoint address = "mex" で始まる行の下に追加します。

貼り付けたエンドポイントアドレスとして SyncServer などの名前を入力します。以下のようなコードが出来上がります。

<endpoint address="mex" binding="mexHttpBinding" contract="IMetadataExchange"/>
<endpoint address ="SyncServer" binding="wsHttpBinding" contract="DataService.ICustomersCacheSyncContract"/>

[ビルド] メニューの [ソリューションのビルド] をクリックします。

同期サービス操作を既存のデータサービスに追加するには

ソリューションエクスプローラーで CustomersCache.Server.SyncContract ファイルをダブルクリックして開きます。
クラスの名前を CustomersCacheSyncService から Service1 に変更します。クラス名を変更した後のクラス宣言は、以下のコードのようになります。 (C# のユーザーは、コンストラクターの名前も変更する必要があります。)
```
Partial Public Class Service1
    Inherits Object
    Implements ICustomersCacheSyncContract
...
```
```
public partial class Service1 : object, ICustomersCacheSyncContract
{...
```

C# ユーザーの場合:

Service1.cs ファイルで、Service1 のクラス宣言を以下のような部分クラスに変更します。

public partial class Service1 : object, ICustomersCacheSyncContract {

private CustomersCacheServerSyncProvider _serverSyncProvider;

public Service1() 
{...

[ビルド] メニューの [ソリューションのビルド] をクリックします。

既存のサービスに同期操作が追加されたので、PresentationTier プロジェクトでサービスの参照を更新する必要があります。

サービス参照を更新するには

ソリューションエクスプローラーで、PresentationTier プロジェクトの ServiceReference1 を探します。
[ServiceReference1] を右クリックし、[サービス参照の更新] をクリックします。

ローカルキャッシュから Customers データを読み込むようにフォームを変更する

プレゼンテーション層のフォームは、データサービスからデータを取得するようになっています。したがって、SQL Server Compact 3.5 データベースにある Customers テーブルのローカルコピーからデータを読み込むようにコードを変更しなければなりません。 Orders テーブルには、DataService から返されたデータが読み込まれます。

ローカルデータベースキャッシュから Customers データを読み込むように Form1 を変更するには

コードエディターで Form1 を開きます。

既存の Form1_Load コードを次のコードに置き換えます。

Using DataSvc As New ServiceReference1.Service1Client

    ' Create a CustomersTableAdapter to load data from
    ' the local database cache.
    Dim CustomersTableAdapter As New LocalNorthwindCustomersTableAdapters.CustomersTableAdapter

    NorthwindDataSet.Customers.Merge(CustomersTableAdapter.GetData)
    NorthwindDataSet.Orders.Merge(DataSvc.GetOrders)
End Using

using (ServiceReference1.Service1Client DataSvc = new ServiceReference1.Service1Client())
{
    LocalNorthwindCustomersTableAdapters.CustomersTableAdapter customersTableAdapter
       = new LocalNorthwindCustomersTableAdapters.CustomersTableAdapter();
    northwindDataSet.Customers.Merge(customersTableAdapter.GetData());
    northwindDataSet.Orders.Merge(DataSvc.GetOrders());
}

アプリケーションのテスト

アプリケーションを実行します。ローカルデータベースキャッシュとデータサービスの両方からデータが取り込まれます。

アプリケーションをテストするには

F5 キーを押します。
Customers テーブルのデータはローカルデータベースから、Orders テーブルのデータはデータサービスから取り込まれます。
フォームを閉じます

データの同期

プレゼンテーション層で正しいソースからテーブルを表示するための設定ができたので、次に、同期を開始するコードを追加します。さらに、同期処理を開始するボタンもフォームに追加します。

ローカルデータベースキャッシュとリモートデータベースのデータを同期するには

デザインビューで [Form1] を開きます。
フォームの ToolStrip をクリックして、ToolStrip にボタンを追加します。
ボタンに SyncButton という名前を付けます。
SyncButton をダブルクリックして、SyncButton_Click イベントハンドラーを作成します。

同期処理を開始するコードを以下に示します。このコードをイベントハンドラーに追加します。

Dim syncAgent As CustomersCacheSyncAgent = New CustomersCacheSyncAgent

    Using syncClient As New ServiceReference1.CustomersCacheSyncContractClient
    syncAgent.RemoteProvider = New Microsoft.Synchronization.Data.ServerSyncProviderProxy(syncClient)
    Dim syncStats As Microsoft.Synchronization.Data.SyncStatistics = syncAgent.Synchronize

    NorthwindDataSet.Customers.Merge(New LocalNorthwindCustomersTableAdapters.CustomersTableAdapter().GetData())

    Dim syncSummary As String = "Total changes downloaded: " & _
       syncStats.TotalChangesDownloaded.ToString() & vbCrLf & _
       "Last successful synchronization: " & _
       syncStats.SyncCompleteTime.ToString
    MessageBox.Show(syncSummary)
End Using

CustomersCacheSyncAgent syncAgent = new CustomersCacheSyncAgent();

using (ServiceReference1.CustomersCacheSyncContractClient syncClient = new ServiceReference1.CustomersCacheSyncContractClient())
{
    syncAgent.RemoteProvider = new Microsoft.Synchronization.Data.ServerSyncProviderProxy(syncClient);
    Microsoft.Synchronization.Data.SyncStatistics syncStats = syncAgent.Synchronize();
    northwindDataSet.Customers.Merge(new LocalNorthwindCustomersTableAdapters.CustomersTableAdapter().GetData());

    string syncSummary = "Total changes downloaded: " + 
    syncStats.TotalChangesDownloaded.ToString() + Environment.NewLine +
    "Last successful synchronization: " +
     syncStats.SyncCompleteTime.ToString();
    MessageBox.Show(syncSummary);
}

Customers テーブルのデータはローカルデータベースから、Orders テーブルのデータはデータサービスから取り込まれます。
フォームを閉じます。

アプリケーションのテスト

アプリケーションをテストするには

F5 キーを押します。
アプリケーションを実行している状態で、サーバーエクスプローラーまたはデータベースエクスプローラー (または他のデータベース管理ツール) を使用し、リモートサーバーデータベースに接続してレコードを変更します。
1. サーバーエクスプローラーまたはデータベースエクスプローラーで、リモートデータベースサーバー (Northwind.sdf への接続ではありません) 上の Customers テーブルを探します。
2. Customers テーブルを右クリックし、[テーブルデータの表示] をクリックします。
3. 1 つ以上のレコードを変更し、変更をコミットします (変更した行以外に移動します)。
フォームに戻り、[SyncButton] をクリックします。
リモートデータベースへの変更がローカルデータベースと同期され、グリッドに表示されることを検証します。
フォームを閉じます (デバッグを停止します)。

次の手順

n 層アプリケーションにローカルデータベースキャッシュを追加した後で、アプリケーションの要件によってはさらに操作を追加する必要があります。たとえば、このアプリケーションで行うことができる拡張には次のものがあります。

データセットに検証を追加します。詳細については、「チュートリアル : n 層データアプリケーションへの検証の追加」を参照してください。
双方向の同期を有効にします。詳細については、「方法 : ローカルデータベースとリモートデータベースで双方向同期を構成する」を参照してください。

参照

チュートリアル : ローカル データベース キャッシュを n 層アプリケーションに追加する

必須コンポーネント

NTierWalkthrough ソリューションを開く

NTierWalkthrough ソリューションを開くには

ローカル データベース キャッシュを NTierWalkthrough に追加する

プレゼンテーション層にローカル データ キャッシュを追加するには

データ同期の構成

n 層アプリケーションでデータ同期を構成するには

既存のデータ サービスで同期を有効にする

App.config ファイルにサービス情報を追加するには

同期サービス操作を既存のデータ サービスに追加するには

サービス参照を更新するには

ローカル キャッシュから Customers データを読み込むようにフォームを変更する

ローカル データベース キャッシュから Customers データを読み込むように Form1 を変更するには

アプリケーションのテスト

アプリケーションをテストするには

データの同期

ローカル データベース キャッシュとリモート データベースのデータを同期するには

アプリケーションのテスト

アプリケーションをテストするには

次の手順

参照

処理手順

概念

その他の技術情報

その他のリソース

チュートリアル : ローカルデータベースキャッシュを n 層アプリケーションに追加する

ローカルデータベースキャッシュを NTierWalkthrough に追加する

プレゼンテーション層にローカルデータキャッシュを追加するには

既存のデータサービスで同期を有効にする

同期サービス操作を既存のデータサービスに追加するには

ローカルキャッシュから Customers データを読み込むようにフォームを変更する

ローカルデータベースキャッシュから Customers データを読み込むように Form1 を変更するには

ローカルデータベースキャッシュとリモートデータベースのデータを同期するには