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

如何解决我可以将CancellationToken作为AspNetCore WebAPI中的参数传递吗

据我所知，我在services.AddControllers()中使用了services.AddMvc()或Startup.cs扩展名，“ MVC会在操作方法中自动绑定任何CancellationToken参数。

我有以下TestController和TestService作为临时服务。

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

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
    }
 }

解决方法

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

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

如果要取消Async任务，则CancellationTokens是由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