EF Core中如何通过ChangeTracker获取多对多关系变更信息

在EF Core中处理导航属性与多对多关系时，无法从ChangeTracker中获取关系变更（添加或删除关联）的有效信息，需要明确两个实体间的关系何时发生变化。

实体类定义 #

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

    public ICollection<SingerChoir> SingerChoirs { get; set; }
}

public class Choir
{
    public int Id { get; set; }
    public string Name { get; set; }
 
    public ICollection<SingerChoir> ChoirSingers { get; set; }
}

public class SingerChoir
{
    public int SingerId { get; set; }
    public int ChoirId { get; set; }
    public Singer Singer { get; set; }
    public Choir Choir { get; set; }
}

DebugView示例 #

DebugView: 
Singer {Id: 1} Unchanged
Id: 1 PK
Name: 'MyTest'
SingerChoirs: [{SingerId: 1, ChoirId: 1}, {SingerId: 1, ChoirId: 4}]
SingerChoir {SingerId: 1, ChoirId: 1} Unchanged
  SingerId: 1 PK FK
  ChoirId: 1 PK FK
  Choir: <null>
  Singer: {Id: 1}
SingerChoir {SingerId: 1, ChoirId: 3} Added
  SingerId: 1 PK FK
  ChoirId: 3 PK FK
  Choir: <null>
  Singer: {Id: 1}

尝试的代码 #

ChangeTracker.DetectChanges();
foreach (var e in ChangeTracker.Entries<TEntity>())
{
    foreach (var n in e.Navigations.Where(n => n.IsModified))
    {
        // 此处困惑：如何访问已修改的SingerChoir实体及其EntityState和属性？
       // 理想情况类似：
       // n.TargetEntry.Properties.OriginalValues 
       // n.TargetEntry.Properties.CurrentValues
    }
}

更新说明：之前DebugView中Singer实体状态显示为'Modified'是bug导致，现已修正为'Unchanged'。

解决方案 #

1. 直接查询连接实体的ChangeTracker条目 #

因为SingerChoir是显式定义的连接实体，EF Core会直接跟踪它的状态变更。你可以直接遍历ChangeTracker中所有SingerChoir类型的条目，获取每个条目的状态及属性值：

ChangeTracker.DetectChanges();

// 获取所有状态变更的SingerChoir实体
var changedSingerChoirs = ChangeTracker.Entries<SingerChoir>()
    .Where(entry => entry.State != EntityState.Unchanged)
    .ToList();

foreach (var entry in changedSingerChoirs)
{
    var currentSingerId = entry.Property(nameof(SingerChoir.SingerId)).CurrentValue;
    var currentChoirId = entry.Property(nameof(SingerChoir.ChoirId)).CurrentValue;
    var entityState = entry.State;

    // 如果是删除状态，需要获取原始值（因为CurrentValue可能被清空）
    if (entityState == EntityState.Deleted)
    {
        var originalSingerId = entry.Property(nameof(SingerChoir.SingerId)).OriginalValue;
        var originalChoirId = entry.Property(nameof(SingerChoir.ChoirId)).OriginalValue;
        // 处理删除逻辑，比如记录哪个歌手退出了哪个合唱团
    }
    else if (entityState == EntityState.Added)
    {
        // 处理添加逻辑，比如记录哪个歌手加入了哪个合唱团
    }
}

2. 为什么导航属性方式无法直接获取详细信息 #

当你修改主实体（如Singer）的导航集合SingerChoirs时，EF Core只会标记导航属性为IsModified，但主实体本身的状态仍为Unchanged（因为实体自身属性未修改）。此时NavigationEntry无法直接提供具体的连接实体变更，必须通过查询连接实体的ChangeTracker条目来获取详细信息。

3. 补充：针对无显式连接实体的多对多（EF Core 5+） #

如果你的多对多关系没有显式定义连接实体（即Singer中直接用ICollection<Choir> Choirs），则需要对比导航属性的CurrentValue和OriginalValue来找出变更：

ChangeTracker.DetectChanges();
foreach (var singerEntry in ChangeTracker.Entries<Singer>())
{
    var choirNav = singerEntry.Navigations.First(n => n.Name == nameof(Singer.Choirs));
    if (choirNav.IsModified)
    {
        var currentChoirs = (ICollection<Choir>)choirNav.CurrentValue;
        var originalChoirs = (ICollection<Choir>)choirNav.OriginalValue;
        
        var addedChoirs = currentChoirs.Except(originalChoirs).ToList();
        var removedChoirs = originalChoirs.Except(currentChoirs).ToList();
        // 处理添加/删除的合唱团
    }
}

但回到你的场景，由于使用了显式连接实体，第一种方法是最直接有效的。

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