C# WebAPI中如何通过DTO仅更新需要修改的字段？

针对你想仅传入ID和需要修改的特定字段、避免全量更新的需求，这里有几个实用的实现方案：

1. 使用HTTP PATCH + JSON Patch（REST标准方案） #

PUT方法本身就是设计用来做全量更新的，如果你想做部分更新，HTTP PATCH是更贴合REST规范的选择。结合JsonPatchDocument可以精准修改指定字段：

控制器代码示例 #

using Microsoft.AspNetCore.JsonPatch;
using Microsoft.AspNetCore.Mvc;

[HttpPatch("{id}")]
public IActionResult Patch(int id, [FromBody] JsonPatchDocument<UpdateTablenameDTO> patchDoc)
{
    if (patchDoc == null)
    {
        return BadRequest("Patch文档不能为空");
    }

    // 从数据库获取目标实体
    var targetEntity = _dbContext.Tablename.Find(id);
    if (targetEntity == null)
    {
        return NotFound($"ID为{id}的记录不存在");
    }

    // 将实体映射到DTO（如果你的架构使用DTO的话）
    var dto = _mapper.Map<UpdateTablenameDTO>(targetEntity);
    
    // 应用Patch修改
    patchDoc.ApplyTo(dto, ModelState);

    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }

    // 将修改后的DTO映射回实体并保存
    _mapper.Map(dto, targetEntity);
    _dbContext.SaveChanges();

    return Ok(targetEntity);
}

客户端请求示例（JSON格式） #

只需要指定要执行的操作、目标字段和新值：

[
  {
    "op": "replace",
    "path": "/IsActive",
    "value": false
  }
]

2. 设计带可选字段的DTO #

把DTO中的可更新字段改为可空类型，在更新逻辑中只处理有值的字段：

可选字段DTO定义 #

public class UpdateTablenameDTO
{
    public int Id { get; set; }
    public bool? IsActive { get; set; }
    public string? Name { get; set; }
    // 其他需要更新的字段都设为可空引用类型/可空值类型
}

控制器更新逻辑 #

[HttpPut("{id}")]
public IActionResult Put(int id, [FromBody] UpdateTablenameDTO updateDto)
{
    if (id != updateDto.Id)
    {
        return BadRequest("URL中的ID与请求体中的ID不匹配");
    }

    var targetEntity = _dbContext.Tablename.Find(id);
    if (targetEntity == null)
    {
        return NotFound($"ID为{id}的记录不存在");
    }

    // 只更新有值的字段
    if (updateDto.IsActive.HasValue)
    {
        targetEntity.IsActive = updateDto.IsActive.Value;
    }
    if (!string.IsNullOrEmpty(updateDto.Name))
    {
        targetEntity.Name = updateDto.Name;
    }
    // 其他字段同理判断并更新

    _dbContext.SaveChanges();
    return Ok(targetEntity);
}

客户端请求示例 #

只需传入ID和需要修改的字段：

{
  "Id": 1,
  "IsActive": true
}

3. 创建场景专用DTO #

针对不同的更新场景（比如仅更新IsActive、仅更新名称），创建专用的小DTO，对应独立的控制器方法：

专用DTO定义 #

public class UpdateTablenameIsActiveDTO
{
    public int Id { get; set; }
    public bool IsActive { get; set; }
}

控制器方法 #

[HttpPut("{id}/is-active")]
public IActionResult UpdateIsActive(int id, [FromBody] UpdateTablenameIsActiveDTO updateDto)
{
    if (id != updateDto.Id)
    {
        return BadRequest("URL中的ID与请求体中的ID不匹配");
    }

    var targetEntity = _dbContext.Tablename.Find(id);
    if (targetEntity == null)
    {
        return NotFound($"ID为{id}的记录不存在");
    }

    targetEntity.IsActive = updateDto.IsActive;
    _dbContext.SaveChanges();

    return Ok(targetEntity);
}

方案对比 #

• JSON Patch：符合REST标准，支持复杂的多字段组合更新，但客户端需要了解JSON Patch语法，学习成本略高。
• 可选字段DTO：实现简单，客户端调用直观，适合字段数量不多的场景；但字段过多时，判断逻辑会变得繁琐。
• 专用DTO：职责单一，代码可读性高，维护方便；但更新场景较多时会产生大量DTO类，需要权衡。

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