.NET?Core使用?CancellationToken?取消API請求的操作方法

更新時間：2024年03月18日 08:54:54 作者：hester·chen

用戶取消請求時，你可以使用HttpContext.RequestAborted訪問，您也可以使用依賴注入將其自動注入到您的操作中，這篇文章主要介紹了.NET?Core使用?CancellationToken?取消API請求,需要的朋友可以參考下

長時間運行的任務請求

現(xiàn)在我們假設您有一個 API 操作，在向用戶發(fā)送響應之前可能需要一些時間才能完成。

在處理該操作時，用戶可以直接取消請求，或刷新頁面（這會有效地取消原始請求，并啟動新請求）。

[HttpGet(Name = "get")]
public async Task<string> GetAsync()
{
    try
    {
        _logger.LogInformation("request in");
        await Task.Delay(5 * 1000);
        _logger.LogInformation("request end");
    }
    catch (Exception ex)
    {
        _logger.LogInformation("request ex");
    }
    return "ok";
}

如果用戶在請求中途刷新瀏覽器，那么瀏覽器永遠不會收到第一個請求的響應，但在server端可以看到，操作方法執(zhí)行完成兩次。

這是否是正確將取決于您的應用程序。

如果請求修改某些業(yè)務的狀態(tài)，那么您可能不希望在方法中途停止執(zhí)行。如果請求沒有副作用，那么您可能希望盡快停止（可能很昂貴）操作。

用戶取消請求時，你可以使用HttpContext.RequestAborted訪問，您也可以使用依賴注入將其自動注入到您的操作中。

CancellationTokens取消不必要的請求

以下代碼顯示了如何通過將CancellationTokenSource 注入到操作方法中，并通過其取消不必要的操作。

[HttpGet(Name = "get")]
public async Task<string> GetAsync(CancellationToken cancellationToken)
{
    try
    {
        _logger.LogInformation("request in");
        await Task.Delay(5 * 1000,cancellationToken);
        _logger.LogInformation("request end");
    }
    catch (Exception ex)
    {
        _logger.LogInformation("request ex");
    }
    return "ok";
}

通過這個改變，我們可以再次測試我們的場景。

我們發(fā)出一個初始請求，然后我們重新加載頁面。正如您從下面的日志中看到的，第一個請求不會繼續(xù)執(zhí)行。

用戶刷新瀏覽器取消請求后不久，原始請求就會中止，并TaskCancelledException通過 API 過濾器管道傳播回來，并備份中間件管道。

根據(jù)您的場景，您可能能夠依靠此類框架方法來檢查的狀態(tài)CancellationToken，或者您可能需要自己監(jiān)視取消請求。

過濾器捕獲異常

您可以通過以上try catch 捕獲，或者通過一個過濾器統(tǒng)一監(jiān)視此異常。

public class OperationCancelledExceptionFilter : ExceptionFilterAttribute
{
    private readonly ILogger _logger;
    public OperationCancelledExceptionFilter(ILoggerFactory loggerFactory)
    {
        _logger = loggerFactory.CreateLogger<OperationCancelledExceptionFilter>();
    }
    public override void OnException(ExceptionContext context)
    {
        if (context.Exception is OperationCanceledException)
        {
            _logger.LogInformation("Request was cancelled");
            context.ExceptionHandled = true;
            context.Result = new StatusCodeResult(400);
        }
    }
}
builder.Services.AddControllers(options =>
{
    options.Filters.Add<OperationCancelledExceptionFilter>();
});