使用KevinDockx-Jsonpatch向数组添加元素时遇TargetLocationAtPathSegmentNotFound错误

这个报错的核心原因是：ICollection<T>接口本身没有索引器，也不支持直接通过-（代表追加到末尾）的语义来定位元素位置，而KevinDockx的JsonPatch库默认依赖集合的索引能力来处理add操作的路径定位。下面给你几个可行的解决思路，按实现复杂度从低到高排序：

1. 把ICollection替换为List（最简便方案） #

直接修改你的EF模型，将ICollection<Link>换成List<Link>——因为List<T>自带索引器，库可以正确识别/links/-（追加到数组末尾）或者指定索引的路径：

[Table("XXX.Websites")]
public partial class Website : Entity 
{
    [StringLength(255)]
    public string Name { get; set; }
    // 将ICollection替换为List
    public virtual List<Link> Links { get; set; } 
}

注意事项： #

• EF Code First迁移时，这个变更不会影响数据库结构（EF底层还是通过外键关联维护集合关系），可以放心更新。
• 修改后，你原来的两种请求格式都能正常工作：
  • 追加到末尾：[{"op": "add", "path": "/links/-", "value": {"linkName": "test", "linkValue": "http://test.com", "id": 0, "websiteId": 123, "valid": true}}]
  • 插入到指定索引（如果索引小于等于当前集合长度）：[{"op": "add", "path": "/links/8", "value": {"linkName": "test", "linkValue": "http://test.com", "id": 0, "websiteId": 123, "valid": true}}]

2. 自定义ObjectAdapter适配ICollection（保留原模型类型） #

如果因为业务原因必须保留ICollection<Link>，可以给JsonPatch库注册一个自定义的IObjectAdapter，专门处理ICollection的add操作：

首先实现自定义适配器：

public class CustomCollectionAdapter : DefaultObjectAdapter
{
    public override void Add(object target, string segment, object value)
    {
        // 针对ICollection<Link>做特殊处理
        if (target is Website website && website.Links is ICollection<Link> linksCollection)
        {
            // 处理追加到末尾的情况（路径用/-）
            if (segment == "-")
            {
                linksCollection.Add((Link)value);
                return;
            }

            // 处理指定索引的插入
            if (int.TryParse(segment, out int index))
            {
                // 将ICollection转为List以支持索引插入
                var linksList = linksCollection.ToList();
                if (index >= 0 && index <= linksList.Count)
                {
                    linksList.Insert(index, (Link)value);
                    // 重新赋值给原对象的Links属性（因为ICollection本身不可变）
                    website.Links = linksList;
                    return;
                }
                throw new JsonPatchException($"Invalid index {index} for Links collection");
            }
        }

        // 其他类型沿用默认处理逻辑
        base.Add(target, segment, value);
    }
}

然后在API的服务配置中注册这个适配器（比如Program.cs或者Startup.cs）：

services.AddControllers()
    .AddJsonPatch(options =>
    {
        // 替换默认适配器为自定义实现
        options.ObjectAdapter = new CustomCollectionAdapter();
    });

3. 确认API端点的基础配置 #

最后检查两个容易忽略的细节：

• 你的API方法必须正确接收JsonPatchDocument<Website>参数，并且加载关联的Links集合：

  [HttpPatch("{id}")]
  public IActionResult PatchWebsite(int id, [FromBody] JsonPatchDocument<Website> patchDoc)
  {
      // 必须Include加载Links集合，否则EF会延迟加载导致集合为空
      var website = _context.Websites.Include(w => w.Links)
                                      .FirstOrDefault(w => w.Id == id);
      if (website == null)
      {
          return NotFound();
      }
  
      patchDoc.ApplyTo(website);
      _context.SaveChanges();
      return Ok(website);
  }
  

• 客户端请求的Content-Type必须设置为application/json-patch+json，否则API可能无法正确解析补丁文档。

内容的提问来源于stack exchange，提问作者D. Pesc.