无键实体类型Keyless Entity Types

备注

此功能已添加到 EF Core 2.1 的查询类型的名称下。 在 EF Core 3.0 中，概念已重命名为无键实体类型。 [Keyless]数据批注在 EFCore 5.0 中变为可用。

除了常规实体类型外，EF Core 模型还可以包含_无键实体类型_，可用于对不包含键值的数据执行数据库查询。

定义无键实体类型Defining Keyless entity types

可以使用数据批注或熟知的 API 定义无键实体类型：

  1. [Keyless]
  2. public class BlogPostsCount
  3. {
  4.     public string BlogName { get; set; }
  5.     public int PostCount { get; set; }
  6. }
  1. protected override void OnModelCreating(ModelBuilder modelBuilder)
  2. {
  3.     modelBuilder.Entity<BlogPostsCount>()
  4.         .HasNoKey();
  5. }

无键实体类型特征Keyless entity types characteristics

无键实体类型支持与常规实体类型相同的多个映射功能，如继承映射和导航属性。 在关系存储上，它们可以通过 Fluent API 方法或数据批注来配置目标数据库对象和列。

但是，它们不同于常规实体类型，因为它们：

  • 不能定义键。
  • 永远不会对_DbContext_中的更改进行跟踪，因此不会在数据库中插入、更新或删除这些更改。
  • 绝不会按约定发现。
  • 仅支持导航映射功能的子集，具体如下：
    • 它们永远不能充当关系的主体端。
    • 它们可能没有到拥有的实体的导航
    • 它们只能包含指向常规实体的引用导航属性。
    • 实体不能包含无键实体类型的导航属性。
  • 需要配置[Keyless]数据批注或.HasNoKey()方法调用。
  • 可以映射到定义的_查询_。 定义查询是在模型中声明的查询，它充当无键实体类型的数据源。

使用方案Usage scenarios

无键实体类型的一些主要使用方案包括：

  • 作为原始 SQL 查询的返回类型。
  • 映射到不包含主键的数据库视图。
  • 映射到未定义主键的表。
  • 映射到模型中定义的查询。

映射到数据库对象Mapping to database objects

使用ToTable或ToView Fluent API 将无键实体类型映射到数据库对象。 从 EF Core 的角度来看，此方法中指定的数据库对象是一个_视图_，这意味着它将被视为只读查询源，并且不能作为更新、插入或删除操作的目标。 但是，这并不意味着数据库对象实际上必须是数据库视图。 它也可以是将被视为只读的数据库表。 相反，对于常规实体类型，EF Core 假设在ToTable方法中指定的数据库对象可以被视为_表_，这意味着它可用作查询源，但也可作为更新、删除和插入操作的目标。 事实上，您可以在中ToTable指定数据库视图的名称，只要该视图被配置为可在数据库上更新，一切都应正常工作。

备注

ToView假定该对象已存在于数据库中，并且不是通过迁移创建的。

示例Example

下面的示例演示如何使用无键实体类型来查询数据库视图。

提示

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

首先，我们定义一个简单的博客和发布模型：

  1. public class Blog
  2. {
  3.     public int BlogId { get; set; }
  4.     public string Name { get; set; }
  5.     public string Url { get; set; }
  6.     public ICollection<Post> Posts { get; set; }
  7. }
  9. public class Post
  10. {
  11.     public int PostId { get; set; }
  12.     public string Title { get; set; }
  13.     public string Content { get; set; }
  14.     public int BlogId { get; set; }
  15. }

接下来，我们定义一个简单的数据库视图，该视图将允许我们查询与每个博客关联的帖子数：

  1. db.Database.ExecuteSqlRaw(
  2.     @"CREATE VIEW View_BlogPostCounts AS 
  3.         SELECT b.Name, Count(p.PostId) as PostCount 
  4.         FROM Blogs b
  5.         JOIN Posts p on p.BlogId = b.BlogId
  6.         GROUP BY b.Name");

接下来，我们定义一个类来保存数据库视图的结果：

  1. public class BlogPostsCount
  2. {
  3.     public string BlogName { get; set; }
  4.     public int PostCount { get; set; }
  5. }

接下来，使用HasNoKey API 在_OnModelCreating_中配置无键实体类型。 我们使用熟知的配置 API 来配置无键实体类型的映射：

  1. protected override void OnModelCreating(ModelBuilder modelBuilder)
  2. {
  3.     modelBuilder
  4.         .Entity<BlogPostsCount>(eb =>
  5.         {
  6.             eb.HasNoKey();
  7.             eb.ToView("View_BlogPostCounts");
  8.             eb.Property(v => v.BlogName).HasColumnName("Name");
  9.         });
  10. }

接下来，将配置DbContext为包括DbSet<T>：

  1. public DbSet<BlogPostsCount> BlogPostCounts { get; set; }

最后，我们可以采用标准方式查询数据库视图：

  1. var postCounts = db.BlogPostCounts.ToList();
  3. foreach (var postCount in postCounts)
  4. {
  5.     Console.WriteLine($"{postCount.BlogName} has {postCount.PostCount} posts.");
  6.     Console.WriteLine();
  7. }

提示

请注意，我们还定义了一个上下文级查询属性（DbSet）作为此类型的查询的根。