Entity Framework Core中多对多关系的正确更新/删除方法

问题场景 #

采用Entity Framework自动创建关联表实现Trip与Tag的多对多关系，新增Trip时关联标签的逻辑正常，但更新Trip时无法从自动生成的关联表中删除已移除的标签关联记录。

实体定义 #

public class Trip
{
    [Key]
    public Guid TripId { get; set; }
    public string Name { get; set; }
    public string Description { get; set; }

    [ValidateNever]
    public IEnumerable<Tag> Tags { get; set; }
}

public class Tag
{
    [Key]
    public Guid TagId { get; set; }
    public string Name { get; set; }

    [ValidateNever]
    public IEnumerable<Trip> Trips { get; set; }
}

正常运行的新增Trip代码 #

新增时通过Attach已存在的标签，再添加Trip实体，可正确维护多对多关联：

public async Task<Trip> AddTripAsync(Trip trip)
{
    foreach(var tag in trip.Tags)
    {
        _dbContext.Attach(tag);
    }
    _dbContext.Trips.Add(trip);
    await _dbContext.SaveChangesAsync();
    return trip;
}

无效的原更新代码 #

以下代码仅处理了新增标签的逻辑，未处理需要移除的标签，导致关联表中旧的关联记录无法删除：

public async Task<EntityOne> Update(Trip trip){
    // 从数据库加载包含Tags的Trip
    Trip? tripFromDb = await GetTripAsync(temp => temp.TripId == trip.TripId, "Tags");
    if (tripFromDb == null)
    {
        return trip;
    }
    tripFromDb.Name = trip.Name;
    tripFromDb.Description = trip.Description;
    foreach (var tag in trip.Tags)
    {
        var tagFromDb = tripFromDb.Tags.SingleOrDefault(x => x.TagId == tag.TagId);
        if (tagFromDb != null)
        {
            // 标签已存在，无需重复添加
            _dbContext.Attach(tagFromDb);
        }
        else
        {
            tripFromDb.Tags.Add(tag);
        }
    }
    
    await _dbContext.SaveChangesAsync();    
    
    return entityToCreate;
}

疑问：是否必须手动创建TripsTags关联表？ #

不需要手动创建关联表。EF自动生成的多对多关联表，可通过正确操作实体的导航集合来维护关联关系，关键是要同时处理标签的新增和移除逻辑。

修正后的更新代码 #

通过对比现有标签与传入标签的ID，分别处理移除和新增操作，可正确更新多对多关联：

public async Task<EntityOne> Update(Trip trip){
    Trip? tripFromDb = _dbContext.Trips.FirstOrDefault(t => t.TripId == trip.TripId);
    if (tripFromDb == null)
    {
        return trip;
    }

    tripFromDb.Name = trip.Name;
    tripFromDb.Description = trip.Description;
    // 加载Trip关联的Tags集合
    _dbContext.Entry(tripFromDb).Collection("Tags").Load();
    
    var existingTagIds = tripFromDb.Tags.Select(x => x.TagId).ToList();
    var updatedTagIds = trip.Tags.Select(x => x.TagId).ToList();
    // 计算需要新增和移除的标签ID
    var tagIdsToAdd = updatedTagIds.Except(existingTagIds);
    var tagIdsToRemove = existingTagIds.Except(updatedTagIds);

    // 移除不需要的标签关联
    if (tagIdsToRemove.Any())
    {
       var tagsToRemove = tripFromDb.Tags.Where(x => tagIdsToRemove.Contains(x.TagId)).ToList();
       foreach(var tag in tagsToRemove)
           tripFromDb.Tags.Remove(tag);
    }

    // 添加新的标签关联
    if (tagIdsToAdd.Any())
    {
        var tagsToAdd = await _dbContext.Tags.Where(x => tagIdsToAdd.Contains(x.TagId)).ToListAsync();
        foreach(var tag in tagsToAdd)
            tripFromDb.Tags.Add(tag);
    }

    await _dbContext.SaveChangesAsync();    
    
    return tripFromDb;
}

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