ASP.NET Core Web API多对多关系下Note的PATCH端点删除Tag报错求助

我在实现与Tag实体存在多对多关系的Note实体的PATCH端点时，执行从Note的Tags列表中删除Tag的操作会抛出错误，其他PATCH操作（如修改标题、描述）均正常。

实体模型代码 #

public class Note
{
    [Key]
    [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
    public int ID { get; set; }
    public string? Title { get; set; }
    [Required]
    public string Description { get; set; }
    public List<Tag>? Tags { get; set; }
    public bool Deleted { get; set; }
    public DateTime CreatedDate { get; set; }
    public DateTime ChangedDate { get; set; }
}

public class Tag
{
    [Key]
    [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
    public int TagID { get; set; }
    [Required]
    public string TagName { get; set; }
    public List<Note>? Notes { get; set; }
    public DateTime CreatedDate { get; set; }
}

DbContext配置代码 #

public ApplicationDbContext(DbContextOptions<ApplicationDbContext> options) : base(options)
{
}

public DbSet<Note> Notes { get; set; }
public DbSet<Tag> Tags { get; set; }

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<Note>()
                .HasMany(n => n.Tags)
                .WithMany(t => t.Notes)
                .UsingEntity(j => j
                .ToTable("NoteTag")
                .HasData
                (
                    new {NotesID = 1, TagsTagID = 1},
                    new {NotesID = 2, TagsTagID = 2}
                ));

    modelBuilder.Entity<Tag>().HasData
            (
            new Tag
            {
                TagID= 1,
                TagName="testTag1",
                CreatedDate= DateTime.Now
            },
            new Tag
            {
                TagID= 2,
                TagName = "testTag2",
                CreatedDate= DateTime.Now
            }
            );
    modelBuilder.Entity<Note>().HasData
            (
            new Note
            {
                ID= 1,
                Title="testTitle1",
                Description="testDescription1",
                Deleted=false,
                CreatedDate= DateTime.Now,
                ChangedDate= DateTime.Now,
            },
            new Note
            {
                ID = 2,
                Title = "testTitle2",
                Description = "testDescription2",
                Deleted = false,
                CreatedDate = DateTime.Now,
                ChangedDate = DateTime.Now,
            }
            );
}

PATCH端点代码 #

[HttpPatch("{id:int}", Name = "UpdateNote")]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
[ProducesResponseType(StatusCodes.Status204NoContent)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public IActionResult UpdateNote(int id, JsonPatchDocument<Note> patchNoteDTO)
{
    if (id == 0 || patchNoteDTO == null)
        return BadRequest();
    var note = _db.Notes.AsNoTracking().FirstOrDefault(u => u.ID == id);
    if (note == null)
        return NotFound();
    patchNoteDTO.ApplyTo(note, ModelState);
    if (!ModelState.IsValid)
        return BadRequest(ModelState);
    note.ChangedDate = DateTime.Now;
    _db.Update(note);
    _db.SaveChanges();
    return NoContent();
}

错误场景 #

当通过补丁文档的路径（如/Tags/0）删除Note的Tags列表中的Tag时，操作抛出错误。

解决方案 #

问题根源 #

1. 使用AsNoTracking()加载Note，导致EF Core无法跟踪实体及其关联的Tags集合的变更，无法正确更新多对多连接表。
2. 默认的JsonPatchDocument处理EF Core导航属性集合时，无法正确触发多对多关系的状态变更。

修复步骤 #

1. 修改实体加载方式，启用跟踪并包含关联Tags

将获取Note的代码改为：

var note = _db.Notes.Include(n => n.Tags).FirstOrDefault(u => u.ID == id);

去掉AsNoTracking()，确保EF Core跟踪实体及其Tags集合的状态变化，同时通过Include加载关联的Tags，避免懒加载导致的集合为null或未跟踪。

2. 移除不必要的_db.Update(note)调用

因为实体已经被上下文跟踪，修改后直接调用SaveChanges()即可，无需手动调用Update：

// 移除这行代码
// _db.Update(note);

3. 确保Tags集合不为null

可以在Note的构造函数中初始化Tags集合，避免Patch操作时集合为null导致错误：

public class Note
{
    public Note()
    {
        Tags = new List<Tag>();
    }
    // 其他属性...
}

替代方案：自定义多对多关系的Patch处理

如果默认JsonPatch处理集合仍有问题，可以创建一个专用的Patch DTO，明确指定要添加或删除的Tag ID，手动处理多对多关系：

public class NotePatchDto
{
    public string? Title { get; set; }
    public string? Description { get; set; }
    public List<int>? AddTagIds { get; set; }
    public List<int>? RemoveTagIds { get; set; }
}

然后修改端点代码：

[HttpPatch("{id:int}", Name = "UpdateNote")]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
[ProducesResponseType(StatusCodes.Status204NoContent)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public IActionResult UpdateNote(int id, NotePatchDto patchDto)
{
    if (id == 0 || patchDto == null)
        return BadRequest();
    
    var note = _db.Notes.Include(n => n.Tags).FirstOrDefault(u => u.ID == id);
    if (note == null)
        return NotFound();

    // 更新基本属性
    if (!string.IsNullOrEmpty(patchDto.Title))
        note.Title = patchDto.Title;
    if (!string.IsNullOrEmpty(patchDto.Description))
        note.Description = patchDto.Description;

    // 处理Tag删除
    if (patchDto.RemoveTagIds != null)
    {
        var tagsToRemove = note.Tags.Where(t => patchDto.RemoveTagIds.Contains(t.TagID)).ToList();
        foreach (var tag in tagsToRemove)
        {
            note.Tags.Remove(tag);
        }
    }

    // 处理Tag添加
    if (patchDto.AddTagIds != null)
    {
        var tagsToAdd = _db.Tags.Where(t => patchDto.AddTagIds.Contains(t.TagID)).ToList();
        foreach (var tag in tagsToAdd)
        {
            if (!note.Tags.Any(t => t.TagID == tag.TagID))
            {
                note.Tags.Add(tag);
            }
        }
    }

    note.ChangedDate = DateTime.Now;
    _db.SaveChanges();
    return NoContent();
}

这种方式更可控，避免了JsonPatch处理集合的潜在问题，也更符合REST API处理关联关系的常见实践。

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