Entity Framework：ASP.NET Core 6中如何通过主键设置引用导航属性

针对你遇到的问题，以下几种方案可以实现将JSON中的OrganizationId映射到Customer类的Organization导航属性：

方案1：添加外键属性（推荐，符合EF Core最佳实践） #

直接在Customer类中添加OrganizationId外键属性，EF Core会自动识别它与Organization导航属性的关联，同时JSON可以直接绑定该属性，之后你可以手动为导航属性赋值：

class Customer 
{
    public int Id { get; set; }
    // 添加外键属性
    public int OrganizationId { get; set; }
    public Organization Organization { get; set; }
    public string Name { get; set; }
    // 其他属性
}

控制器中处理导航属性赋值：

public async Task<IActionResult> Post(Customer customer)
{
    // 仅设置Organization的Id，无需加载完整实体
    customer.Organization = new Organization { Id = customer.OrganizationId };
    
    _context.Customers.Add(customer);
    await _context.SaveChangesAsync();
    return Ok(customer);
}

方案2：自定义JSON转换器 #

如果不想修改Customer实体类，可以创建自定义JSON转换器，在反序列化时自动将OrganizationId映射到导航属性的Id：

步骤1：创建转换器 #

public class CustomerOrganizationConverter : JsonConverter<Customer>
{
    public override Customer Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        using var doc = JsonDocument.ParseValue(ref reader);
        var customer = doc.RootElement.Deserialize<Customer>(options);
        
        if (doc.RootElement.TryGetProperty("OrganizationId", out var orgIdElement))
        {
            customer.Organization = new Organization { Id = orgIdElement.GetInt32() };
        }
        
        return customer;
    }

    public override void Write(Utf8JsonWriter writer, Customer value, JsonSerializerOptions options)
    {
        JsonSerializer.Serialize(writer, value, options);
    }
}

步骤2：注册转换器 #

在Program.cs中添加转换器到JSON序列化配置：

builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        options.JsonSerializerOptions.Converters.Add(new CustomerOrganizationConverter());
    });

方案3：控制器内手动解析JSON #

仅针对单个控制器的场景，可以直接读取请求体JSON，手动提取OrganizationId并赋值：

public async Task<IActionResult> Post()
{
    var requestBody = await new StreamReader(Request.Body).ReadToEndAsync();
    var customer = JsonSerializer.Deserialize<Customer>(requestBody);
    
    using var jsonDoc = JsonDocument.Parse(requestBody);
    if (jsonDoc.RootElement.TryGetProperty("OrganizationId", out var orgIdElement))
    {
        customer.Organization = new Organization { Id = orgIdElement.GetInt32() };
    }
    
    _context.Customers.Add(customer);
    await _context.SaveChangesAsync();
    return Ok(customer);
}

方案4：EF Core阴影属性 #

若不想修改实体类，可使用EF Core的阴影属性定义外键，再在控制器中设置该属性值：

步骤1：配置阴影属性 #

在DbContext的OnModelCreating方法中定义阴影属性并关联外键：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    // 定义OrganizationId阴影属性
    modelBuilder.Entity<Customer>().Property<int>("OrganizationId");
    
    // 关联导航属性与阴影外键
    modelBuilder.Entity<Customer>()
        .HasOne(c => c.Organization)
        .WithMany(o => o.Customers)
        .HasForeignKey("OrganizationId");
}

步骤2：控制器中设置属性 #

public async Task<IActionResult> Post()
{
    var requestBody = await new StreamReader(Request.Body).ReadToEndAsync();
    var customer = JsonSerializer.Deserialize<Customer>(requestBody);
    
    using var jsonDoc = JsonDocument.Parse(requestBody);
    if (jsonDoc.RootElement.TryGetProperty("OrganizationId", out var orgIdElement))
    {
        // 设置阴影属性值
        _context.Entry(customer).Property("OrganizationId").CurrentValue = orgIdElement.GetInt32();
        // 或直接赋值导航属性
        // customer.Organization = new Organization { Id = orgIdElement.GetInt32() };
    }
    
    _context.Customers.Add(customer);
    await _context.SaveChangesAsync();
    return Ok(customer);
}

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