HttpClient发送请求时CancellationToken的使用方式

发布时间 2023-11-03 09:24:46作者: skybirdzw

CancellationToken 是 C# 中用于取消异步操作的机制之一,它可以与 HttpClient 一起使用,以便在请求进行时取消请求。这对于处理用户取消请求或设置超时非常有用。以下是如何在使用 HttpClient 发送请求时使用 CancellationToken 的示例:

using System;
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        // 创建一个 CancellationTokenSource,用于创建 CancellationToken
        using (var cts = new CancellationTokenSource())
        {
            // 获取 CancellationToken
            CancellationToken cancellationToken = cts.Token;

            // 创建 HttpClient
            HttpClient httpClient = new HttpClient();

            try
            {
                // 发送 GET 请求,并将 CancellationToken 传递给请求
                HttpResponseMessage response = await httpClient.GetAsync("https://example.com", cancellationToken);

                if (response.IsSuccessStatusCode)
                {
                    string responseBody = await response.Content.ReadAsStringAsync();
                    Console.WriteLine("Response: " + responseBody);
                }
                else
                {
                    Console.WriteLine("Request failed with status code: " + response.StatusCode);
                }
            }
            catch (TaskCanceledException)
            {
                // 捕获 TaskCanceledException,表示请求被取消
                Console.WriteLine("Request was canceled.");
            }

            // 如果需要,可以随时取消请求
            // cts.Cancel();
        }
    }
}

  

在上面的示例中,我们创建了一个 CancellationTokenSourcects),并从中获取了 CancellationToken。然后,我们使用 HttpClientGetAsync 方法发送 GET 请求,并将 cancellationToken 传递给请求。如果在请求进行时取消了 CancellationToken,请求将被取消,并且会引发 TaskCanceledException 异常。

在示例的最后,我们演示了如何手动取消请求,通过调用 cts.Cancel() 方法来取消请求。

使用 CancellationToken 可以有效地处理请求的取消,例如在用户要求取消操作或设置超时时,你可以取消请求以防止长时间等待。