断开连接的实体

项目
08/24/2023

DbContext 实例将自动跟踪从数据库返回的实体。调用 SaveChanges 时，系统将检测对这些实体所做的更改并根据需要更新数据库。有关详细信息，请参阅基本保存和相关数据。

但是，有时会使用一个上下文实例查询实体，然后使用其他实例对其进行保存。这通常在“断开连接”的情况下发生，例如 Web 应用程序，此情况下实体被查询、发送到客户端、被修改、在请求中发送回服务器，然后进行保存。在这种情况下，第二个上下文实例需要知道实体是新的（应插入）还是现有的（应更新）。

提示

可在 GitHub 上查看此文章的示例。

提示

EF Core 只能跟踪具有给定主键值的任何实体的一个实例。为避免这种情况成为一个问题，最好为每个工作单元使用短期上下文，使上下文一开始为空、向其附加实体、保存这些实体，然后释放并放弃该上下文。

标识新实体

客户端标识新实体

油客户端通知服务器实体是新实体还是现有实体，这是最简单的情况。例如，通常插入新实体的请求与更新现有实体的请求不同。

本节的其余部分介绍了需要以其他某种方式确定是插入还是更新的情况。

使用自动生成的键

自动生成的键的值通常用于确定是需要插入实体还是需要更新实体。如果尚未设置密钥（即其值仍为 CLR 默认值 null、零等），则实体必须为新实体且需要插入。另一方面，如果已设置键值，则之前一定已保存该实体，且现在需要更新。换而言之，如果键具有值，则已查询实体并已将其发送到客户端，而现在返回进行更新。

实体类型为未知时，可以轻松检查未设置的键：

public static bool IsItNew(Blog blog)
    => blog.BlogId == 0;

但是，EF 还有一种适用于任何实体类型和键类型的内置方法可用于执行此操作：

public static bool IsItNew(DbContext context, object entity)
    => !context.Entry(entity).IsKeySet;

提示

即使实体处于“Added”状态，只要实体由上下文跟踪，就会设置键。这有助于遍历实体图并决定如何处理每个实体（例如在使用 TrackGraph API 时）。键值只能以此处显示的方式使用，然后才能执行任何调用以跟踪实体。

使用其他键

未自动生成键值时，需要使用其他某种机制来确定新实体。有以下两种常规方法：

查询实体
从客户端传递标志

若要查询实体，只需使用 Find 方法：

public static bool IsItNew(BloggingContext context, Blog blog)
    => context.Blogs.Find(blog.BlogId) == null;

无法显示用于从客户端传递标志的完整代码，这超出了本文档的范围。在 Web 应用中，这通常意味着对不同操作发出不同请求，或者在请求中传递某些状态，然后在控制器中进行提取。

保存单个实体

如果知道是需要插入还是需要更新，则可以相应地使用 Add 或 Update：

public static void Insert(DbContext context, object entity)
{
    context.Add(entity);
    context.SaveChanges();
}

public static void Update(DbContext context, object entity)
{
    context.Update(entity);
    context.SaveChanges();
}

但是，如果实体使用自动生成的键值，则 Update 方法可以用于以下两种情况：

public static void InsertOrUpdate(DbContext context, object entity)
{
    context.Update(entity);
    context.SaveChanges();
}

Update 方法通常将实体标记为更新，而不是插入。但是，如果实体具有自动生成的键且未设置任何键值，则实体会自动标记为插入。

如果实体不使用自动生成的键，则应用程序必须确定是应插入实体还是应更新实体：例如：

public static void InsertOrUpdate(BloggingContext context, Blog blog)
{
    var existingBlog = context.Blogs.Find(blog.BlogId);
    if (existingBlog == null)
    {
        context.Add(blog);
    }
    else
    {
        context.Entry(existingBlog).CurrentValues.SetValues(blog);
    }

    context.SaveChanges();
}

步骤如下：

如果 Find 返回 null，则数据库尚未包含具有此 ID 的博客，因此对 Add 的调用会将其标记为插入。
- 然后，使用 SetValues 将此实体上所有属性的值设置为来自客户端的值。
- SetValues 调用将根据需要标记要更新的实体。

提示

SetValues 仅将与跟踪实体中的属性具有不同值的属性标记为“已修改”。这意味着当发送更新时，这意味着当发送更新时，只会更新实际发生更改的列。（如果未发生更改，则根本不会发送任何更新。）

使用图形

标识解析

如上所述，EF Core 只能跟踪具有给定主键值的任何实体的一个实例。使用图形时，理想情况下应创建图形，以便保留此固定对象，且上下文应仅用于一个工作单元。如果图形中包含重复项，则必须先处理该图形，然后再将其发送到 EF 以合并多个实例。如果实例具有冲突值和关系，则以上操作可能并不轻松，因此应尽快在应用程序管道中完成重复项合并以避免冲突解决。

所有新实体/所有现有实体

插入或更新博客及其相关文章的集合是使用图形的一个示例。如果应插入图形中的所有实体，或应更新所有这些实体，则该过程与上述单个实体的过程相同。例如，博客和文章的图形创建如下：

var blog = new Blog
{
    Url = "http://sample.com", Posts = new List<Post> { new Post { Title = "Post 1" }, new Post { Title = "Post 2" }, }
};

可按如下方式插入：

public static void InsertGraph(DbContext context, object rootEntity)
{
    context.Add(rootEntity);
    context.SaveChanges();
}

对 Add 的调用会将博客和所有文章标记为插入。

同样，如果图形中的所有实体都需要更新，则可以使用 Update：

public static void UpdateGraph(DbContext context, object rootEntity)
{
    context.Update(rootEntity);
    context.SaveChanges();
}

博客及其所有文章将标记为更新。

新实体和现有实体的组合

即使图形包含需要插入的实体和需要更新的实体的组合，使用自动生成的键，Update 也可以再次用于插入和更新：

public static void InsertOrUpdateGraph(DbContext context, object rootEntity)
{
    context.Update(rootEntity);
    context.SaveChanges();
}

如果图形、博客或文章中的任何实体未设置键值，Update 会将其标记为插入，而其他所有实体会标记为更新。

如前所述，不使用自动生成的键时，可以使用查询并进行一些处理：

public static void InsertOrUpdateGraph(BloggingContext context, Blog blog)
{
    var existingBlog = context.Blogs
        .Include(b => b.Posts)
        .FirstOrDefault(b => b.BlogId == blog.BlogId);

    if (existingBlog == null)
    {
        context.Add(blog);
    }
    else
    {
        context.Entry(existingBlog).CurrentValues.SetValues(blog);
        foreach (var post in blog.Posts)
        {
            var existingPost = existingBlog.Posts
                .FirstOrDefault(p => p.PostId == post.PostId);

            if (existingPost == null)
            {
                existingBlog.Posts.Add(post);
            }
            else
            {
                context.Entry(existingPost).CurrentValues.SetValues(post);
            }
        }
    }

    context.SaveChanges();
}

处理删除

由于实体不存在通常表示应删除该实体，因此删除可能很难处理。解决此问题的一种方法是使用“软删除”，以便将该实体标记为已删除，而不是实际删除。然后，删除将变得与更新相同。可使用查询筛选器实现软删除。

对于真删除，常见模式是使用查询模式的扩展来执行本质上为图形差异的操作。例如：

public static void InsertUpdateOrDeleteGraph(BloggingContext context, Blog blog)
{
    var existingBlog = context.Blogs
        .Include(b => b.Posts)
        .FirstOrDefault(b => b.BlogId == blog.BlogId);

    if (existingBlog == null)
    {
        context.Add(blog);
    }
    else
    {
        context.Entry(existingBlog).CurrentValues.SetValues(blog);
        foreach (var post in blog.Posts)
        {
            var existingPost = existingBlog.Posts
                .FirstOrDefault(p => p.PostId == post.PostId);

            if (existingPost == null)
            {
                existingBlog.Posts.Add(post);
            }
            else
            {
                context.Entry(existingPost).CurrentValues.SetValues(post);
            }
        }

        foreach (var post in existingBlog.Posts)
        {
            if (!blog.Posts.Any(p => p.PostId == post.PostId))
            {
                context.Remove(post);
            }
        }
    }

    context.SaveChanges();
}

TrackGraph

在内部，Add、Attach 和 Update 使用图形遍历，为每个实体就是否应将其标记为 Added（若要插入）、Modified（若要更新）、Unchanged（不执行任何操作）或 Deleted（若要删除）作出决定。此机制是通过 TrackGraph API 公开的。例如，假设当客户端发送回实体图形时，会在每个实体上设置某些标志，指示应如何处理实体。然后，TrackGraph 可用于处理此标志：

public static void SaveAnnotatedGraph(DbContext context, object rootEntity)
{
    context.ChangeTracker.TrackGraph(
        rootEntity,
        n =>
        {
            var entity = (EntityBase)n.Entry.Entity;
            n.Entry.State = entity.IsNew
                ? EntityState.Added
                : entity.IsChanged
                    ? EntityState.Modified
                    : entity.IsDeleted
                        ? EntityState.Deleted
                        : EntityState.Unchanged;
        });

    context.SaveChanges();
}

为了简化示例，标志仅作为实体的一部分显示。通常，标志是 DTO 或包含在请求中的其他某个状态的一部分。

通过