リレーションシップの定義と管理 (Entity Framework)

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

Entity Framework では、アソシエーションを使用してエンティティどうしを関連付けることができます。このエンティティ間のリレーションシップは、概念モデルの Association 要素で定義されます。各リレーションシップには、エンティティ型と型の多重度 (1、0 または 1、多) について説明した 2 つの End が含まれています。リレーションシップは、リレーションシップのどちらの End がプリンシパルロールでどちらの End が依存しているかを記した参照制約によって管理することができます。

.NET Framework バージョン 4 からは概念モデルに外部キーを含めることができるようになりました。 Entity Data Model ウィザードの [モデルに外部キー列を含める] オプションは既定で選択されています。このオプションを選択すると、生成されたエンティティオブジェクトには、外部キー列にマッピングするスカラープロパティが含まれています。外部キープロパティを含めることにより、依存オブジェクトの外部キーの値を変更してリレーションシップを作成または変更することができます。このような種類のアソシエーションは外部キーアソシエーションと呼ばれます。

外部キー列が概念モデルに含まれていない場合、アソシエーション情報は独立したオブジェクトとして管理されます。リレーションシップは外部キープロパティではなくオブジェクト参照によって追跡され、ObjectStateManager で ObjectStateEntry オブジェクトとして表されます。このような種類のアソシエーションは独立アソシエーションと呼ばれます。独立アソシエーションを変更するには、アソシエーションに参加する各エンティティ用に生成されるナビゲーションプロパティを変更するのが最も一般的な方法です。

いずれのアソシエーションでも、各オブジェクトは参加する各リレーションシップに対してナビゲーションプロパティを持つことができます。ナビゲーションプロパティを使用すると、リレーションシップ内を両方向に移動して管理し、多重度が 1 またはゼロか 1 の場合には参照オブジェクトを返し、多重度が多数の場合にはオブジェクトのコレクションを返すことができます。

リレーションシップの混在

モデルでは 1 つまたは両方のアソシエーションを使用するよう選択することができます。ただし外部キーのみが含まれるテーブル (純粋結合テーブルとも呼ぶ) をモデルに含めた場合、モデルで外部キーアソシエーションを使用するように指定しても、独立アソシエーションを使用して純粋多対多リレーションシップが管理されます。 Entity Data Model ウィザードでは純粋結合テーブルにマップするエンティティは作成されません。

リレーションシップの作成および変更

Entity Framework では、複数の方法でリレーションシップを作成および変更できます。

新しいオブジェクトをナビゲーションプロパティに割り当てる。次のコードでは、order エンティティと customer エンティティのリレーションシップを使用します。オブジェクトがオブジェクトコンテキストにアタッチされていると、order は customer.Orders コレクションに追加され、order オブジェクトの対応する外部キープロパティは顧客のキープロパティ値に設定されます。
```
order.Customer = customer 
```
エンティティコレクションのオブジェクトを削除または追加する。たとえば、Add メソッドを使用して Order 型のオブジェクトを customer.Orders コレクションに追加します。この操作は、特定の order および customer の間のリレーションシップを作成します。オブジェクトがオブジェクトコンテキストにアタッチされていると、order オブジェクトの顧客参照および外部キープロパティは適切な customer に設定されます。
```
customer.Orders.Add(order)
```
外部キーアソシエーションでは、次の例に示すように、外部キープロパティに新しい値を割り当てることができます。参照が追加済み状態である場合、SaveChanges が呼び出されるまで参照ナビゲーションプロパティは新しいオブジェクトのキー値と同期がとられません。同期が行われない理由は、追加されたオブジェクトが保存されるまでオブジェクトコンテキストに永久キーが含まれていないからです。詳細については、「エンティティキーの使用 (Entity Framework)」を参照してください。リレーションシップを設定してすぐに新しいオブジェクトを完全に同期する必要がある場合は、上記の 2 つの方法のいずれかを使用してください。
```
order.CustomerID = newCustomer.CustomerID 
order.CustomerID = null
```
特定のオブジェクトのエンティティキーを作成する。このキーを持つオブジェクトが既にオブジェクトコンテキストに存在する場合、CreateEntityKey メソッドは既存のオブジェクトの EntityKey を返します。このメソッドは .NET Framework 3.5 SP1 との互換性を維持するために提供されています。
```
order.CustomerReference.EntityKey = ctx.CreateEntityKey("EntitySetName", newObject)
```

上記で説明した方法のいずれかを使用してオブジェクトコンテキストにアタッチされたオブジェクトのリレーションシップを変更する場合、Entity Framework で外部キー、参照、コレクションの同期を維持する必要があります。 Entity Framework は、特定の種類の対象オブジェクトでこの同期を管理します。

Entity Data Model ツールによってコード生成されたエンティティオブジェクト。
IEntityWithChangeTracker インターフェイスを実装するカスタムオブジェクト。
プロキシを持つ POCO エンティティ。詳細については、「POCO プロキシの作成要件 (Entity Framework)」を参照してください。

プロキシなしで POCO エンティティを使用している場合、DetectChanges メソッドを呼び出してオブジェクトコンテキストの関連オブジェクトを同期する必要があります。接続解除されたオブジェクトを使用している場合は、手動で同期を管理する必要があります。

外部キープロパティとナビゲーションプロパティを使用して関連オブジェクトを関連付ける方法を次の例に示します。外部キーアソシエーションでは、両方の方法でリレーションシップを作成または変更できます。独立アソシエーションでは、外部キープロパティは使用できません。

' The following example creates a new StudentGrade object and associates 
' the StudentGrade with the Course and Person by 
' setting the foreign key properties. 

Using context As New SchoolEntities()
    ' The database will generate the EnrollmentID. 
    ' To create the association between the Course and StudentGrade, 
    ' and the Student and the StudentGrade, set the foreign key property 
    ' to the ID of the principal. 
    Dim newStudentGrade = New StudentGrade With
    {
        .EnrollmentID = 0,
        .Grade = CDec(4.0),
        .CourseID = 4022,
        .StudentID = 17
    }

    ' Adding the new object to the context will synchronize 
    ' the references with the foreign keys on the newStudentGrade object. 
    context.StudentGrades.AddObject(newStudentGrade)

    ' You can access Course and Student objects on the newStudentGrade object
    ' without loading the references explicitly because
    ' the lazy loading option is set to true in the constructor of SchoolEntities.
    Console.WriteLine("Student ID {0}:", newStudentGrade.Person.PersonID)
    Console.WriteLine("Course ID {0}:", newStudentGrade.Course.CourseID)

    context.SaveChanges()
End Using

' The following example creates a new StudentGrade and associates 
' the StudentGrade with the Course and Person by 
' setting the navigation properties to the Course and Person objects that were returned 
' by the query. 
' You do not need to call AddObject() in order to add the grade object 
' to the context, because when you assign the reference 
' to the navigation property the objects on both ends get synchronized by the Entity Framework. 
' Note, that the Entity Framework will not synchronize the ends untill the SaveChanges method 
' is called if your objects do not meet the change tracking requirements. 
Using context = New SchoolEntities()
    Dim courseID = 4022
    Dim course = (From c In context.Courses
                 Where c.CourseID = courseID
                 Select c).First()

    Dim personID = 17
    Dim student = (From p In context.People
                  Where p.PersonID = personID
                  Select p).First()

    ' The database will generate the EnrollmentID. 
    ' Use the navigation properties to create the association between the objects. 
    Dim newStudentGrade = New StudentGrade With
    {
        .EnrollmentID = 0,
        .Grade = CDec(4.0),
        .Course = course,
        .Person = student
    }
    context.SaveChanges()
End Using

// The following example creates a new StudentGrade object and associates
// the StudentGrade with the Course and Person by
// setting the foreign key properties. 

using (SchoolEntities context = new SchoolEntities())
{
    StudentGrade newStudentGrade = new StudentGrade
    {
        // The database will generate the EnrollmentID.
        EnrollmentID = 0,
        Grade = 4.0M,
        // To create the association between the Course and StudentGrade, 
        // and the Student and the StudentGrade, set the foreign key property 
        // to the ID of the principal.
        CourseID = 4022,
        StudentID = 17,
    };

    // Adding the new object to the context will synchronize
    // the references with the foreign keys on the newStudentGrade object.
    context.StudentGrades.AddObject(newStudentGrade);

    // You can access Course and Student objects on the newStudentGrade object
    // without loading the references explicitly because
    // the lazy loading option is set to true in the constructor of SchoolEntities.
    Console.WriteLine("Student ID {0}:", newStudentGrade.Person.PersonID);
    Console.WriteLine("Course ID {0}:", newStudentGrade.Course.CourseID);
    
    context.SaveChanges();
}

// The following example creates a new StudentGrade and associates
// the StudentGrade with the Course and Person by
// setting the navigation properties to the Course and Person objects that were returned
// by the query. 
// You do not need to call AddObject() in order to add the grade object
// to the context, because when you assign the reference 
// to the navigation property the objects on both ends get synchronized by the Entity Framework.
// Note, that the Entity Framework will not synchronize the ends untill the SaveChanges method
// is called if your objects do not meet the change tracking requirements. 
using (var context = new SchoolEntities())
{
    int courseID = 4022;
    var course = (from c in context.Courses
                 where c.CourseID == courseID
                 select c).First();

    int personID = 17;
    var student = (from p in context.People
                  where p.PersonID == personID
                  select p).First();

    StudentGrade grade = new StudentGrade
    {
        // The database will generate the EnrollmentID.
        Grade = 4.0M,
        // Use the navigation properties to create the association between the objects.
        Course = course,
        Person = student
    };
    context.SaveChanges();
}

状態の変更

外部キーアソシエーションでは、リレーションシップを変更すると、Unchanged 状態の依存オブジェクトの状態が Modified に変更されます。

独立リレーションシップでは、リレーションシップを変更しても依存オブジェクトの状態は更新されません。

同時実行の管理

外部キーアソシエーションと独立アソシエーションの場合、ConcurrencyMode 属性を fixed に設定し、エンティティキーおよび概念レイヤーで定義されるその他のプロパティに基づいて同時実行チェックを行います。

ただし独立アソシエーションの場合、リレーションシップの同時実行チェックは常にリレーションシップの両方の End のオブジェクトに対して実行されます。このチェックでは、関連した End の元のキー値が検証されます。オブジェクトがオブジェクトコンテキストからデタッチされているときにリレーションシップを変更した場合、元のリレーションシップを (クエリのやり直しか元のキー値の送信を行うことによって) 作成し直し、オブジェクトをオブジェクトコンテキストにアタッチしてから、そのオブジェクトコンテキストのリレーションシップに適切な変更を加えます。

重複するキーの操作

重複するキーは、キーの一部のプロパティがエンティティの別のキーの一部でもある複合キーです。独立アソシエーションで重複するキーを持つことはできません。重複するキーを持つ外部キーアソシエーションを変更する場合は、オブジェクト参照を使用するよりも外部キー値を変更することをお勧めします。

リレーションシップの識別と非識別に関する考慮事項

プリンシパルエンティティの主キーが依存エンティティの主キーの一部でもある場合、リレーションシップは識別リレーションシップです。識別リレーションシップでは、依存エンティティは必ずプリンシパルエンティティと共に存在します。この制約のため、識別リレーションシップでは次の動作が発生します。

プリンシパルオブジェクトを削除すると、依存オブジェクトも削除されます。これは、リレーションシップのモデルで <OnDelete Action="Cascade" /> を指定するのと同じ動作です。
リレーションシップを削除すると、依存オブジェクトが削除されます。 EntityCollection の Remove メソッドを呼び出すと、リレーションシップと依存オブジェクトの両方が削除の対象としてマークされます。
新しい依存オブジェクトを作成する場合は、SaveChanges を呼び出す前に、プリンシパルオブジェクトがオブジェクトコンテキストまたはデータソース内に存在する必要があります。プリンシパルオブジェクトが存在しない場合、InvalidOperationException が発生します。

非識別リレーションシップでモデルが外部キーアソシエーションに基づいている場合、プリンシパルオブジェクトを削除すると、依存オブジェクトの外部キーが null に設定されます (Null が許容される場合)。プリンシパルがなければ存在できない依存オブジェクトの場合、手動で依存オブジェクトを削除するか、新しいプリンシパルオブジェクトを依存オブジェクトに割り当てる必要があります。 2 つ目の方法として、モデルで <OnDelete Action="Cascade" /> を指定することで、関連したプリンシパルオブジェクトが削除されたときに依存オブジェクトも削除されるようにすることができます。