无键实体类型

注意

此功能已添加到查询类型的名称下。 后来重命名为无键实体类型。 [Keyless] 数据注释在 EFCore 5.0 中可用。

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

定义无键实体类型

可以使用数据注释或 Fluent API 来定义无键实体类型:

[Keyless]
public class BlogPostsCount
{
    public string BlogName { get; set; }
    public int PostCount { get; set; }
}

无键实体类型特征

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

但是,它们不同于常规实体类型,因为它们:

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

使用方案

无键实体类型的一些主要使用场景包括:

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

映射到数据库对象

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

注意

在 EF Core 5.0 之前,ToView 假定该对象已存在于数据库中,并且不会通过迁移来创建它。 在 EF Core 5.0 和更高版本中,使用 modelBuilder.Entity<ViewType>().ToTable("ViewNameInDatabase", t => t.ExcludeFromMigrations()) 从迁移中排除对象,请参阅 ToView() 因迁移具有不同的处理方式

示例

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

提示

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

首先,我们定义一个简单的 Blog 和 Post 模型:

public class Blog
{
    public int BlogId { get; set; }
    public string Name { get; set; }
    public string Url { get; set; }
    public ICollection<Post> Posts { get; set; }
}

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

接下来,我们定义一个简单的数据库视图,该视图使我们能够查询与每个博客关联的帖子数:

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

接下来,定义一个类来保存数据库视图的结果:

public class BlogPostsCount
{
    public string BlogName { get; set; }
    public int PostCount { get; set; }
}

接下来,使用 HasNoKey API 在 OnModelCreating 中配置无键实体类型。 我们使用 Fluent 配置 API 来配置无键实体类型的映射:

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder
        .Entity<BlogPostsCount>(
            eb =>
            {
                eb.HasNoKey();
                eb.ToView("View_BlogPostCounts");
                eb.Property(v => v.BlogName).HasColumnName("Name");
            });
}

接下来,配置 DbContext 以包括 DbSet<T>

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

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

var postCounts = db.BlogPostCounts.ToList();

foreach (var postCount in postCounts)
{
    Console.WriteLine($"{postCount.BlogName} has {postCount.PostCount} posts.");
    Console.WriteLine();
}

提示

请注意,我们还定义了上下文级查询属性 (DbSet),用于充当针对此类型的查询的根。

提示

若要使用内存中提供程序测试映射到视图的无键实体类型,请通过 ToInMemoryQuery该提供程序将它们映射到查询。 有关详细信息,请参阅 内存中提供程序文档