Xamarin Android应用中HttpClient结合CancellationToken超时失效问题

问题描述 #

我开发了一个Xamarin Forms Android应用，尝试使用CancellationToken为HttpClient设置超时，但未生效：预期5秒超时，实际请求约2分钟才触发超时。相同代码在.NET Core应用中可正常5秒超时，请问为何Mono框架会忽略取消令牌，以及合理的解决方法是什么？

相关代码 #

HttpClient初始化与请求方法

private HttpClient _httpClient = new HttpClient(new HttpClientHandler() { UseProxy = false })
{
    Timeout = TimeSpan.FromSeconds(5)
};

public async Task<T> GetAsync<T>(string url, TimeSpan timeout) where T : new()
{
    using (var tokenSource = new CancellationTokenSource(timeout))
    {
        try
        {
            using (var response = await _httpClient.GetAsync(url, tokenSource.Token))
            {
                // never gets here when it times out on a bad address.

                response.EnsureSuccessStatusCode();
                using (var responseStream = await response.Content.ReadAsStreamAsync())
                {
                    if (response.IsSuccessStatusCode)
                    {
                        using (var textReader = new StreamReader(responseStream))
                        {
                            using (var jsonReader = new JsonTextReader(textReader))
                            {
                                return JsonSerializer.CreateDefault().Deserialize<T>(jsonReader);
                            }
                        }
                    }
                    else
                    {
                        return default(T);
                    }
                }
            }
        }
        catch (TaskCanceledException)
        {
            // this gets hit after about 2 minutes as opposed to the 5 seconds I expected.
            return default(T);
        }
        catch
        {
            return default(T);
        }
    }
}

调用代码

var myObject = await GetAsync<MyObject>("https://example.com/badRequest", TimeSpan.FromSeconds(5));

原因分析 #

• 底层依赖限制：Mono环境下默认的HttpClientHandler基于Android系统的HttpURLConnection实现，而HttpURLConnection不支持通过CancellationToken主动中断DNS解析、TCP连接建立这类底层系统操作。当请求处于这些阶段时，CancellationToken的取消信号无法传递到底层，只能等待系统默认的超时（约2分钟）才会触发异常。
• 超时机制冲突：你同时设置了HttpClient.Timeout和CancellationTokenSource的超时，在.NET Core中两者会协同工作优先响应CancellationToken，但Mono中HttpClient.Timeout依赖底层系统超时，CancellationToken的取消无法干预底层未完成的操作，导致超时逻辑失效。

解决方法 #

1. 切换到AndroidClientHandler（推荐） #

Xamarin Android 10.0及以上版本支持AndroidClientHandler，它基于OkHttp实现，对CancellationToken的支持更完善，能正确响应超时取消。

// 需要先安装Xamarin.AndroidX.OkHttp NuGet包
private HttpClient _httpClient = new HttpClient(new AndroidClientHandler() { UseProxy = false })
{
    Timeout = TimeSpan.FromSeconds(5)
};

2. 手动结合超时任务与请求任务 #

如果无法切换AndroidClientHandler，可以用Task.WhenAny将请求任务和延迟超时任务绑定，主动触发取消：

public async Task<T> GetAsync<T>(string url, TimeSpan timeout) where T : new()
{
    using (var tokenSource = new CancellationTokenSource())
    {
        var timeoutTask = Task.Delay(timeout, tokenSource.Token);
        var requestTask = _httpClient.GetAsync(url, tokenSource.Token);

        var completedTask = await Task.WhenAny(requestTask, timeoutTask);
        if (completedTask == timeoutTask)
        {
            tokenSource.Cancel();
            return default(T);
        }

        try
        {
            using (var response = await requestTask)
            {
                response.EnsureSuccessStatusCode();
                using (var responseStream = await response.Content.ReadAsStreamAsync())
                using (var textReader = new StreamReader(responseStream))
                using (var jsonReader = new JsonTextReader(textReader))
                {
                    return JsonSerializer.CreateDefault().Deserialize<T>(jsonReader);
                }
            }
        }
        catch (TaskCanceledException)
        {
            return default(T);
        }
        catch
        {
            return default(T);
        }
    }
}

3. 统一超时机制 #

避免同时设置HttpClient.Timeout和CancellationTokenSource超时，选择其中一种即可，减少行为不一致的风险。

内容的提问来源于stack exchange，提问作者Mike Luken