c# - 在 EntityFrameworkCore 中更新一个稍微复杂的实体

Question

我正在尝试 EntityFrameworkCore .我查看了文档，但找不到一种方法来轻松更新与另一个实体相关的复杂实体。

这是一个简单的例子。我有 2 个类 - 公司和员工。

public class Company
{
    public int Id { get; set; }
    public string Name { get; set; }
}

public class Employee
{
    public int Id { get; set; }
    public string Name { get; set; }
    public Company Company { get; set; }
}

Company 是一个简单的类，而 Employee 只是稍微复杂一点，因为它包含一个引用 Company 类的属性。

在接受更新实体的操作方法中，我可以先通过 ID 查找现有实体，然后在调用 SaveChanges 之前设置其每个属性。

[HttpPut]
public IActionResult Update(int id, [FromBody]Employee updatedEmployee)
{
    if (updatedEmployee == null || updatedEmployee.Id != id)
        return BadRequest();

    var existingEmployee = _dbContext.Employees
                             .FirstOrDefault(m => m.Id == id);
    if (existingEmployee == null)
        return NotFound();

    existingEmployee.Name = updatedEmployee.Name;

    if (updatedEmployee.Company == null)
        existingEmployee.Company = null; //as this is not a PATCH            
    else
    {
        var existingCompany = _dbContext.Companies.FirstOrDefault(m =>
                                m.Id == updatedEmployee.Company.Id);
        existingEmployee.Company = existingCompany;
    }

    _dbContext.SaveChanges();

    return NoContent();
}

使用此示例数据，我对 Employees/3 进行了 HTTP PUT 调用。

{
    "id": 3,
    "name": "Road Runner",
    "company":
    {
        "id": 1
    }
}

那行得通。

但是，我希望避免以这种方式设置每个属性。有没有一种方法可以用新实体替换现有实体，只需像这样的简单调用？

_dbContext.Entry(existingEmployee).Context.Update(updatedEmployee);

当我尝试这个时，它给出了这个错误:

System.InvalidOperationException: The instance of entity type 'Employee' cannot be tracked because another instance of this type with the same key is already being tracked. When adding new entities, for most key types a unique tem porary key value will be created if no key is set (i.e. if the key property is assigned the default value for its t ype). If you are explicitly setting key values for new entities, ensure they do not collide with existing entities or temporary values generated for other new entities. When attaching existing entities, ensure that only one entity instance with a given key value is attached to the context.

如果我检索现有实体而不跟踪它，我可以避免此错误。

var existingEmployee = _dbContext.Employees.AsNoTracking()
                         .FirstOrDefault(m => m.Id == id);

这适用于简单的实体，但如果该实体引用了其他实体，这也会为每个引用的实体生成一个 UPDATE 语句，这不在当前实体更新的范围内。 Update 方法的文档也说明了这一点:

// Begins tracking the given entity, and any other reachable entities that are not already being tracked, in the Microsoft.EntityFrameworkCore.EntityState.Modified state such that they will be updated in the database when Microsoft.EntityFrameworkCore.DbContext.SaveChanges is called.

在这种情况下，当我更新 Employee 实体时，我的 Company 实体从

{
  "id": 1,
  "name": "Acme Products"
}

到

{
  "id": 1,
  "name": null
}

如何避免相关实体的更新？

---

更新:

根据评论中的输入和接受的答案，这就是我最终得到的:

更新了 Employee 类，除了具有 Company 的导航属性外，还包括 CompanyId 的属性。我不喜欢这样做，因为公司 ID 包含在 Employee 中有两种方式，但这是最适合 EF 的方式。

public class Employee
{
    public int Id { get; set; }
    public string Name { get; set; }
    public int CompanyId { get; set; }
    public Company Company { get; set; }
}

现在我的 Update 变成了:

[HttpPut]
public IActionResult Update(int id, [FromBody]Employee updatedEmployee)
{
    if (updatedEmployee == null || updatedEmployee.Id != id)
        return BadRequest();

    var existingEmployeeCount = _dbContext.Employees.Count(m => m.Id == id);
    if (existingEmployeeCount != 1)
        return NotFound();

    _dbContext.Update(updatedEmployee);

    _dbContext.SaveChanges();

    return NoContent();
}

Answer 1

基于 Update 的文档

引用:Update

Begins tracking the given entity in the Modified state such that it will be updated in the database when SaveChanges() is called. All properties of the entity will be marked as modified. To mark only some properties as modified, use Attach(Object) to begin tracking the entity in the Unchanged state and then use the returned EntityEntry to mark the desired properties as modified. A recursive search of the navigation properties will be performed to find reachable entities that are not already being tracked by the context. These entities will also begin to be tracked by the context. If a reachable entity has its primary key value set then it will be tracked in the Modified state. If the primary key value is not set then it will be tracked in the Added state. An entity is considered to have its primary key value set if the primary key property is set to anything other than the CLR default for the property type.

在你的例子中，你有 updatedEmployee.Company导航属性已填写。因此，当您调用 context.Update(updatedEmployee) 时它将递归搜索所有导航。由于 updatedEmployee.Company 代表的实体设置了 PK 属性，EF 会将其添加为修改后的实体。这里需要注意的一点是 Company entity 只有 PK 属性没有填写其他。 (即名称为空)。因此，当 EF 确定 id=1 的公司已被修改为 Name=null 并发出适当的更新语句时。

当您自己更新导航时，您实际上是从服务器(填充了所有属性)中查找公司并将其附加到 existingEmployee.Company因此它有效，因为公司没有变化，只有 existingEmployee 的变化。 .

综上所述，如果你想使用Update在填写导航属性时，您需要确保导航表示的实体具有所有数据，而不仅仅是 PK 属性值。

现在如果你只有 Company.Id可供您使用，无法填写其他属性 updatedEmployee然后对于关系修复，您应该使用外键属性(仅需要 PK(或 AK)值)而不是导航(需要完整的实体)。

正如问题评论中所说:您应该添加 CompanyId属性(property)Employee类(class)。 Employee由于存在导航，仍然是非 poco(复杂)实体。

public class Employee
{
    public int Id { get; set; }
    public string Name { get; set; }
    public int? CompanyId {get; set; }
    public Company Company { get; set; }
}

在更新操作过程中传递 updatedEmployee在以下结构中。 (看到这是相同数量的数据，只是结构有点不同。)

{
    "Id": 3,
    "Name": "Road Runner",
    "CompanyId": 1,
    "Company": null //optional
}

然后在您的操作中，您可以调用 context.Update(updatedEmployee)它会拯救员工但不会改变公司。

由于Employee作为复杂类，您仍然可以使用导航。如果您已使用预加载 ( Include ) 加载员工，则 employee.Company将具有相关的公司实体值(value)。

注意事项:

• _dbContext.Entry(<any entity>).Context给你_dbContext只有这样你才能写_dbContext.Update(updatedEmployee)直接。
• 正如您通过 AsNoTracking 计算出的那样，如果您在上下文中加载实体，则无法调用 Update与 updatedEmployee .此时您需要手动修改每个属性，因为您需要将更改应用到 EF 跟踪的实体。 Update函数告诉 EF，这是修改后的实体，开始跟踪它并在 SaveChanges 处做必要的事情.所以AsNoTracking在这种情况下使用是正确的。此外，如果为您从服务器检索实体的目的只是检查员工是否存在，那么您可以查询 _dbContext.Employees.Count(m => m.Id == id);并将返回值与 1 进行比较。这会从服务器获取较少的数据并避免实体化。
• 放置属性(property)没有坏处CompanyId如果您不将它添加到 CLR 类，那么 EF 会在后台为您创建一个作为影子属性。将有数据库列来存储 FK 属性的值。要么您为其定义属性，要么 EF 将为它定义属性。