移行に関する注意事項 (Entity Framework)

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

ADO.NET Entity Framework には、既存のアプリケーションにとっていくつかの利点があります。中でも最も重要なものの 1 つが、エンティティデータモデル (EDM) を使用して、アプリケーションで使用するデータ構造をデータソースのスキーマから分離できることです。これにより、ストレージモデルやデータソース自体の将来の変更が容易になり、その変更を補うための変更をアプリケーションに加える必要がなくなります。エンティティフレームワークを使用する利点の詳細については、「Entity Framework の概要」を参照してください。

エンティティフレームワークの利点を活用するために既存のアプリケーションをエンティティフレームワークに移行することができます。移行作業の一部はすべてのアプリケーションに共通です。こうした共通の作業には、.NET Framework Version 3.5 Service Pack 1 (SP1) を使用するようにアプリケーションをアップグレードする作業のほか、EDM の定義や Entity Framework の構成などが含まれます。そのほか、アプリケーションをエンティティフレームワークに移行する際には、移行するアプリケーションの種類やアプリケーションの特定の機能に依存する注意点もあります。このトピックでは、既存のアプリケーションをアップグレードする際に最適な方法を選択するために役立つ情報を紹介します。

全般的な移行の注意点

アプリケーションをエンティティフレームワークに移行する際には次の点に注意してください。

.NET Framework 3.5 を使用しているアプリケーションはどれでも Entity Framework に移行できますが、アプリケーションが使用するデータソースのデータプロバイダで Entity Framework がサポートされている必要があります。
データソースプロバイダが Entity Framework をサポートしていても、そのプロバイダのすべての機能が Entity Framework でサポートされるとは限りません。
大規模なアプリケーションや複雑なアプリケーションの場合、アプリケーション全体を一度に Entity Framework に移行する必要はありません。ただし、Entity Framework を使用しない部分がアプリケーションにある場合、それらの部分については、データソースが変更された場合に変更が必要になります。
エンティティフレームワークは ADO.NET データプロバイダを使用してデータソースにアクセスするため、Entity Framework が使用するデータプロバイダ接続をアプリケーションの他の部分と共有できます (たとえば、Entity Framework は SqlClient プロバイダを使用して SQL Server データベースにアクセスします)。詳細については、「Entity Framework 用の EntityClient プロバイダ」を参照してください。

共通の移行作業

既存アプリケーションのエンティティフレームワークへの移行パスは、アプリケーションの種類と既存のデータアクセス計画の両方に依存します。ただし、以下の作業は、既存のアプリケーションをエンティティフレームワークに移行する際に常に実行する必要があります。

[!メモ]

これらの作業は、Visual Studio 2008 で Entity Data Model ツールを使用するとすべて自動的に実行されます。詳細については、「Entity Data Model ウィザードを使用する方法 (Entity Framework)」を参照してください。

アプリケーションをアップグレードします。

以前のバージョンの Visual Studio と .NET Framework を使用して作成したプロジェクトは、Visual Studio 2008 SP1 と .NET Framework 3.5 SP1 を使用するようにアップグレードする必要があります。詳細については、「Visual Studio 変換ウィザード」を参照してください。
エンティティデータモデル (EDM) を定義します。

EDM では、概念モデルのエンティティ、データソースの構造 (テーブル、ストアドプロシージャ、ビューなど)、およびエンティティとデータソースの構造とのマッピングを定義します。詳細については、「Entity Data Model を手動で定義する方法 (Entity Framework)」を参照してください。

ストレージモデルに定義されている型は、データソースのオブジェクトと名前が一致している必要があります。また、既存のアプリケーションでデータがオブジェクトとして公開されている場合は、概念モデルに定義するエンティティおよびプロパティの名前を既存のデータクラスおよびプロパティの名前に一致させる必要があります。詳細については、「カスタムオブジェクトを操作できるように Entity Data Model をカスタマイズする方法 (Entity Framework)」を参照してください。

[!メモ]

Entity Data Model デザイナを使用すると、概念モデルのエンティティの名前を既存のオブジェクトに合わせて変更できます。詳細については、「ADO.NET Entity Data Model デザイナの概要」を参照してください。
接続文字列を定義します。

エンティティフレームワークで EDM に対してクエリを実行する際には特殊な形式の接続文字列を使用します。この接続文字列には、EDM マッピングファイルに関する情報とデータソースへの接続に関する情報がカプセル化されます。詳細については、「接続文字列を定義する方法 (Entity Framework)」を参照してください。
Visual Studio プロジェクトを構成します。

エンティティフレームワークアセンブリへの参照と EDM を Visual Studio プロジェクトに追加する必要があります。これらのマッピングファイルをプロジェクトに追加することで、接続文字列で指定された場所にアプリケーションと共に配置されるようにすることができます。詳細については、「Entity Framework プロジェクトを手動で構成する方法」を参照してください。

既存のオブジェクトを含むアプリケーションの注意点

アプリケーションをエンティティフレームワークに移行する場合、既存のデータクラスの移行方法は、そのクラスに実装されているビジネスロジック、カスタムメソッド、およびプロパティ検証によって決まります。次の中から既存のデータクラスの移行方法を選択してください。

オブジェクトプロパティの取得と設定のみを行うデータクラスは、エンティティデータモデルツールによって生成されるエンティティ型に置き換えます。詳細については、「Entity Data Model ウィザードを使用する方法 (Entity Framework)」を参照してください。
データクラスにカスタム検証コードやその他のビジネスロジックが実装されている場合は、エンティティデータモデルツールによって生成される部分クラスにそのロジックを移行します。エンティティデータモデルツールではエンティティ型が部分クラスとして生成されるため、既存のクラスを部分クラスに変換することによってメソッドとプロパティを再利用できます。その際には、生成されたクラスの重複するプロパティを既存のアプリケーションから削除する必要があります。部分クラスを作成する方法の詳細については、「オブジェクトのカスタマイズ (Entity Framework)」を参照してください。

データクラスの各プロパティについて、OnPropertyNameChanging と OnPropertyNameChanged という部分メソッドがエンティティフレームワークツールによって生成されます。既存のプロパティ検証コードをこれらの部分メソッドに移行できます。詳細については、「プロパティの変更時にビジネスロジックを実行する方法 (Entity Framework)」を参照してください。
大量のカスタムコードがあるなどの理由で既存のデータクラスを保持したい場合は、次のいずれかの作業を行う必要があります。
- EntityObject クラスか ComplexObject クラスを継承するようにデータクラスを変更します。生成される EDM 型はすべて EntityObject か ComplexObject を継承するため、これらの基本クラスを継承することによってエンティティフレームワークでカスタムデータクラスを使用できます。EDM でカスタムデータクラスを使用する場合は、この方法をお勧めします。詳細については、「オブジェクトのカスタマイズ (Entity Framework)」を参照してください。
- データクラスを変更して一連のインターフェイスを実装します。データクラスで EntityObject や ComplexObject を継承できない場合にこの方法を使用します。これらのインターフェイスの実装方法については、「オブジェクトのカスタマイズ (Entity Framework)」を参照してください。

[!メモ]

EDM で既存のデータクラスや部分クラスを使用する場合は、概念モデルに定義されているエンティティ名がクラス名と一致している必要があります。エンティティの名前を変更するにはエンティティデザイナを使用します。詳細については、「エンティティ型を作成および変更する方法」を参照してください。

ADO.NET プロバイダを使用するアプリケーションの注意点

SqlClient などの ADO.NET プロバイダを使用すると、データソースに対するクエリを実行して表形式のデータを取得できます。データを ADO.NET DataSet に読み込むこともできます。以下は、既存の ADO.NET プロバイダを使用するアプリケーションをアップグレードする場合の注意点です。

データリーダーを使用して表形式のデータを表示している場合
EntityClient プロバイダを使用して Entity SQL クエリを実行して、返された EntityDataReader オブジェクトを列挙処理することも考えられますが、この方法を使用するのは、データリーダーを使用して表形式のデータを表示するアプリケーションで、データをオブジェクトに具体化したり、変更を追跡したり、更新を行ったりするための Object Services の機能が不要である場合だけにしてください。データソースを更新する既存のデータアクセスコードも引き続き使用できますが、EntityConnection の StoreConnection プロパティから既存の接続にアクセスできます。詳細については、「Entity Framework 用の EntityClient プロバイダ」を参照してください。

DataSet を使用している場合
エンティティフレームワークでは、メモリへの保持、変更の追跡、データバインド、オブジェクトの XML データとしてのシリアル化など、DataSet によって提供される機能の多くが Object Services によって提供されます。詳細については、「Object Services の概要 (Entity Framework)」を参照してください。

アプリケーションで必要な DataSet の機能が Object Services によって提供されていない場合も、LINQ to DataSet を使用して LINQ クエリを活用することができます。詳細については、「LINQ to DataSet」を参照してください。

データをコントロールにバインドするアプリケーションの注意点

.NET Framework では、データをデータソース (DataSet や ASP.NET データソースコントロールなど) にカプセル化して、それらのデータコントロールにユーザーインターフェイス要素をバインドすることができます。以下は、コントロールを Entity Framework データにバインドする場合の注意点です。

コントロールへのデータバインド
EDM に対してクエリを実行すると、データが Object Services によって、エンティティ型のインスタンスであるオブジェクトとして返されます。それらのオブジェクトは直接コントロールにバインドでき、そのバインドで更新がサポートされます。したがって、SaveChanges メソッドが呼び出されると、コントロールのデータ (DataGridView の行など) に対する変更が自動的にデータベースに保存されます。

クエリの結果を列挙して、データバインドをサポートする DataGridView などのコントロールにデータを表示するアプリケーションは、そのコントロールを ObjectQuery の結果にバインドするように変更できます。

詳細については、「コントロールへのオブジェクトのバインド (Entity Framework)」を参照してください。

ASP.NET データソースコントロール
エンティティフレームワークには、ASP.NET Web アプリケーションのデータバインドを単純化するために作られたデータソースコントロールが含まれています。詳細については、「Entity Framework データソースコントロール」を参照してください。

その他の注意点

以下は、特定の種類のアプリケーションを Entity Framework に移行する場合の注意点です。

データサービスを公開するアプリケーション
Windows Communication Foundation (WCF) をベースとする Web サービスやアプリケーションは、XML 要求/応答メッセージ形式を使用して基になるデータソースのデータを公開します。エンティティフレームワークでは、バイナリ、XML、または WCF データコントラクトのシリアル化を使用してエンティティオブジェクトをシリアル化できます。バイナリシリアル化と WCF シリアル化ではオブジェクトグラフの完全なシリアル化がサポートされています。詳細については、「Web サービスおよび Entity Data Model (アプリケーションシナリオ)」を参照してください。

XML データを使用するアプリケーション
オブジェクトのシリアル化を使用すると、XML データを使用するアプリケーション (AJAX ベースのインターネットアプリケーションなど) にデータを提供するエンティティフレームワークデータサービスを作成できます。このようなケースでは ADO.NET Data Services の使用を検討してください。これらのデータサービスは EDM に基づいており、GET、PUT、POST などの標準の Representational State Transfer (REST) HTTP アクションを使用したエンティティデータへの動的アクセスを提供します。詳細については、「ADO.NET Data Services フレームワーク」を参照してください。

エンティティフレームワークはネイティブ XML データ型をサポートしていません。そのため、XML 列を持つテーブルにエンティティをマップすると、その XML 列に対応するエンティティプロパティは文字列になります。このような場合は、オブジェクトを切断して XML としてシリアル化することができます。詳細については、「オブジェクトのシリアル化 (Entity Framework)」を参照してください。

アプリケーションで XML データのクエリ機能が必要な場合も、LINQ to XML を使用して LINQ クエリを活用することができます。詳細については、「LINQ to XML」を参照してください。

状態を保持するアプリケーション
ASP.NET Web アプリケーションでは、Web ページやユーザーセッションの状態を保持しなければならないことがよくあります。ObjectContext インスタンス内のオブジェクトは、クライアントのビューステートやサーバーのセッション状態に格納できます。格納したオブジェクトを取得して新しいオブジェクトコンテキストに再アタッチすることもできます。詳細については、「オブジェクトのアタッチ (Entity Framework)」を参照してください。

次の方法で共有