チュートリアル: ASP.NET アプリケーションでのドメインサービスの使用

[アーティクル]
03/11/2011

ASP.NET が提供する DomainSourceControl コントロールは、データベースにアクセスし、ユーザーが作成、読み取り、更新、および削除 (CRUD) 操作を実行できるようにするために、GridView コントロールなどのデータバインドコントロールによって使用されます。

ドメインサービスを使用すると、特定のデータベースモデルからアプリケーションをデタッチできる点に注目してください。その結果、ビジネスロジック、および別のモデルに容易に移植できるコードの作成に重点を置くことができるという利点があります。

WCF RIA サービスドメインサービスは、サーバーで実行され、クエリ、変更、およびカスタム操作のためのデータへのアクセスを制御するアプリケーションロジックを記述するためのパターンを提供します。また、Silverlight クライアントと ASP.NET サーバーアプリケーションを統合して、データ検証、認証、役割などの一般的なタスクに対するエンドツーエンドのサポートも提供します。

このチュートリアルでは、RIA サービスドメインサービスを使用して ASP.NET Web ページからデータベースにアクセスする方法について説明します。このチュートリアルでは ASP.NET のドメインサービスについて説明しますが、ASP.NET 以外のアプリケーションでもドメインサービスを使用できます。このチュートリアルでは、ASP.NET サーバーと Silverlight クライアントアプリケーションの統合については説明しません。

このチュートリアルには、次の手順が含まれています。

ASP.NET Web アプリケーションの作成
ドメインサービスの使用
ドメインサービスのテスト

前提条件

このチュートリアル、および RIA サービスのドキュメントで紹介されている他のチュートリアルでは、WCF RIA サービスおよび WCF RIA サービス Toolkit に加え、Visual Studio 2010 や Silverlight の開発者向けランタイムと SDK など、前提条件となっているいくつかのプログラムが適切にインストールおよび構成されている必要があります。また、SQL Server 2008 R2 Express with Advanced Services をインストールして構成し、AdventureWorks OLTP と LT データベースをインストールすることも必要です。

これらの各前提条件を満たしているかどうかを確認するための詳細な手順については、「WCF RIA Services の前提条件」ノード内のトピックを参照してください。このチュートリアルを進める前に、トピックに記載されている手順に従って、この RIA サービスチュートリアルを実行するときに発生する問題をできるだけ最小限に抑えるようにします。

ASP.NET Web アプリケーションの作成

ドメインサービスを使用するには、データベースと対話できる ASP.NET Web アプリケーションを作成する必要があります。実行する必要がある手順は、次のとおりです。

Web アプリケーションの作成。これによって、ドメインサービスを使用する環境が用意されます。
アプリケーションへのデータベースの追加。これによって、Web アプリケーションのデータベースを選択できます。
データベースモデルの作成。CLR 型のデータベースエンティティを含むモデルを作成します。これらの型は、データベースと対話するためにドメインサービスによって使用されます。ADO.NET Entity Framework または LINQ to SQL データモデルを使用できます。

ASP.NET Web アプリケーションを作成する方法を次の手順に示します。

ASP.NET Web アプリケーションを作成するには

Visual Studio 2010 で、[ファイル] メニューの [新規作成] をポイントし、[プロジェクト] をクリックします。

[新しいプロジェクト] ダイアログボックスが表示されます。
[インストールされたテンプレート] で [Visual C#] または [Visual Basic] を展開し、[Web] をクリックします。
テンプレートの一覧で、[ASP.NET 空の Web アプリケーション] をクリックします。
プロジェクトに UsingDomainService という名前を付け、場所を指定して、[OK] をクリックします。
アプリケーションをビルドします。

データベースをアプリケーションに追加する方法を次の手順に示します。このデータベースには、表示および編集するためにアクセスするテーブルが含まれています。

データベースを Web アプリケーションに追加するには

ソリューションエクスプローラーで、プロジェクト名を右クリックし、[追加]、[ASP.NET フォルダーの追加] を順にポイントして、[App_Data] をクリックします。

App_Data フォルダーがプロジェクトに追加されます。
App_Data フォルダーを右クリックし、[追加] をポイントして、[既存の項目] をクリックします。

[既存項目の追加] ダイアログボックスが表示されます。
AdventureWorksLT データベースファイル (AdventureWorksLT_Data.mdf) の場所を指定します。

[既存項目の追加] ダイアログボックスを次の図に示します。
[追加] をクリックします。

これにより、プロジェクトにデータベースファイルのコピーが作成されます。詳細については、「方法: .MDF ファイルを使用して AdventureWorksLT データベースに接続する」を参照してください。

データベーステーブルを表すクラスを含むデータモデルを作成する方法を次の手順に示します。このチュートリアルでは、ADO.NET Entity Framework データモデルを使用します。ただし、LINQ to SQL データモデルを使用することもできます。

データモデルを作成するには

ソリューションエクスプローラーで、プロジェクト名を右クリックし、[追加] をポイントして、[新しい項目] をクリックします。

[新しい項目の追加] ダイアログボックスが表示されます。
[インストールされたテンプレート] で、[データ] をクリックします。
テンプレートの一覧で、[ADO.NET Entity Data Model] をクリックします。
データベースモデルに AdventureWorksLT.edmx という名前を付け、[追加] をクリックします。

Entity Data Model ウィザードが表示されます。
[モデルのコンテンツの選択] 画面で、[データベースから生成] をクリックします。

[モデルのコンテンツの選択] ダイアログボックスを次の図に示します。
[次へ] をクリックします。
[データ接続の選択] 画面で、[アプリケーションがデータベースへの接続に使用するデータ接続] ボックスの一覧の [AdventureWorksLT_Data.mdf] をクリックします。
[エンティティ接続設定に名前を付けて Web.Config に保存] チェックボックスがオンになっていることを確認します。既定の接続文字列名はそのままにしておいてかまいません。

[データ接続の選択] ダイアログボックスを次の図に示します。
[次へ] をクリックします。

モデルに追加するデータベースオブジェクトを指定するためのページが表示されます。
[データベースオブジェクトの選択] 画面で、[テーブル] ノードを選択してデータベースのすべてのテーブルを選択します。

[データベースオブジェクトの選択] ダイアログボックスを次の図に示します。
[モデルに外部キー列を含める] チェックボックスがオンになっていることを確認します。既定のモデルの名前空間はそのままにしておいてかまいません。
[完了] をクリックします。

ADO.NET Entity Data Model デザイナーが表示されます。これで、AdventureWorksLT データベースを表すデータモデルが作成されました。
デザイナーを閉じます。
アプリケーションをビルドします。

ビルドすることによって、次の手順で、ドメインサービスで AdventureWorksLT_DataEntities コンテキストクラスを使用できるようになります。

ドメインサービスの使用

この手順では、ASP.NET アプリケーションでドメインサービスを使用するために実行する必要がある手順について説明します。実行する必要がある手順は、次のとおりです。

プロジェクトへのドメインサービスクラスの追加。これによって、アプリケーションによる CRUD データベース操作の実行を可能にするクラスが作成されます。また、非常に重要な点として、ビジネスロジックを追加できるようになります。このクラスは、サーバーまたは中間層で動作します。
ビジネスロジックの作成。ドメインサービスクラスにコード (ビジネスロジック) を追加します。
DomainDataSource コントロールの宣言。ページマークアップでこの手順を行って、ユーザーがデータベースと対話できるようにします。このコントロールは、クライアントまたはプレゼンテーション層で動作します。

プロジェクトにドメインデータサービスを追加する方法を次の手順に示します。

プロジェクトにドメインサービスクラスを追加するには

ソリューションエクスプローラーで、プロジェクト名を右クリックし、[追加] をポイントして、[新しい項目] をクリックします。
[インストールされたテンプレート] で、[Web] をクリックします。
テンプレートの一覧で、[DomainService クラス] をクリックします。
ファイルに AdventureWorksDomainService.cs または AdventureWorksDomainService.vb という名前を付け、[追加] をクリックします。

[新しいドメインサービスクラスの追加] ダイアログボックスが表示されます。[ドメインサービスクラス名] ボックスには、指定した名前が含まれています。
[クライアントアクセスを有効にする] チェックボックスをオンにします。
[使用できる DataContext/ObjectContext クラス] ボックスの一覧の [AdventureWorksLT_DataEntities (Entity Framework)] をクリックします。ドロップダウンリストが空の場合、アプリケーションはビルドされていません。[新しいドメインサービスクラスの追加] ダイアログボックスを閉じ、アプリケーションをビルドして、前の手順を繰り返します。
[エンティティ] ボックスの一覧の Product テーブルのチェックボックスをオンにします。
Product テーブルの [編集を有効にする] チェックボックスをオンにします。
[メタデータ用の関連クラスを生成する] チェックボックスをオンにします。

[新しいドメインサービスクラスの追加] ダイアログボックスを次の図に示します。
[OK] をクリックします。

AdventureWorksDomainService クラスと関連メタデータファイルが作成されます。このクラスには、データベースの CRUD 操作を可能にするメソッドが含まれています。ビジネスロジックを含むようにクラスとメタデータファイルの両方を変更できます。次の手順では、単純な例について説明します。プロジェクトへの参照は必要なアセンブリを含むように更新されていて、Web.config ファイルは必要な構成要素をすべて含むように更新されている点に注意してください。
[ファイル] メニューの [すべてを保存] をクリックします。

ビジネスロジックを含むように AdventureWorksDomainService クラスと関連メタデータファイルをカスタマイズする方法を次の手順に示します。カスタマイズは非常に単純ですが、実行できる変更について理解できます。

ビジネスロジックを作成するには

ソリューションエクスプローラーで、AdventureWorksDomainService.cs ファイルまたは AdventureWorksDomainService.vb ファイルを開きます。

次のコードに示すように、ListPrice フィールドの検証ロジックを含むように UpdateProduct メソッドを変更します。また、現在の日付を使用して ModifiedDate フィールドを更新します。

public void UpdateProduct(Product currentProduct)
{
  if ((currentProduct.EntityState == EntityState.Detached))
  {
    // Custom logic: set a lower limit for the price.
    if (currentProduct.ListPrice < 5)
      throw new ValidationException("The list price must be >= 5.");
    this.ObjectContext.Products.AttachAsModified(currentProduct,
       this.ChangeSet.GetOriginal(currentProduct));
    // Custom logic: set the date to the current value.
    currentProduct.ModifiedDate = DateTime.Today;
  }
}

Public Sub UpdateProduct(ByVal currentProduct As Product)
  If (currentProduct.EntityState = EntityState.Detached) Then
    ' Custom logic: set a lower limit for the price.
    If currentProduct.ListPrice < 5 Then
      Throw New ValidationException("The list price must be >= 5.")
    End If
    Me.ObjectContext.Products.AttachAsModified(currentProduct, _
      Me.ChangeSet.GetOriginal(currentProduct))
    ' Custom logic: set the date to the current value.
    currentProduct.ModifiedDate = DateTime.Today
  End If
End Sub

検証が失敗すると、例外が発生し、ユーザーに表示されるページにエラーメッセージが送信されます。

次のコードに示すように、Entity Framework が正しく機能するように、GetProducts メソッドを変更して順序付けのロジックを設定します。

public IQueryable<Product> GetProducts()
{
  return this.ObjectContext.Products.OrderBy(p => p.ProductID);
}

Public Function GetProducts() As IQueryable(Of Product)
  Return Me.ObjectContext.Products.OrderBy(Function(p) p.ProductID)
End Function

ファイルを保存して閉じます。
ソリューションエクスプローラーで、AdventureWorksDomainService.metadata.cs ファイルまたは AdventureWorksDomainService.metadata.vb ファイルを開きます。
次のコードに示すように、Color データフィールドエンティティに Required 属性を追加します。

この属性を指定して、データベースで許可されているようにデータフィールドが空にならないようにします。ユーザーが空の文字列を入力した場合、エラーが発生します。
```
[Required(AllowEmptyStrings=false, 
  ErrorMessage="Color is required")]
public string Color{ get; set; }
```
```
<Required(AllowEmptyStrings:=False, ErrorMessage:="Color is required")> _
Public Property Color As String
```
メタデータファイルを保存して閉じます。
アプリケーションをビルドします。

ユーザーがデータベースと対話できるように、ページマークアップで DomainDataSource コントロールを宣言する方法を次の手順に示します。

ページで DomainDataSource コントロールを宣言するには

ソリューションエクスプローラーで、プロジェクト名を右クリックし、[追加] をポイントして、[新しい項目] をクリックします。
[インストールされたテンプレート] で、[Web] をクリックします。
テンプレートの一覧で、[Web フォーム] をクリックします。
ファイルに Default.aspx という名前を付け、[追加] をクリックします。
デザインビューで Default.aspx を開きます。
ツールボックスの [全般] グループまたは [データ] グループから、DomainDataSource コントロールをページに追加します。

DomainDataSource が表示されて、[DomainDataSource タスク] メニューが開きます。

このコントロールが一覧に表示されない場合は、[ツール] メニューの [ツールボックスアイテムの選択] をクリックします。[ツールボックスアイテムの選択] ダイアログボックスで [.NET Framework コンポーネント] タブをクリックし、[DomainDataSource] チェックボックスをオンにして、[OK] をクリックします。
[DomainDataSource タスク] メニューの [データソースの構成] をクリックします。

データソースの構成ウィザードが表示されます。
[ドメインサービスの選択] 画面の [ドメインサービスの種類] ボックスで、UsingDomainService.AdventureWorksDomainService を作成したクラスを選択します。

[ドメインサービスの選択] 画面を次の図に示します。
[次へ] をクリックします。
[データアクセスの構成] 画面で、IQueryable<Product> GetProducts() メソッドを選択します。
[挿入を有効にする] チェックボックス、[更新を有効にする] チェックボックス、および [削除を有効にする] チェックボックスをオンにします。

[データアクセスの構成] 画面を次の図に示します。
[完了] をクリックします。
ツールボックスの [データ] タブから、GridView コントロールをページに追加します。

GridView が表示されて、[GridView タスク] メニューが開きます。
[GridView タスク] メニューの [データソースの選択] ボックスの一覧の [DomainDataSource1] をクリックします。

これは、前の手順で作成した DomainDataSource コントロールの ID です。
[GridView タスク] メニューの [列の編集] をクリックします。

[フィールド] ダイアログボックスが表示されます。
[自動生成フィールド] チェックボックスをオフにします。
[選択されたフィールド] ペインで、[Name]、[Color]、[ListPrice]、および [ModifiedDate] 以外のすべてのフィールドを削除します。
[OK] をクリックします。
必要に応じて、[GridView タスク] メニューで、関連するチェックボックスをオンにしてページング、並べ替え、および選択を有効にします。
ファイルを保存し、ソース ビューに切り替えます。
GridView を選択します。
[プロパティ] ウィンドウで、DataKeyNames プロパティに、表示されないすべての列をコンマで区切って、「ProductID, ProductNumber, StandardCost,Size, Weight,ProductCategoryID, ProductModelID, SellStartDate, SellEndDate, DiscontinuedDate, ThumbNailPhotoFileName, rowguid」のように指定します。

この作業は、CRUD 操作を実行するために DomainDataSource コントロールによって必要とされます。
AutoGenerateEditButton プロパティを True に設定して、テーブルの行の編集および削除を有効にします。

ソースビューで、Columns 要素を次のマークアップに置き換えます。

カスタムテンプレートを使用すると、このマークアップによって Color および ListPrice データフィールドの値を検証してからポストバックでサーバーに送信することができます。また、行の削除を実行する前にユーザーのアクセス許可を確認する LinkButton 削除コントロールも作成されます。

  <Columns>
    <asp:TemplateField>
      <ItemTemplate>
        <asp:LinkButton ID="LinkButton1"  CommandName="Delete" Text="Delete"
          ForeColor="#333333"  OnClientClick='return confirm("Are you sure you want to delete this row?");'/>
      </ItemTemplate>
    </asp:TemplateField>

    <asp:CommandField ShowSelectButton="True" />
    <asp:BoundField DataField="Name" HeaderText="Name" SortExpression="Name" />
    <asp:TemplateField>
      <HeaderTemplate>Color</HeaderTemplate>
      <ItemTemplate>
        <%# Eval("Color") %>
      </ItemTemplate>
      <EditItemTemplate>
        <asp:TextBox ID="ColorID"  Text='<%# Bind("Color") %>'/>
        <cc1:DomainValidator ID="DomainValidator2"   DataField="Color"/>
      </EditItemTemplate>
    </asp:TemplateField>

    <asp:TemplateField>
      <HeaderTemplate>ListPrice</HeaderTemplate>
      <ItemTemplate>
        <%# Eval("ListPrice")%>
      </ItemTemplate>
      <EditItemTemplate>
        <asp:TextBox ID="ListPriceID"  Text='<%# Bind("ListPrice") %>'/>
        <cc1:DomainValidator ID="DomainValidator3"  DataField="ListPrice"/>
       </EditItemTemplate>
     </asp:TemplateField>

     <asp:BoundField DataField="ModifiedDate" HeaderText="ModifiedDate" SortExpression="ModifiedDate" />
  </Columns>

GridView コントロールの前に次のマークアップを追加して、検証エラーが表示されるようにします。
```
<asp:ValidationSummary ID="ValidationSummary1"  />
<cc1:DomainValidator  ControlToValidate="GridView1"/>
```
Default.aspx ファイルを保存します。
アプリケーションをビルドします。

ドメインサービスのテスト

この手順では、GridView コントロールを使用してドメインサービスの機能をテストする方法について説明します。この手順では、次の点を確認します。

カスタムビジネスロジックを介したデータベースとの対話が、予期したとおりに機能すること。
ASP.NET によって、ユーザーがデータベースフィールドに加えた変更が実行されること。
ASP.NET によって、カスタムロジックによって生成されたエラーメッセージが表示されること。

ドメインサービスのテスト

ソリューションエクスプローラーで、Default.aspx ページを右クリックし、[ブラウザーで表示] をクリックします。

Product テーブルを表示するページがブラウザーに表示されます。
任意の行の [編集] をクリックし、5 未満の値を入力して ListPrice 列の値を変更します。
同じ行の [更新] をクリックします。

フィールドに 5 以上の値を入力する必要があることを示すカスタムエラーが表示されます。
同じ行で、ListPrice 列に 5 より大きい値を入力します。
同じ行の [更新] をクリックします。

ASP.NET によって、データベースの ListPrice および ModifiedDate データフィールドが更新されます。
任意の行の [編集] をクリックし、空の文字列を入力して Color 列の値を変更します。
同じ行の [更新] をクリックします。

ASP.NET によって、カスタム検証エラーが表示されます。
同じ行で、Color 列に空でない文字列値を入力します。
同じ行の [更新] をクリックします。

ASP.NET によって、データベースの Color および ModifiedDate データフィールドが更新されます。

次の方法で共有

チュートリアル: ASP.NET アプリケーションでのドメインサービスの使用

前提条件

ASP.NET Web アプリケーションの作成

ASP.NET Web アプリケーションを作成するには

データベースを Web アプリケーションに追加するには

データモデルを作成するには

ドメインサービスの使用

プロジェクトにドメインサービスクラスを追加するには

ビジネスロジックを作成するには

ページで DomainDataSource コントロールを宣言するには

ドメインサービスのテスト

ドメインサービスのテスト

参照

処理手順

概念

その他のリソース

次の方法で共有

チュートリアル: ASP.NET アプリケーションでのドメイン サービスの使用

前提条件

ASP.NET Web アプリケーションの作成

ASP.NET Web アプリケーションを作成するには

データベースを Web アプリケーションに追加するには

データ モデルを作成するには

ドメイン サービスの使用

プロジェクトにドメイン サービス クラスを追加するには

ビジネス ロジックを作成するには

ページで DomainDataSource コントロールを宣言するには

ドメイン サービスのテスト

ドメイン サービスのテスト

参照

処理手順

概念

その他のリソース

チュートリアル: ASP.NET アプリケーションでのドメインサービスの使用

データモデルを作成するには

ドメインサービスの使用

プロジェクトにドメインサービスクラスを追加するには

ビジネスロジックを作成するには

ドメインサービスのテスト

ドメインサービスのテスト