阴影属性Shadow Properties
影子属性是未在 .NET 实体类中定义但在 EF Core 模型中为该实体类型定义的属性。 这些属性的值和状态纯粹在更改跟踪器中进行维护。 当数据库中的数据不应在映射的实体类型上公开时,阴影属性非常有用。
外键阴影属性Foreign key shadow properties
影子属性最常用于外键属性,其中两个实体之间的关系由数据库中的外键值表示,但使用实体之间的导航属性在实体类型上管理关系各种. 按照约定,当发现关系但在依赖实体类中找不到外键属性时,EF 会引入一个影子属性。
属性将命名为 <navigation property name><principal key property name>
(指向主体实体的依赖实体上的导航用于命名)。 如果主体键属性名称包含导航属性的名称,则该名称将只 <principal key property name>
。 如果依赖实体上没有导航属性,则会在其位置使用主体类型名称。
例如,下面的代码列表将导致向 Post
实体引入 BlogId
影子属性:
class MyContext : DbContext
{
public DbSet<Blog> Blogs { get; set; }
public DbSet<Post> Posts { get; set; }
}
public class Blog
{
public int BlogId { get; set; }
public string Url { get; set; }
public List<Post> Posts { get; set; }
}
public class Post
{
public int PostId { get; set; }
public string Title { get; set; }
public string Content { get; set; }
// Since there is no CLR property which holds the foreign
// key for this relationship, a shadow property is created.
public Blog Blog { get; set; }
}
配置阴影属性Configuring shadow properties
你可以使用 “熟知 API” 配置阴影属性。 在您调用了 Property
的字符串重载后,您可以将对其他属性的任何配置调用链接在一起。 在下面的示例中,由于 Blog
没有名为 LastUpdated
的 CLR 属性,因此将创建一个影子属性:
class MyContext : DbContext
{
public DbSet<Blog> Blogs { get; set; }
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
modelBuilder.Entity<Blog>()
.Property<DateTime>("LastUpdated");
}
}
public class Blog
{
public int BlogId { get; set; }
public string Url { get; set; }
}
如果提供给 Property
方法的名称与现有属性(在实体类中定义)的名称相匹配,则代码将配置该现有属性,而不是引入新的阴影属性。
访问阴影属性Accessing shadow properties
可以通过 ChangeTracker
API 获取和更改影子属性值:
context.Entry(myBlog).Property("LastUpdated").CurrentValue = DateTime.Now;
可以通过 EF.Property
静态方法在 LINQ 查询中引用阴影属性:
var blogs = context.Blogs
.OrderBy(b => EF.Property<DateTime>(b, "LastUpdated"));