エンティティフレームワーク-変更の追跡

Entity Frameworkは、エンティティとその関係に加えられた変更を追跡する機能を提供するため、コンテキストのSaveChangesメソッドが呼び出されたときにデータベースに正しい更新が行われます。これは、EntityFrameworkの重要な機能です。

  • 変更追跡は、エンティティコレクションに新しいレコードを追加したり、既存のエンティティを変更または削除したりするときに、変更を追跡します。

  • その後、すべての変更はDbContextレベルによって保持されます。

  • これらのトラック変更は、DbContextオブジェクトが破棄される前に保存されない場合、失われます。

  • DbChangeTrackerクラスは、コンテキストによって追跡されている現在のエンティティに関するすべての情報を提供します。

  • コンテキストによってエンティティを追跡するには、そのエンティティに主キープロパティが必要です。

Entity Frameworkでは、変更の追跡はデフォルトで有効になっています。DbContextのAutoDetectChangesEnabledプロパティをfalseに設定して、変更の追跡を無効にすることもできます。このプロパティがtrueに設定されている場合、EntityFrameworkはエンティティの状態を維持します。

using (var context = new UniContextEntities()) {
   context.Configuration.AutoDetectChangesEnabled = true;
}

学生とその登録がデータベースから取得される次の例を見てみましょう。

class Program {

   static void Main(string[] args) {

      using (var context = new UniContextEntities()) {

         context.Configuration.AutoDetectChangesEnabled = true;
         Console.WriteLine("Retrieve Student");

         var student = (from s in context.Students where s.FirstMidName == 
            "Ali" select s).FirstOrDefault<Student>();

         string name = student.FirstMidName + " " + student.LastName;
         Console.WriteLine("ID: {0}, Name: {1}", student.ID, name);
         Console.WriteLine();
         Console.WriteLine("Retrieve all related enrollments");

         foreach (var enrollment in student.Enrollments) {
            Console.WriteLine("Enrollment ID: {0}, Course ID: {1}", 
               enrollment.EnrollmentID, enrollment.CourseID);
         }

         Console.WriteLine();

         Console.WriteLine("Context tracking changes of {0} entity.", 
            context.ChangeTracker.Entries().Count());

         var entries = context.ChangeTracker.Entries();

         foreach (var entry in entries) {
            Console.WriteLine("Entity Name: {0}", entry.Entity.GetType().Name);
            Console.WriteLine("Status: {0}", entry.State);
         }

         Console.ReadKey();
      }
   }
}

上記の例をコンパイルして実行すると、次の出力が表示されます。

Retrieve Student 
ID: 1, Name: Ali Alexander
Retrieve all related enrollments
       Enrollment ID: 1, Course ID: 1050
       Enrollment ID: 2, Course ID: 4022
       Enrollment ID: 3, Course ID: 4041
Context tracking changes of 4 entity.
Entity Name: Student
Status: Unchanged
Entity Name: Enrollment
Status: Unchanged
Entity Name: Enrollment
Status: Unchanged
Entity Name: Enrollment
Status: Unchanged

すべてのデータがデータベースからのみ取得されることがわかります。そのため、すべてのエンティティのステータスは変更されていません。

ここで、もう1つの登録を追加し、データベースから1人の学生を削除する別の簡単な例を見てみましょう。以下は、新規登録が追加され、1人の学生が削除されるコードです。

class Program {

   static void Main(string[] args) {

      using (var context = new UniContextEntities()) {

         context.Configuration.AutoDetectChangesEnabled = true;

         Enrollment enr = new Enrollment() { 
            StudentID = 1, CourseID = 3141 
         };

         Console.WriteLine("Adding New Enrollment");
         context.Enrollments.Add(enr);
         Console.WriteLine("Delete Student");

         var student = (from s in context.Students where s.ID == 
            23 select s).SingleOrDefault<Student>();

         context.Students.Remove(student);
         Console.WriteLine("");

         Console.WriteLine("Context tracking changes of {0} entity.", 
            context.ChangeTracker.Entries().Count());
         var entries = context.ChangeTracker.Entries();

         foreach (var entry in entries) {
            Console.WriteLine("Entity Name: {0}", entry.Entity.GetType().Name);
            Console.WriteLine("Status: {0}", entry.State);
         }

         Console.ReadKey();
      }
   }
}

上記の例をコンパイルして実行すると、次の出力が返されます。

Adding New Enrollment
Delete Student
Context tracking changes of 2 entity.
Entity Name: Enrollment
Status: Added
Entity Name: Student
Status: Deleted

これで、登録エンティティのステータスが追加に設定され、学生エンティティのステータスが削除されたことがわかります。これは、新しい登録が追加され、1人の学生がデータベースから削除されたためです。

理解を深めるために、上記の例を段階的に実行することをお勧めします。