从属实体类型Owned Entity Types

从属实体类型Owned Entity Types

EF Core 允许您为只能出现在其他实体类型的导航属性中的实体类型建模。它们称为_拥有的实体类型_。包含拥有的实体类型的实体是其_所有者_。

拥有的实体实质上是所有者的一部分，并且在没有它的情况下不存在，它们在概念上类似于聚合。这意味着，拥有的实体由与所有者的关系的从属方定义。

显式配置Explicit configuration

所有实体类型永远不会通过约定 EF Core 在模型中。您可以使用 OwnsOne 中的方法 OnModelCreating 或使用批注 OwnedAttribute （在 EF Core 2.1 中为 new）来将类型配置为拥有类型。

在此示例中， StreetAddress 是一个无标识属性的类型。它用作 Order 类型的属性来指定特定订单的发货地址。

OwnedAttribute从另一个实体类型引用时，可以使用将其视为拥有的实体：

[Owned]
public class StreetAddress
{
    public string Street { get; set; }
    public string City { get; set; }
}

public class Order
{
    public int Id { get; set; }
    public StreetAddress ShippingAddress { get; set; }
}

还可以使用 OwnsOne 中的方法 OnModelCreating 来指定 ShippingAddress 属性是实体类型的拥有实体 Order ，并根据需要配置其他方面。

modelBuilder.Entity<Order>().OwnsOne(p => p.ShippingAddress);

如果该 ShippingAddress 属性是类型中的私有属性 Order ，则可以使用该方法的字符串版本 OwnsOne ：

modelBuilder.Entity<Order>().OwnsOne(typeof(StreetAddress), "ShippingAddress");

有关更多上下文，请参阅完整的示例项目。

隐式键Implicit keys

OwnsOne通过引用导航配置的或通过引用导航发现的拥有的类型与所有者始终具有一对一的关系，因此，它们不需要其自己的键值，因为外键值是唯一的。在上面的示例中， StreetAddress 类型不需要定义键属性。

为了理解 EF Core 如何跟踪这些对象，知道主键是作为所属类型的影子属性创建的，这会很有用。所拥有类型的实例的键值将与所有者实例的键的值相同。

拥有的类型的集合Collections of owned types

备注

此为 EF Core 2.2 中的新增功能。

若要配置拥有类型的集合，请使用 OwnsMany 中的 OnModelCreating 。

拥有的类型需要主键。如果 .NET 类型上没有合适的候选属性，EF Core 可以尝试创建一个。但是，当所有类型是通过集合定义的时，只需创建一个影子属性以同时充当所有者的外键和该拥有实例的主键，就像我们所做的那样 OwnsOne ：对于每个所有者，可以有多个拥有的类型实例，因此，所有者的密钥不足以为每个拥有的实例提供唯一标识。

这两个最直接的解决方案是：

在独立于指向所有者的外键的新属性上定义代理项主键。所包含的值需要在所有所有者之间是唯一的（例如，如果父项 {1} 具有子级 {1} ，则父项 {2} 不能有子级 {1} ），因此，该值没有任何固有含义。由于外键不是主键的一部分，因此可以更改其值，因此，您可以将子级从一个父级移到另一个父级，但这通常会针对聚合语义进行。
使用外键和附加属性作为组合键。现在，附加属性值只需对于给定父代是唯一的（因此，如果父项 {1} 具有子级， {1,1} 则父项 {2} 仍可以有子级 {2,1} ）。通过创建主键的外键部分，所有者和拥有的实体之间的关系将变为不可变的，并且更好地反映了聚合语义。这是 EF Core 默认情况下执行的操作。

在此示例中，我们将使用 Distributor 类：

public class Distributor
{
    public int Id { get; set; }
    public ICollection<StreetAddress> ShippingCenters { get; set; }
}

默认情况下，在通过导航属性引用的所拥有的类型中使用的主键 ShippingCenters 将是 ("DistributorId", "Id") "DistributorId" FK，而 "Id" 是唯一 int 值。

若要配置其他 PK 调用 HasKey ：

modelBuilder.Entity<Distributor>().OwnsMany(p => p.ShippingCenters, a =>
{
    a.WithOwner().HasForeignKey("OwnerId");
    a.Property<int>("Id");
    a.HasKey("Id");
});

备注

在 EF Core 3.0 WithOwner() 方法不存在之前，应删除此调用。此外，不会自动发现主键，因此始终指定了它。

将拥有的类型映射到表拆分Mapping owned types with table splitting

使用关系数据库时，默认情况下，引用拥有的类型将映射到与所有者相同的表。这需要将表拆分为两个：某些列将用于存储所有者的数据，某些列将用于存储拥有实体的数据。这是一种称为表拆分的常见功能。

默认情况下，EF Core 会按照模式_Navigation_OwnedEntityProperty_为拥有的实体类型的属性命名数据库列。因此，这些 StreetAddress 属性将显示在 “Orders” 表中，名称为 “ShippingAddress_Street” 和 “ShippingAddress_City”。

您可以使用 HasColumnName 方法重命名这些列：

modelBuilder.Entity<Order>().OwnsOne(
    o => o.ShippingAddress,
    sa =>
    {
        sa.Property(p => p.Street).HasColumnName("ShipsToStreet");
        sa.Property(p => p.City).HasColumnName("ShipsToCity");
    });

备注

大多数正常的实体类型配置方法（如Ignore ）都可以通过相同的方式进行调用。

在多个所拥有的类型之间共享相同的 .NET 类型Sharing the same .NET type among multiple owned types

一个拥有的实体类型可以是与另一个拥有的实体类型相同的 .NET 类型，因此，.NET 类型可能不足以标识某个所有者的类型。

在这些情况下，从所有者指向拥有的实体的属性将成为所拥有实体类型的_定义导航_。从 EF Core 的角度来看，定义导航是类型标识与 .NET 类型的一部分。

例如，在下面的类中， ShippingAddress 和 BillingAddress 都是相同的 .net 类型 StreetAddress ：

public class OrderDetails
{
    public DetailedOrder Order { get; set; }
    public StreetAddress BillingAddress { get; set; }
    public StreetAddress ShippingAddress { get; set; }
}

为了理解 EF Core 如何区分跟踪的这些对象的实例，可能会认为定义导航已成为实例的键的一部分，以及所有者的键的值和拥有的类型的 .NET 类型。

嵌套的所属类型Nested owned types

在此示例 OrderDetails 中 BillingAddress ，拥有和 ShippingAddress ，这两种类型都是 StreetAddress 。然后 OrderDetails 归 DetailedOrder 类型所有。

public class DetailedOrder
{
    public int Id { get; set; }
    public OrderDetails OrderDetails { get; set; }
    public OrderStatus Status { get; set; }
}

public enum OrderStatus
{
    Pending,
    Shipped
}

每个指向所拥有的类型的导航都定义一个具有完全独立配置的单独实体类型。

除了嵌套的类型外，拥有的类型还可以引用常规实体，该实体可以是所有者，也可以是其他实体，前提是拥有的实体在依赖方。此功能在 EF6 中除复杂类型外，会设置拥有的实体类型。

public class OrderDetails
{
    public DetailedOrder Order { get; set; }
    public StreetAddress BillingAddress { get; set; }
    public StreetAddress ShippingAddress { get; set; }
}

配置拥有类型Configuring Owned Types

可以 OwnsOne 通过在流畅调用中将方法链接在一起来配置此模型：

modelBuilder.Entity<DetailedOrder>().OwnsOne(p => p.OrderDetails, od =>
{
    od.WithOwner(d => d.Order);
    od.Navigation(d => d.Order).UsePropertyAccessMode(PropertyAccessMode.Property);
    od.OwnsOne(c => c.BillingAddress);
    od.OwnsOne(c => c.ShippingAddress);
});

请注意 WithOwner 用于定义在所有者返回导航属性的调用。若要定义对不属于所有权关系的所有者实体类型的导航， WithOwner() 应不使用任何参数调用。

还可以在和上使用来实现此结果 OwnedAttribute OrderDetails StreetAddress 。

此外，请注意 Navigation 调用。在 EFCore 5.0 中，可以将导航属性进一步配置为非拥有的导航属性。

将拥有的类型存储在单独的表中Storing owned types in separate tables

与 EF6 复杂类型不同的是，拥有的类型可以存储在所有者的单独表中。若要重写将拥有的类型映射到与所有者相同的表的约定，可以直接调用 ToTable 并提供不同的表名。下面的示例将映射以下 OrderDetails 两个地址，并将其作为一个单独的表 DetailedOrder ：

modelBuilder.Entity<DetailedOrder>().OwnsOne(p => p.OrderDetails, od =>
{
    od.ToTable("OrderDetails");
});

还可以使用 TableAttribute 来实现此目的，但请注意，如果有多个导航到拥有的类型，则这会失败，因为在这种情况下，多个实体类型会映射到同一个表。

查询拥有的类型Querying owned types

查询所有者时，固有类型将默认包含在内。不需要使用 Include 方法，即使所有类型都存储在单独的表中。根据前面所述的模型，下面的查询将获得 Order ，其中 OrderDetails 两个数据库都拥有 StreetAddresses ：

var order = context.DetailedOrders.First(o => o.Status == OrderStatus.Pending);
Console.WriteLine($"First pending order will ship to: {order.OrderDetails.ShippingAddress.City}");

限制Limitations

其中一些限制对于拥有的实体类型的工作方式很重要，但其他一些限制是我们可以在未来版本中删除的限制：

按设计限制By-design restrictions

不能 DbSet<T> 为拥有的类型创建
不能 Entity<T>() 对拥有的类型调用ModelBuilder

当前缺陷Current shortcomings

拥有的实体类型不能具有继承层次结构
引用导航到拥有的实体类型不能为 null，除非它们显式映射到与所有者不同的表
拥有的实体类型的实例不能由多个所有者共享（这是一个已知的值对象方案，不能使用拥有的实体类型来实现）

以前版本中的缺点Shortcomings in previous versions

在 EF Core 2.0 中，在派生的实体类型中不能声明导航到拥有的实体类型，除非将拥有的实体显式映射到所有者层次结构中的单独表。此限制已在 EF Core 2.1 中被删除
在 EF Core 仅支持2.0 和2.1 的引用导航到拥有的类型。此限制已在 EF Core 2.2 中被删除