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

时间：2024-03-18 08:54:54|栏目：ASP.NET|点击：次

长时间运行的任务请求

现在我们假设您有一个 API 操作，在向用户发送响应之前可能需要一些时间才能完成。

在处理该操作时，用户可以直接取消请求，或刷新页面（这会有效地取消原始请求，并启动新请求）。

[HttpGet(Name = "get")]
public async Task 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端可以看到，操作方法执行完成两次。

.NET Core使用 CancellationToken 取消API请求的操作方法(图1)

这是否是正确将取决于您的应用程序。

如果请求修改某些业务的状态，那么您可能不希望在方法中途停止执行。如果请求没有副作用，那么您可能希望尽快停止（可能很昂贵）操作。

用户取消请求时，你可以使用HttpContext.RequestAborted访问，您也可以使用依赖注入将其自动注入到您的操作中。

CancellationTokens取消不必要的请求

以下代码显示了如何通过将CancellationTokenSource 注入到操作方法中，并通过其取消不必要的操作。

[HttpGet(Name = "get")]
public async Task 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";
}

通过这个改变，我们可以再次测试我们的场景。

我们发出一个初始请求，然后我们重新加载页面。正如您从下面的日志中看到的，第一个请求不会继续执行。

.NET Core使用 CancellationToken 取消API请求的操作方法(图2)

用户刷新浏览器取消请求后不久，原始请求就会中止，并TaskCancelledException通过 API 过滤器管道传播回来，并备份中间件管道。

根据您的场景，您可能能够依靠此类框架方法来检查的状态CancellationToken，或者您可能需要自己监视取消请求。

过滤器捕获异常

您可以通过以上try catch 捕获，或者通过一个过滤器统一监视此异常。

public class OperationCancelledExceptionFilter : ExceptionFilterAttribute
{
    private readonly ILogger _logger;
    public OperationCancelledExceptionFilter(ILoggerFactory loggerFactory)
    {
        _logger = loggerFactory.CreateLogger();
    }
    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();
});

.NET Core使用 CancellationToken 取消API请求的操作方法(图3)

到此这篇关于.NET Core使用 CancellationToken 取消API请求的文章就介绍到这了,更多相关.NET Core取消API请求内容请搜索科站长以前的文章或继续浏览下面的相关文章希望大家以后多多支持科站长！

上一篇：详解如何在.NET代码中使用本地部署的Deepseek语言模型

栏目：ASP.NET

下一篇：.Net Core 使用 TagProvider 与 Enricher 丰富日志的操作代码

本文标题：.NET Core使用 CancellationToken 取消API请求的操作方法

本文地址：https://www.fushidao.cc/wangluobiancheng/3216.html

更多ASP.NET

ASP.NET

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

目录

长时间运行的任务请求

CancellationTokens取消不必要的请求

过滤器捕获异常

您可能感兴趣的文章

阅读排行

推荐教程