.NET 6開發TodoList應用之實現DELETE請求與HTTP請求冪等性

Posted on by

需求

先說明一下關於原本想要去更新的PATCH請求的文章，從目前試驗的情況來看，如果是按照.NET 6的項目結構（即隻使用一個Program.cs完成程序初始化），那微軟官方給出的文檔目前還沒有對應地更新，按照之前的方式進行JsonPatch的配置是不行的，目前已經有人在Github微軟的官方文檔Repo下提瞭ISSUE: .NET 6: JsonPatch in ASP.NET Core web API。並且因為PATCH的使用頻率並不高，所以我暫時跳過那篇，先把進度繼續往後走，看微軟什麼時候把這個issue解決一下我再看情況把PATCH那一節補上。

本文我們來看最後一個常用HTTP請求類型：DELETE。

目標

實現並驗證應用正確處理DELETE請求。並對HTTP請求的冪等性做簡單的介紹。

原理與思路

經過關於Create、Update、Get的實現，對於Delete的實現我們的思路是很清晰的。我們需要創建Delete的Command及其Handler，然後在Controller中通過Mediatr發送請求即可。

實現

在Application/TodoList下新建DeleteTodoList文件夾，並新建DeleteTodoListCommand：

DeleteTodoListCommand.cs

using MediatR;
using TodoList.Application.Common.Exceptions;
using TodoList.Application.Common.Interfaces;

namespace TodoList.Application.TodoLists.Commands.DeleteTodoList;

public class DeleteTodoListCommand : IRequest
{
    public Guid Id { get; set; }
}

public class DeleteTodoListCommandHandler : IRequestHandler<DeleteTodoListCommand>
{
    private readonly IRepository<Domain.Entities.TodoList> _repository;

    public DeleteTodoListCommandHandler(IRepository<Domain.Entities.TodoList> repository)
    {
        _repository = repository;
    }

    public async Task<Unit> Handle(DeleteTodoListCommand request, CancellationToken cancellationToken)
    {
        var entity = await _repository.GetAsync(request.Id);
        if (entity == null)
        {
            throw new NotFoundException(nameof(TodoList), request.Id);
        }

        await _repository.DeleteAsync(entity,cancellationToken);
        // 對於Delete操作，演示中並不返回任何實際的對象，可以結合實際需要返回特定的對象。Unit對象在MediatR中表示Void
        return Unit.Value;
    }
}

在Controller中添加Delete的接口處理：

TodoListController.cs

// 省略其他...
[HttpDelete("{id:guid}")]
public async Task<ApiResponse<object>> Delete(Guid id)
{
    return ApiResponse<object>.Success(await _mediator.Send(new DeleteTodoListCommand { Id = id }));
}

這裡可能值得強調的是關於EntityFrameworkCore中對於關聯實體DELETE操作的處理方式：

打開Infrastructure/Migrations文件夾，我們可以在遷移領域實體的那次Migration生成的.Designer.cs文件中發現這樣一段配置：

// 省略其他...
modelBuilder.Entity("TodoList.Domain.Entities.TodoItem", b =>
    {
        b.HasOne("TodoList.Domain.Entities.TodoList", "List")
            .WithMany("Items")
            .HasForeignKey("ListId")
            .OnDelete(DeleteBehavior.Cascade)
            .IsRequired();
        b.Navigation("List");
    });

可以看到在OnDelete中配置的是DeleteBehavior.Cascade行為模式，關於DeleteBehavior，可以參考Referential Constraint Action Options。實際上總共有七種可以設置的行為模式：

  • DeleteBehavior.Cascade
  • DeleteBehavior.NoAction
  • DeleteBehavior.Restrict
  • DeleteBehavior.SetNull
  • DeleteBehavior.ClientCascade
  • DeleteBehavior.ClientNoAction
  • DeleteBehavior.ClientSetNull

關於這七種DeleteBehavior，可以參考這篇博文：Entity Framework Core 關聯刪除，博主在其中進行瞭比較詳細的實驗和總結。

可以根據實際需要去顯式地配置DeleteBehavior。另外，習慣觀察生成的Migrations文件，也是學習EFCore一些慣例或者說默認配置的很好的方法。

驗證

啟動Api項目，發送DELETE請求：

請求

響應

並且從數據庫裡我們以可以發現，這條TodoList下包含的TodoItem也被一同刪除瞭。

總結

到此為止HTTP常用的四大請求我們已經通過幾個例子講完瞭，關於HEAD請求OPTION請求以及遺留的PATCH請求後面會寫完。下一篇文章開始我們一起學習如何使用FluentValidation來進行請求參數校驗。

關於HTTP請求冪等性的介紹

首先明確兩個概念：

1.什麼叫做HTTP請求是否安全：如果我們執行請求後，對應的資源實體不發生改變，我們稱這個請求是安全的；

2.什麼叫做HTTP請求是否冪等：對於執行請求後產生的副作用（即指如果請求不安全，則稱其會產生副作用），請求執行一次和執行多次的副作用是相同的，我們稱這個請求是冪等的，很顯然安全的請求一定是冪等的。

瞭解瞭這兩個概念後，我們直接來看這張表格，快速地對HTTP請求的安全性和冪等性有一個認識。

鑒於PATCH方法並不常用，那麼重點需要關註的主要就是POST請求，以及一部分的PUT請求（比如更新的字段是在當前字段值的基礎上進行計算而新得出這種場景，實際就不是冪等的，但是我們一般不推薦在Update時做這種類型的操作，更推薦的是把計算邏輯前置到接口響應處理前，以整體設置值的方式去Update實體）。一般而言POST請求是用來創建資源的，如果不采取某種方式來保證執行結果的實際冪等性，那麼該請求產生的副作用將是難以控制和處理的。

如何保證接口的冪等性？

正式因為並非所有的HTTP請求（在這裡我們可以泛化到任意類型的接口請求）都是冪等的，而不管是應用程序內的容錯還是服務之間因為分區導致的對請求的冪等性更為嚴格的要求（尤其是在分佈式系統中，對於分區導致的請求重試的場景），我們需要在設計和實現接口的時候，把冪等性設計考慮進來，提高接口的魯棒性。

總體來說，實現接口的冪等性有兩種思路：一種是通過代碼邏輯去限制重復調用出現的副作用；第二種是通過Token唯一性來保證同一個請求不會被調用多次。

通過代碼邏輯去限制副作用的實現方式有很多種：從前端/界面的層次上去人為限制請求的重復發送（比如按鈕置灰禁止點擊之類的），通過在數據庫層面應用鎖或使用唯一索引，通過在邏輯執行過程中應用鎖等方式。這種方式隻能針對一些通過滿足某些判斷進行的邏輯實現，有其局限性。

通過Token唯一性保證冪等的思路大致是這樣：生成全局唯一的Token保存下來，並在前端頁面獲取保存，發送請求時連同Token一起發到後端，後端先進行Token校驗，校驗通過發送實際請求或執行邏輯，完成後刪除舊Token並生成新Token，那麼前端下次攜帶保存的舊Token來請求時，因為Token校驗不通過而拒絕繼續執行。這種方式就好比短信驗證碼，隻有第一次攜帶這個驗證碼請求時會成功，後端判斷第一次請求有效後就會把這個驗證碼置為無效，下次你就無法攜帶相同的驗證碼繼續發起請求瞭。例子不是特別恰當，但是可以類比著進行理解。 

到此這篇關於.NET 6開發TodoList應用之實現DELETE請求與HTTP請求冪等性的文章就介紹到這瞭,更多相關.NET 6實現DELETE請求與HTTP請求冪等性內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：