在 .NET 開發中，CancellationToken（取消令牌）是一項比較重要的功能，掌握并合理的使用 CancellationToken 可以提升服務的性能。特別在異步編程中，我常常會以創建 Task 的方式利用多線程執行一些耗時或非核心業務邏輯，表面上看既提高了整個流程的執行速度，又充分利用了服務器資源。然而類似 Task 的方式如果沒設置過取消令牌，一旦開啟，是無法被外部取消的，所以當主線程出異常或被提前終止時，已開啟的異步線程其實依然在執行，這時對服務器資源可能是一種浪費，而 CancellationToken 就可以對這類情況進行一定的補救。
下面通過幾種常見的使用場景來介紹 CancellationToken。
在 HttpClient 中的使用
HttpClient 是開發中比較常用的一個組件，關于超時可通過 Timeout 參數進行設置，其實它也是可以通過配置 CancellationToken 來實現超時定義，使用 CancellationToken 的最大好處是調用鏈共享此令牌狀態，狀態變更時會自動做出響應。
public async Task<string> GetHomeAsync(CancellationToken cancellationToken = default)
{
var client = _httpClientFactory.CreateClient();
var response = await client.GetAsync("https://github.com/", cancellationToken);
response.EnsureSuccessStatusCode();
return await response.Content.ReadAsStringAsync();
}
public async Task<string> GetGithubHome()
{
var cts = new CancellationTokenSource(1000);
var result = await _githubService.GetHomeAsync(cts.Token);
return result;
}
Github 一般訪問會比較慢，可通過設置 1s 演示效果：
在 gRPC 中的使用
通過 VS 的 gRPC 服務模板創建一個 gRPC 服務端（如果對 gRPC 的使用還不太了解，參考官方文檔 玩起來吧），服務端主要提供一個獲取用戶列表 (GetList) 的接口。實現如下，_userRepository 內部是基于 MongoDB 實現的查詢用戶數據，對應使用的 MongoDB.Driver 提供的方法默認已支持設置 CancellationToken，所以這里直接引用 ServerCallContext 上下文中的 CancellationToken，而此 CancellationToken 又是從客戶端傳遞來的，所以 CancellationToken 將作用于整個調用鏈中。另外如果在客戶端動態取消了此令牌，服務器也將會收到通知。
public override async Task<GetListReply> GetList(GetListRequest request, ServerCallContext context)
{
await Task.Delay(1000); // 模擬效果，服務端停1s
var users = await _userRepository.GetListAsync(context.CancellationToken);
var reply = new GetListReply();
foreach (var item in users)
{
reply.Users.Add(new UserModel { UserId = item.UserId, Name = item.Name });
}
return reply;
}
Client 端主要代碼如下，在接口層創建了 CancellationTokenSource 對象，并設置了令牌的過期時間，即在發起遠程調用時，如果 1s 內沒返回，那就取消這個調用。
public class UserService : IUserService
{
private readonly UserClient _client;
public UserService()
{
var channel = GrpcChannel.ForAddress("https://localhost:5001");
_client = new UserClient(channel);
}
public async Task<GetListReply> GetListAsync(CancellationToken cancellationToken = default)
{
return await _client.GetListAsync(new GetListRequest(), cancellationToken: cts.Token);
}
}
[HttpGet]
public async Task<string> GetUserList()
{
var cts = new CancellationTokenSource(1000);
var result = await _userService.GetListAsync(cts.Token);
return JsonConvert.SerializeObject(result.Users);
}
在 WebAPI 中的使用
前端調用后端的接口一般是基于 Ajax 來實現，當瀏覽器網頁被 連續 F5 刷新 或 頁面加載中被停止 或 Ajax 請求被主動 abort 時，控制臺 network 看板中會出現一些狀態為 canceled 的請求，如下：
對于這類請求，客戶端雖然主動放棄了，如果服務端沒有相應處理，其實接口對應的后端程序還是在不停的執行，只是這個執行結果不會被使用而已，所以這其實是非常浪費服務器資源的。
實際上瀏覽器取消請求時，服務端會將 HttpContext.RequestAborted 中的 Token 綁定到 Action 的 CancellationToken 參數。我們只需在接口中增加參數 CancellationToken，并將其傳入其他接口調用中，程序識別到令牌被取消就會自動放棄繼續執行。
[HttpGet]
public async Task<string> Index(CancellationToken cancellationToken)
{
try
{
await _userService.GetListAsync(cancellationToken);
await Task.Delay(5000); // 等待期間，取消請求（Postman 即可模擬）
await _githubService.GetHomeAsync(cancellationToken);
}
catch (Exception ex)
{
Console.WriteLine(ex.Message + Environment.NewLine + ex.StackTrace);
}
return "ok";
}
對于 WebAPI 接口被取消調用的場景，特別是對于查詢功能的接口，CancellationToken 的傳遞就顯得尤為必要了，它能減少很多底層服務接口的無效調用。
最后針對取消令牌產生的異常需要收尾干凈，一般像 WebAPI 項目可以使用自帶的過濾器或具有 AOP 功能的組件，gRPC 服務可使用自帶的攔截器功能。
