Отслеживание изменений в EF Core

Статья
08/24/2023

Каждый экземпляр DbContext отслеживает изменения, внесенные в сущности. Эти отслеживаемые сущности, в свою очередь, записывают изменения в базу данных при вызове SaveChanges.

В этом документе представлены общие сведения об отслеживании изменений Entity Framework Core (EF Core) и о том, как это связано с запросами и обновлениями.

Совет

Вы можете запустить и отладить весь код, используемый в этой документации, скачав пример кода из GitHub.

Совет

Для простоты в этой документации используются и описываются синхронные методы, такие как SaveChanges, а не их асинхронные эквиваленты, такие как SaveChangesAsync. Вызов и ожидание асинхронного метода можно заменить, если не указано иное.

Как отслеживать сущности

Экземпляры сущностей отслеживаются, если они:

получены из запросов к базе данных;
явно присоединены к DbContext с помощью Add, Attach, Update или аналогичных методов;
обнаружены как новые сущности, подключенные к существующим отслеживаемым сущностям.

Экземпляры сущностей больше не отслеживаются, если:

экземпляр DbContext удален;
Средство отслеживания изменений очищается
сущности явно окончательно удалены.

DbContext используется для представления кратковременной единицы работы, как описано в статье Время существования, настройка и инициализация DbContext. Это означает, что удаление DbContext — это обычный способ остановки отслеживания сущностей. Иными словами, время существования DbContext должно быть следующим:

Создание экземпляра DbContext.
Отслеживание определенных сущностей.
Внесение определенных изменений в сущности.
Вызов метода SaveChanges для обновления базы данных.
Удаление экземпляра DbContext.

Совет

Вам не нужно очищать средство отслеживания изменений или явно окончательно удалять экземпляры сущностей при использовании этого подхода. Но, если необходимо окончательно удалить сущности, более эффективным будет вызов ChangeTracker.Clear, чем удаление сущностей по одной.

Состояния сущности

Каждая сущность связана с заданным состоянием EntityState:

Сущности Detached не отслеживаются DbContext.
Сущности Added являются новыми и еще не вставлены в базу данных. Это означает, что они будут вставлены при вызове SaveChanges.
Сущности Unchanged не изменены, так как они были запрошены из базы данных. Все сущности, получаемые из запросов, изначально находятся в этом состоянии.
Сущности Modified были изменены с момента запроса из базы данных. Это означает, что они будут обновлены при вызове SaveChanges.
Сущности Deleted существуют в базе данных, но отмечены для удаления при вызове SaveChanges.

EF Core отслеживает изменения на уровне свойств. Например, если изменяется только одно значение свойства, обновление базы данных изменит только это значение. При этом свойства помечаются как измененные, только если сущность находится в состоянии Modified. (С другой стороны, состояние Modified означает, что хотя бы одно значение свойства помечено как измененное.)

В следующей таблице описаны различия между состояниями.

Состояние сущности	Отслеживается DbContext	Существует в базе данных	Измененные свойства	Действие при вызове SaveChanges
`Detached`	No	-	-	-
`Added`	Да	Нет	-	Insert
`Unchanged`	Да	Да	No	-
`Modified`	Да	Да	Да	Обновить
`Deleted`	Да	Да	-	DELETE

Примечание.

В этом тексте для ясности используются термины, связанные с реляционной базой данных. Базы данных NoSQL обычно поддерживают аналогичные операции, но, возможно, с другими именами. Дополнительные сведения см. в документации поставщика базы данных.

Отслеживание из запросов

Отслеживание изменений EF Core наиболее эффективно, когда один и тот же экземпляр DbContext используется для запрашивания сущностей и их обновления путем вызова SaveChanges. Это происходит потому, что EF Core автоматически отслеживает состояние запрашиваемых сущностей и определяет изменения, внесенные в эти сущности при вызове SaveChanges.

Этот подход имеет несколько преимуществ по сравнению с явным отслеживанием экземпляров сущностей:

Он является простым. Состояниями сущностей редко требуется управлять явным образом — EF Core следит за изменениями состояния.
Обновления ограничиваются только теми значениями, которые действительно изменились.
Значения теневых свойств сохраняются и используются по мере необходимости. Это особенно важно, если внешние ключи хранятся в теневом состоянии.
Исходные значения свойств сохраняются автоматически и используются для эффективного обновления.

Простой запрос и обновление

Например, рассмотрим простую модель с участием блогов и публикаций:

public class Blog
{
    public int Id { get; set; }
    public string Name { get; set; }

    public IList<Post> Posts { get; } = new List<Post>();
}

public class Post
{
    public int Id { get; set; }
    public string Title { get; set; }
    public string Content { get; set; }

    public int? BlogId { get; set; }
    public Blog Blog { get; set; }
}

Эту модель можно использовать для запрашивания блогов и публикаций с последующим внесением определенных обновлений в базу данных:

using var context = new BlogsContext();

var blog = context.Blogs.Include(e => e.Posts).First(e => e.Name == ".NET Blog");

blog.Name = ".NET Blog (Updated!)";

foreach (var post in blog.Posts.Where(e => !e.Title.Contains("5.0")))
{
    post.Title = post.Title.Replace("5", "5.0");
}

context.SaveChanges();

Вызов SaveChanges приводит к следующим обновлениям базы данных с использованием SQLite в качестве примера базы данных:

-- Executed DbCommand (0ms) [Parameters=[@p1='1' (DbType = String), @p0='.NET Blog (Updated!)' (Size = 20)], CommandType='Text', CommandTimeout='30']
UPDATE "Blogs" SET "Name" = @p0
WHERE "Id" = @p1;
SELECT changes();

-- Executed DbCommand (0ms) [Parameters=[@p1='2' (DbType = String), @p0='Announcing F# 5.0' (Size = 17)], CommandType='Text', CommandTimeout='30']
UPDATE "Posts" SET "Title" = @p0
WHERE "Id" = @p1;
SELECT changes();

Представление отладки средства отслеживания изменений — отличный способ визуализации отслеживаемых сущностей и их состояний. Например, перед вызовом SaveChanges вставьте следующий код в приведенный выше пример:

context.ChangeTracker.DetectChanges();
Console.WriteLine(context.ChangeTracker.DebugView.LongView);

Будут получены следующие выходные данные:

Blog {Id: 1} Modified
  Id: 1 PK
  Name: '.NET Blog (Updated!)' Modified Originally '.NET Blog'
  Posts: [{Id: 1}, {Id: 2}, {Id: 3}]
Post {Id: 1} Unchanged
  Id: 1 PK
  BlogId: 1 FK
  Content: 'Announcing the release of EF Core 5.0, a full featured cross...'
  Title: 'Announcing the Release of EF Core 5.0'
  Blog: {Id: 1}
Post {Id: 2} Modified
  Id: 2 PK
  BlogId: 1 FK
  Content: 'F# 5 is the latest version of F#, the functional programming...'
  Title: 'Announcing F# 5.0' Modified Originally 'Announcing F# 5'
  Blog: {Id: 1}

Учитывайте следующее:

Свойство Blog.Name помечено как измененное (Name: '.NET Blog (Updated!)' Modified Originally '.NET Blog'), что приводит к тому, что состояние блога изменяется на Modified.
Свойство Post.Title публикации 2 помечено как измененное (Title: 'Announcing F# 5.0' Modified Originally 'Announcing F# 5'), что приводит к тому, что состояние публикации изменяется на Modified.
Другие значения свойств публикации 2 не изменились и поэтому не помечаются как измененные. Именно поэтому эти значения не включаются в обновление базы данных.
Другая публикация вообще не была изменена. Именно поэтому она по-прежнему находится в состоянии Unchanged и не включается в обновление базы данных.

Запрос, вставка, обновление и удаление

Такие обновления, как в предыдущем примере, можно сочетать с операциями вставки и удаления в одной единице работы. Например:

using var context = new BlogsContext();

var blog = context.Blogs.Include(e => e.Posts).First(e => e.Name == ".NET Blog");

// Modify property values
blog.Name = ".NET Blog (Updated!)";

// Insert a new Post
blog.Posts.Add(
    new Post
    {
        Title = "What’s next for System.Text.Json?", Content = ".NET 5.0 was released recently and has come with many..."
    });

// Mark an existing Post as Deleted
var postToDelete = blog.Posts.Single(e => e.Title == "Announcing F# 5");
context.Remove(postToDelete);

context.ChangeTracker.DetectChanges();
Console.WriteLine(context.ChangeTracker.DebugView.LongView);

context.SaveChanges();

В этом примере:

Блог и связанные с ним публикации запрашиваются из базы данных и отслеживаются.
Свойство Blog.Name изменяется.
В коллекцию существующих записей блога добавляется новая публикация.
Существующая публикация помечается для удаления путем вызова DbContext.Remove.

Еще раз взгляните на представление отладки средства отслеживания изменений перед вызовом команды SaveChanges. Вы увидите, как EF Core отслеживает эти изменения:

Blog {Id: 1} Modified
  Id: 1 PK
  Name: '.NET Blog (Updated!)' Modified Originally '.NET Blog'
  Posts: [{Id: 1}, {Id: 2}, {Id: 3}, {Id: -2147482638}]
Post {Id: -2147482638} Added
  Id: -2147482638 PK Temporary
  BlogId: 1 FK
  Content: '.NET 5.0 was released recently and has come with many...'
  Title: 'What's next for System.Text.Json?'
  Blog: {Id: 1}
Post {Id: 1} Unchanged
  Id: 1 PK
  BlogId: 1 FK
  Content: 'Announcing the release of EF Core 5.0, a full featured cross...'
  Title: 'Announcing the Release of EF Core 5.0'
  Blog: {Id: 1}
Post {Id: 2} Deleted
  Id: 2 PK
  BlogId: 1 FK
  Content: 'F# 5 is the latest version of F#, the functional programming...'
  Title: 'Announcing F# 5'
  Blog: {Id: 1}

Обратите внимание на указанные ниже моменты.

Блог помечен как Modified. Это вызовет обновление базы данных.
Публикация 2 помечена как Deleted. Это вызовет удаление базы данных.
Новая публикация с временным идентификатором связана с блогом 1 и помечена как Added. Это вызовет вставку в базу данных.

Это приводит к выполнению следующих команд базы данных (при использовании SQLite) при вызове SaveChanges:

-- Executed DbCommand (0ms) [Parameters=[@p1='1' (DbType = String), @p0='.NET Blog (Updated!)' (Size = 20)], CommandType='Text', CommandTimeout='30']
UPDATE "Blogs" SET "Name" = @p0
WHERE "Id" = @p1;
SELECT changes();

-- Executed DbCommand (0ms) [Parameters=[@p0='2' (DbType = String)], CommandType='Text', CommandTimeout='30']
DELETE FROM "Posts"
WHERE "Id" = @p0;
SELECT changes();

-- Executed DbCommand (0ms) [Parameters=[@p0='1' (DbType = String), @p1='.NET 5.0 was released recently and has come with many...' (Size = 56), @p2='What's next for System.Text.Json?' (Size = 33)], CommandType='Text', CommandTimeout='30']
INSERT INTO "Posts" ("BlogId", "Content", "Title")
VALUES (@p0, @p1, @p2);
SELECT "Id"
FROM "Posts"
WHERE changes() = 1 AND "rowid" = last_insert_rowid();

Дополнительные сведения о вставке и удалении сущностей см. в статье Явное отслеживание сущностей. Дополнительные сведения о том, как EF Core автоматически обнаруживает подобные изменения, см. в статье Обнаружение изменений и уведомления.

Совет

Вызовите ChangeTracker.HasChanges(), чтобы определить, были ли внесены какие-либо изменения, которые приведут к обновлению базы данных с помощью SaveChanges. Если HasChanges возвращает значение false, SaveChanges не будет выполняться.

Поделиться через

Отслеживание изменений в EF Core

Как отслеживать сущности

Состояния сущности

Отслеживание из запросов

Простой запрос и обновление

Запрос, вставка, обновление и удаление

Дополнительные ресурсы