我可以在 AspNetCore WebAPI 中将 CancellationToken 作为参数传递吗

Posted 2023-03-31

【中文标题】我可以在 AspNetCore WebAPI 中将 CancellationToken 作为参数传递吗

【英文标题】：Can I pass CancellationToken as parameter in AspNetCore WebAPI

【发布时间】：2021-02-02 11:55:04

【问题描述】：

据我所知，如果我在Startup.cs 中使用services.AddControllers() 或services.AddMvc()extension，“MVC 将自动绑定操作方法中的任何CancellationToken 参数。

我有以下TestController 和TestService 作为瞬态服务。

根据此信息，当自动绑定CancellationTokenIsCancellationRequested时，我作为参数传递的令牌也会被取消吗？

public class TestController : ControllerBase

    private readonly ITestService _testService;

    public TestController(ITestService testService)
    
        _testService = testService;
    

    [HttpGet, ActionName("Get")]
    public async Task<IActionResult> GetAsync(CancellationToken cancellationToken)
    
        await _testService.GetAsync(cancellationToken);
        return Ok();
    


public class TestService : ITestService

    public async Task GetAsync(CancellationToken cancellationToken)
    
        //I also send the cancellationToken as a parameter to external API calls
    
 

【问题讨论】：

我有完全相同的问题，我提供的唯一解决方案是像您一样，将 cancelToken 作为参数传递给每个服务。他们将取消后续任务或 Linq to SQL。但我希望有一种更清洁的方法来做到这一点。

【参考方案1】：

当自动绑定的 CancellationToken IsCancellationRequested 将 我作为参数传递的令牌也被取消了吗？

通过将 CancellationToken 注入到您的操作方法中，该方法将自动绑定到请求的 HttpContext.RequestAborted 令牌。在用户刷新浏览器或单击“停止”按钮取消请求后，原始请求将被中止，并带有 TaskCancelledException，该异常通过 MVC 过滤器管道传播回来，并备份中间件管道。然后，您可以检查 IsCancellationRequested 的值并优雅地退出操作。在这种情况下，不需要将 CancellationToken 作为参数传递。

如果您想取消异步任务，因为 CancellationToken 是由 CancellationTokenSource 创建的轻量级对象。当取消 CancellationTokenSource 时，它​​会通知所有消费者 CancellationToken。因此，您可以调用 Cancel() 方法来取消任务。

检查以下示例：

        var cts = new CancellationTokenSource();
        //cts.CancelAfter(5000);//Request Cancel after 5 seconds

        _logger.LogInformation("New Test start");
        var newTask = Task.Factory.StartNew(state =>
        
            int i = 1;
            var token = (System.Threading.CancellationToken)state;
            while (true)
            
                Console.WriteLine(i);
                i++;
                if (i == 10)
                
                    cts.Cancel(); //call the Cancel method to cancel.
                
                _logger.LogInformation("thread running " + DateTime.Now.ToString());
                Thread.Sleep(1000);
                token.ThrowIfCancellationRequested();
            
        , cts.Token, cts.Token);

        try
        
            newTask.Wait(10000);
        
        catch
        
            Console.WriteLine("Catch:" + newTask.Status);
        

        _logger.LogInformation("Test end");

更多关于使用CancellationToken的详细信息，请查看以下文章：

Using CancellationTokens in ASP.NET Core MVC controllers

【讨论】：

我读过那篇文章，但我会尽力解释。我的意思是我有 3 个异步方法。第一种方法是我的控制器操作并调用第二个，然后第二个调用第三个。例如，第一种方法需要 5 秒。第二种方法需要 5 秒，第三种方法需要 10 秒。我将 CancellationToken 从第一个传递到第二个到第三个。如果用户在第十一（11）秒取消请求，第三种方法是否还能再工作 9 秒？