Entity Framework Core配置可选外键实现左连接查询需求

问题 #

我正在创建一个需要返回车辆信息的Web API，目前已实现从车辆表返回数据的功能。现在有另一张表，可能包含车辆的额外数据，希望查询车辆时返回所有车辆数据，同时获取该表中存在的对应额外数据（类似SQL左连接）。

以下是简化后的实体类：

public class Vehicle
{
    [Key]
    [Required]
    public string registrationNo { get; set; }
    public string capacity{ get; set; }
    public string maxGross{ get; set; }
}

public class VehicleDvlaDetail
{
    [ForeignKey("Vehicle")]
    public string? registrationNumber { get; set; }
    public int? co2Emissions { get; set; }
}

在上下文类的OnModelCreating方法中配置如下：

modelBuilder.Entity<Vehicle>(entity =>
{
    entity.HasOne(dvlaRec => dvlaRec.dvlaDetail).WithMany().HasForeignKey(dvla => dvla.registrationNo);
});

当前配置仅在DVLA表存在对应记录时正常工作，而实际情况并非总是如此。由于API需单独返回DVLA表数据，需保留这两个独立实体，询问如何创建可选外键。

解决方案 #

要实现类似左连接的可选关联，需调整实体配置与导航属性，具体操作如下：

1. 补全Vehicle类的可空导航属性
   确保Vehicle类包含可空的dvlaDetail导航属性（原配置已引用该属性，但实体类未定义）：

   public class Vehicle
   {
       [Key]
       [Required]
       public string registrationNo { get; set; }
       public string capacity{ get; set; }
       public string maxGross{ get; set; }
       // 设为可空类型，允许无对应DVLA记录
       public VehicleDvlaDetail? dvlaDetail { get; set; }
   }
   

2. 修改Fluent API配置，明确可选外键
   原配置未明确关联的可选性，调整后确保外键允许为null，同时匹配一对一关联关系：

   modelBuilder.Entity<Vehicle>()
       .HasOne(v => v.dvlaDetail)
       .WithOne() // 一对一关联：单车辆对应单DVLA记录
       .HasForeignKey<VehicleDvlaDetail>(dvla => dvla.registrationNumber)
       .IsRequired(false); // 标记外键为可选
   

3. 查询时加载关联数据
   使用Include方法加载DVLA详情，EF Core会自动生成左连接SQL，确保所有车辆数据都被返回，无对应DVLA记录时dvlaDetail为null：

   var vehicles = await _context.Vehicles
       .Include(v => v.dvlaDetail)
       .ToListAsync();
   

这样配置后，既保留了两个独立实体，又能实现查询车辆时自动左连接加载存在的DVLA额外数据，满足需求。

内容的提问来源于stack exchange，提问作者SkinnyPete63