自己追跡エンティティの使用

[アーティクル]
02/24/2011

Entity Framework アプリケーションでは、オブジェクトグラフ内のエンティティの変更はオブジェクトコンテキストによって追跡されます。ただし、N 層シナリオでは、エンティティを変更する層でオブジェクトコンテキストを利用できない場合があります。.NET Framework Version 4 以降では、自己追跡エンティティを使用してすべての層で変更を追跡できるようになりました。

注 :
自己追跡エンティティは、オブジェクトグラフに対する変更が行われる層でオブジェクトコンテキストを利用できない場合にのみ使用します。オブジェクトコンテキストを利用できる場合は、EntityObject 派生型、POCO ("plain-old" CLR object) 型、または POCO プロキシ型を使用します。詳細については、「オブジェクトの使用 (Entity Framework)」を参照してください。

自己追跡エンティティは、オブジェクトグラフに対する変更が行われる層でオブジェクトコンテキストを利用できない場合にのみ使用します。オブジェクトコンテキストを利用できる場合は、EntityObject 派生型、POCO ("plain-old" CLR object) 型、または POCO プロキシ型を使用します。詳細については、「オブジェクトの使用 (Entity Framework)」を参照してください。

Microsoft Visual Studio 2010 以降では、自己追跡エンティティは、ADO.NET Self-Tracking Entity ジェネレーター テンプレートによって生成されます。このテンプレート項目は、<モデル名>.tt および <モデル名>.Context.tt という 2 つの .tt (テキストテンプレート) ファイルを生成します。<モデル名>.tt ファイルは、エンティティ型と、自己追跡エンティティが使用する変更追跡ロジックおよび自己追跡エンティティで状態設定が可能な拡張メソッドを含むヘルパークラスを生成します。<モデル名>.Context.tt ファイルは、型指定された ObjectContext と、ObjectContext クラスおよび ObjectSet クラスの ApplyChanges メソッドを含む拡張クラスを生成します。これらのメソッドは、自己追跡エンティティのグラフに含まれている変更追跡情報を検証して、データベースに変更内容を保存するために実行しなければならない一連の操作を推論します。詳細については、「ADO.NET Self-Tracking Entity Generator Template」を参照してください。

注 :
サービスは、信頼されていないクライアントからの、または信頼されていないチャネルを経由した、データの取得または更新の要求を信頼しません。クライアントは認証されている必要があります。また、セキュリティで保護されたチャネルまたはメッセージエンベロープを使用する必要があります。クライアントによるデータの取得または更新の要求は、特定のシナリオに対して予想される正当な変更に準拠することを確認するために検証する必要があります。

サービスは、信頼されていないクライアントからの、または信頼されていないチャネルを経由した、データの取得または更新の要求を信頼しません。クライアントは認証されている必要があります。また、セキュリティで保護されたチャネルまたはメッセージエンベロープを使用する必要があります。クライアントによるデータの取得または更新の要求は、特定のシナリオに対して予想される正当な変更に準拠することを確認するために検証する必要があります。

注 :
機密情報 (社会保障番号など) をエンティティキーとして使用しないでください。これにより、完全に信頼されていないクライアントに自己追跡エンティティのグラフ内の機密情報が誤ってシリアル化される可能性が低くなります。独立した関連付けでは、シリアル化される情報に関連するエンティティの元のキーは、クライアントにも送信される可能性があります。

機密情報 (社会保障番号など) をエンティティキーとして使用しないでください。これにより、完全に信頼されていないクライアントに自己追跡エンティティのグラフ内の機密情報が誤ってシリアル化される可能性が低くなります。独立した関連付けでは、シリアル化される情報に関連するエンティティの元のキーは、クライアントにも送信される可能性があります。

自己追跡エンティティの拡張メソッド

自己追跡エンティティに適用できる拡張メソッドを次に示します。1 つのエンティティではなくエンティティのセットでこれらの操作を実行する場合は、「自己追跡エンティティのセットの使用」で詳細について参照してください。

StartTracking メソッド

StartTracking メソッドは、エンティティに適用された変更の記録を開始するようにエンティティの変更トラッカーに指示します。これには、スカラープロパティ、コレクション、および他のエンティティへの参照に対する変更が含まれます。自己追跡エンティティは、Windows Communication Foundation (WCF) を通じてクライアントに逆シリアル化されると自動的に追跡を開始します。また、次のシナリオで新しく作成されたエンティティに対しても、追跡が有効になります。

新しいエンティティと既に変更を追跡しているエンティティとの間にリレーションシップが作成される場合。
エンティティで MarkAs[State] メソッドまたは AcceptChanges メソッドが呼び出される場合。

StopTracking メソッド

StopTracking メソッドは、変更の記録を停止します。

MarkAs メソッド

すべての MarkAs メソッドは追跡を有効にします。これらの拡張メソッドにより、エンティティの状態を Added、Modified、Deleted、および Unchanged に明示的に変更することが容易になります。

MarkAs[State] メソッドは、このメソッドが適用されるエンティティを、状態を変更して返します。エンティティの状態を Unchanged に変更する例を次に示します。

department.Course = new Course { CourseID = courseID }.MarkAsUnchanged();

MarkAsAdded メソッドは、エンティティの状態を Added に変更します。新しい自己追跡エンティティは、変更の追跡が無効になっている Added 状態で作成されます。

MarkAsDeleted メソッドは、エンティティの状態を Deleted に変更します。また、このメソッドは、削除対象としてマークされているエンティティのナビゲーションプロパティをクリアします。ナビゲーションプロパティが参照オブジェクトを指している場合、このプロパティは null に設定されます。ナビゲーションプロパティがコレクションを表す場合は、Clear メソッドが呼び出されます。コレクションに含まれるオブジェクトで MarkAsDeleted が呼び出されると、そのオブジェクトがコレクションから削除されます。コレクション内の各オブジェクトを削除済みとしてマークするには、コレクションのコピーのオブジェクトをマークします。コレクションのコピーを取得するには、次の例に示すように、コレクションで ToArray() メソッドまたは ToList() メソッドを呼び出します。

List<Course> courses = department.Courses.ToList();

foreach (var c in courses)

{

// Mark each course in the department as Deleted.

c.MarkAsDeleted();

}

MarkAsModified メソッドは、エンティティの状態を Modified に変更します。また、変更の追跡が有効になっているエンティティのプロパティの値を変更すると、状態は Modified に設定されます。

MarkAsUnchanged メソッドは、エンティティの状態を Unchanged に変更します。また、AcceptChanges はエンティティの変更追跡情報をクリアし、その状態を Unchanged に変更します。

AcceptChanges

AcceptChanges メソッドは、エンティティの変更追跡情報をクリアし、その状態を Unchanged に変更します。リレーションシップの状態をリセットする場合は、そのリレーションシップに参加している 2 つのエンティティで AcceptChanges を呼び出します。

ObjectContext 拡張メソッド

ApplyChanges メソッドは、自己追跡エンティティのグラフに含まれている変更追跡情報を検証して、データベースに変更内容を反映するために実行する必要のある一連の操作を推論します。ObjectContext 用と ObjectSet 用の 2 つの ApplyChanges メソッドがあります。

注 :
機密データを含む例外メッセージがクライアント層に反映されないように、サーバー層での ApplyChanges および SaveChanges の呼び出しを例外処理コードにラップする必要があります。