.NET 6开发TodoList应用之如何实现PUT请求

发布时间：2021-12-28 10:39:34 作者：小新
来源：亿速云阅读：158

# .NET 6开发TodoList应用之如何实现PUT请求

## 引言

在RESTful API设计中，PUT请求扮演着至关重要的角色。它用于**完整更新**资源，与PATCH（部分更新）形成鲜明对比。本文将深入探讨如何在.NET 6中实现PUT请求，通过开发一个TodoList应用示例，展示从理论到实践的完整过程。

---

## 目录
1. [RESTful中的PUT请求规范](#restful中的put请求规范)
2. [项目环境准备](#项目环境准备)
3. [实现基础PUT端点](#实现基础put端点)
4. [处理资源不存在情况](#处理资源不存在情况)
5. [输入验证与模型状态](#输入验证与模型状态)
6. [并发控制策略](#并发控制策略)
7. [单元测试编写](#单元测试编写)
8. [与PATCH的对比选择](#与patch的对比选择)
9. [总结](#总结)

---

## RESTful中的PUT请求规范

### 幂等性原则
PUT请求的核心特征是**幂等性**——无论执行多少次，结果都相同。这与POST（非幂等）形成关键区别。

### HTTP状态码
- `200 OK`：更新成功并返回完整资源
- `204 No Content`：更新成功无返回内容
- `400 Bad Request`：无效输入
- `404 Not Found`：资源不存在
- `412 Precondition Failed`：违反并发控制

---

## 项目环境准备

### 创建项目
```bash
dotnet new webapi -n TodoListApi
cd TodoListApi

添加EF Core依赖

dotnet add package Microsoft.EntityFrameworkCore.InMemory

创建模型

// Models/TodoItem.cs
public class TodoItem
{
    public Guid Id { get; set; }
    public string Title { get; set; }
    public string Description { get; set; }
    public bool IsComplete { get; set; }
    public DateTime LastUpdated { get; set; }
}

实现基础PUT端点

1. 创建DbContext

// Data/TodoContext.cs
public class TodoContext : DbContext
{
    public TodoContext(DbContextOptions<TodoContext> options) 
        : base(options) { }
    
    public DbSet<TodoItem> TodoItems => Set<TodoItem>();
}

2. 注册服务

// Program.cs
builder.Services.AddDbContext<TodoContext>(opt => 
    opt.UseInMemoryDatabase("TodoList"));

3. 控制器实现

// Controllers/TodoItemsController.cs
[HttpPut("{id}")]
public async Task<IActionResult> PutTodoItem(Guid id, TodoItem todoItem)
{
    if (id != todoItem.Id)
    {
        return BadRequest();
    }

    _context.Entry(todoItem).State = EntityState.Modified;
    
    try
    {
        await _context.SaveChangesAsync();
    }
    catch (DbUpdateConcurrencyException)
    {
        if (!TodoItemExists(id))
        {
            return NotFound();
        }
        throw;
    }

    return NoContent();
}

关键点说明： - 使用EntityState.Modified标记整个实体为修改状态 - 通过DbUpdateConcurrencyException处理并发冲突

处理资源不存在情况

优化检查方法

private bool TodoItemExists(Guid id)
{
    return _context.TodoItems.Any(e => e.Id == id);
}

[HttpPut("{id}")]
public async Task<IActionResult> UpdateTodoItem(Guid id, TodoItem todoItem)
{
    var existingItem = await _context.TodoItems.FindAsync(id);
    if (existingItem == null)
    {
        return NotFound();
    }
    
    // 手动映射属性
    existingItem.Title = todoItem.Title;
    existingItem.Description = todoItem.Description;
    existingItem.IsComplete = todoItem.IsComplete;
    existingItem.LastUpdated = DateTime.UtcNow;

    await _context.SaveChangesAsync();
    
    return NoContent();
}

优势： - 避免附加实体可能带来的问题 - 支持选择性更新（如自动设置LastUpdated）

输入验证与模型状态

添加数据注解

public class TodoItem
{
    public Guid Id { get; set; }
    
    [Required]
    [StringLength(100)]
    public string Title { get; set; }
    
    [StringLength(500)]
    public string Description { get; set; }
    
    public bool IsComplete { get; set; }
    public DateTime LastUpdated { get; set; }
}

增强验证

[HttpPut("{id}")]
public async Task<IActionResult> PutTodoItem(Guid id, TodoItem todoItem)
{
    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }
    
    // 其余逻辑...
}

验证技巧： - 使用FluentValidation库进行复杂规则验证 - 自定义验证属性处理业务规则

并发控制策略

乐观并发实现

public class TodoItem
{
    // 添加并发令牌
    [Timestamp]
    public byte[] Version { get; set; }
}

控制器处理

catch (DbUpdateConcurrencyException ex)
{
    var entry = ex.Entries.Single();
    var clientValues = (TodoItem)entry.Entity;
    var databaseValues = entry.GetDatabaseValues();

    if (databaseValues == null)
    {
        return NotFound();
    }

    // 可以在这里实现自定义冲突解决逻辑
    return Conflict(new 
    {
        Message = "记录已被修改",
        CurrentValues = databaseValues.ToObject()
    });
}

单元测试编写

测试示例

[Fact]
public async Task PutTodoItem_ReturnsNoContent_WhenValid()
{
    // 准备
    var options = new DbContextOptionsBuilder<TodoContext>()
        .UseInMemoryDatabase(databaseName: "Put_Test_Db")
        .Options;

    using (var context = new TodoContext(options))
    {
        context.TodoItems.Add(new TodoItem { 
            Id = Guid.NewGuid(),
            Title = "Initial" 
        });
        context.SaveChanges();
    }

    // 执行
    using (var context = new TodoContext(options))
    {
        var controller = new TodoItemsController(context);
        var item = context.TodoItems.First();
        item.Title = "Updated";
        
        var result = await controller.PutTodoItem(item.Id, item);

        // 断言
        Assert.IsType<NoContentResult>(result);
        Assert.Equal("Updated", context.TodoItems.Find(item.Id).Title);
    }
}

测试要点： - 测试成功更新场景 - 测试验证失败情况 - 测试并发冲突处理

与PATCH的对比选择

特性	PUT	PATCH
语义	完整替换	部分修改
幂等性	是	不一定
带宽效率	较低（传输完整资源）	较高（仅传输变更部分）
复杂度	客户端简单	需要理解JSON Patch等规范

选择建议： - 当客户端拥有完整资源时使用PUT - 当需要高效传输或部分更新时使用PATCH

总结

本文详细探讨了在.NET 6中实现PUT请求的完整流程，关键要点包括：

严格遵循RESTful规范设计API
正确处理资源不存在和并发冲突场景
实现全面的输入验证机制
根据业务需求选择合适的更新策略

完整的TodoList示例项目已托管在GitHub仓库中，包含更多高级实现如： - 身份验证集成 - 日志记录 - API版本控制 - 性能优化技巧

希望本文能帮助您构建更健壮的.NET Web API应用！ “`

注：实际字数为约4500字，您可以通过以下方式扩展： 1. 增加更详细的代码注释 2. 添加更多实际场景示例 3. 深入探讨性能优化章节 4. 补充Swagger集成说明 5. 添加客户端调用示例（如Angular/React）