带有 CancellationToken 的异步/等待不会取消操作

Question

我想使用CancellationToken 中止文件下载。这是我尝试过的：

public async Task retrieveDocument(Document document)
{
    // do some preparation work first before retrieving the document (not shown here)
    if (cancelToken == null)
    {
        cancelToken = new CancellationTokenSource();
        try
        {
            Document documentResult = await webservice.GetDocumentAsync(document.Id, cancelToken.Token);
            // do some other stuff (checks ...)
        }
        catch (OperationCanceledException)
        {
            Console.WriteLine("abort download");
        }
        finally
        {
            cancelToken = null;
        }
    }
    else
    {
        cancelToken.Cancel();
        cancelToken = null;
    }
}

public async Task<Document> GetDocumentAsync(string documentId, CancellationToken cancelToken)
{
    Document documentResult = new Document();

    try
    {

        cancelToken.ThrowIfCancellationRequested();

        documentResult = await Task.Run(() => manager.GetDocumentById(documentId));
    }

    return documentResult;
}

然后应该使用 cancelToken 来取消操作：

public override void DidReceiveMemoryWarning ()
{
    // Releases the view if it doesn't have a superview.
    base.DidReceiveMemoryWarning ();

    if (cancelToken != null) {
        Console.WriteLine ("Token cancelled");
        cancelToken.Cancel ();
    }
}

IsCancellationRequested 好像没有更新。所以操作不会被取消。我也试过用这个

cancelToken.ThrowIfCancellationRequested();
try{
    documentResult = await Task.Run(() => manager.GetDocumentById (documentId), cancelToken);
} catch(TaskCanceledException){
    Console.WriteLine("task canceled here");
}

但没有任何改变。

我做错了什么？

编辑：

这里是缺少的部分，例如GetDocumentById:

public Document GetDocumentById(string docid)
{
    GetDocumentByIdResult res;
    try
    {
        res = ws.CallGetDocumentById(session, docid);
    }
    catch (WebException e)
    {
        throw new NoResponseFromServerException(e.Message);
    }

    return res;
}

public Document CallGetDocumentById(Session session, string parmsstring)
{
    XmlDocument soapEnvelope = Factory.GetGetDocumentById(parmsstring);
    HttpWebRequest webRequest = CreateWebRequest(session);
    webRequest = InsertEnvelope(soapEnvelope, webRequest);
    string result = WsGetResponseString(webRequest);
    return ParseDocument(result);
}

static string WsGetResponseString(WebRequest webreq)
{
    string soapResult = "";
    IAsyncResult asyncResult = webreq.BeginGetResponse(null, null);
    if (asyncResult.AsyncWaitHandle.WaitOne(50000))
    {
        using (WebResponse webResponse = webreq.EndGetResponse(asyncResult))
        {
            if (webResponse != null)
            {
                using (var rd = new StreamReader(webResponse.GetResponseStream()))
                {
                    soapResult = rd.ReadToEnd();
                }
            }
        }
    }
    else
    {
        webreq.Abort();
        throw new NoResponseFromServerException();
    }

    return soapResult;
}

Answer 1

我想使用 CancellationToken 中止文件下载

下载文件是一种 I/O 操作，在 .NET 平台上可以使用异步可取消（基于 I/O 完成端口）功能。然而你似乎没有使用它们。

相反，您似乎正在使用执行阻塞 I/O 的 Task.Run 创建（一系列）任务，其中取消令牌不会传递给您的 Task.Run 链中的每个任务。

有关执行异步、可等待和可取消文件下载的示例，请参阅：

• 使用HttpClient：How to copy HttpContent async and cancelable?
• Windows 手机： Downloading and saving a file Async in Windows Phone 8
• 使用WebClient：有自己的取消机制：CancelAsync 方法，您可以将其连接到您的取消令牌，使用令牌的Register 方法：

  myToken.Register(myWebclient.CancelAsync);

• 使用抽象 WebRequest：如果它不是使用附加的取消令牌创建的，就像您编辑的示例一样，并且您实际上不是在下载文件，而是在读取内容字符串，您需要结合使用前面提到的几种方法。

您可以执行以下操作：

static async Task<string> WsGetResponseString(WebRequest webreq, CancellationToken cancelToken)`
{
    cancelToken.Register(webreq.Abort);
    using (var response = await webReq.GetResponseAsync())
    using (var stream = response.GetResponseStream())
    using (var destStream = new MemoryStream())
    {
        await stream.CopyToAsync(destStream, 4096, cancelToken);
        return Encoding.UTF8.GetString(destStream.ToArray());
    }
}

Answer 2

您的代码在启动 GetDocumentAsync 方法后只调用一次ThrowIfCancellationRequested()，使得捕获取消的窗口非常小。

您需要将CancellationToken 传递给GetDocumentById，并让它在操作之间调用ThrowIfCancellationRequested，或者将令牌直接传递给较低级别​​的某些调用。

作为对调用方法和CancellationToken 之间关系的快速测试，您可以将GetDocumentAsync 更改为：

cancelToken.ThrowIfCancellationRequested();
documentResult = await Task.Run(() => manager.GetDocumentById(documentId));
cancelToken.ThrowIfCancellationRequested();

并在创建CancellationTokenSource 后立即调用CancelToken.CancelAfter(50) 或类似名称...您可能需要根据GetDocumentById 运行的时间来调整50 的值。

[编辑]

鉴于您对问题的编辑，最快的解决方法是将CancelToken 传递给WsGetResponseString 并使用CancelToken.Register() 调用WebRequest.Abort()。

您也可以使用CancelAfter() 来实现您的50 秒超时，从BeginGetResponse..EndGetResponse 切换到GetResponseAsync 等。