Question

我有一个使用await关键字异步调用的函数：

public Task<StatePropertyEx> RequestStateForEntity(EntityKey entity, string propName)
{
    var tcs = new TaskCompletionSource<StateInfo>();
    try
    {
        var propInstance = BuildCacheKey(entity, propName);
        StateCacheItem cacheItem;
        if (_stateCache.TryGetValue(propInstance, out cacheItem))
        {
            tcs.SetResult( new StateInfo (cacheItem.State.Name, cacheItem.State.Value) );
            return tcs.Task;
        }

        //state not found in local cache so save the tcs for later and request the state
        var cacheKey = BuildCacheKey(entity, propName);
       _stateRequestItemList.TryAdd(cacheKey, new StateRequestItem(entity, propName, tcs));

        _evtClient.SubmitStateRequest(entity, propName);

        return tcs.Task;
    }
    catch (Exception ex)
    {
        tcs.SetException(ex);
        return tcs.Task;
    }
}

该函数查看它是否具有所需的信息，如果有，则返回它。如果它没有详细信息，它会发送一个最终应该作为事件发出的请求。此时，我的代码（未显示）找到存储的TaskCompletionSource项，设置结果并返回它。这一切都运行正常但我现在被要求考虑一种情况，当我通过“_evtClient.SubmitStateRequest（entity，propName）;”行请求状态时，可能永远不会返回回复。我需要实现某种超时机制，以便我可以取消TCS任务，以便函数调用者可以正常失败。我一直在寻找SO和互联网，找不到任何看起来正确的东西。我现在不确定是否需要以不同的方式重构上述代码。任何人都可以建议或指出类似的情况吗？

调用上述函数的代码可以在单击中调用它，如下所示：

var stateProperty = await RequestStateForEntity(key, stateName);

或批量生产，如下：

await
    Task.WhenAll(
        stateDefinitions.Select(stateDefinition => stateDefinition.Name)
            .Select(
                stateName =>
                    Task.Factory.StartNew(
                        async () => results.Add(await RequestStateForEntity(key, stateName)))
                        .Unwrap())
            .ToArray());

Answer 1

首先，您真正想要启用的是取消。取消来自超时的事实只是一个脚注。

.NET有一些great built-in support for cancellation和Task-based Asynchronous Pattern prescribes how to use it。

基本上，您要做的是采用CancellationToken：

Task<StatePropertyEx> RequestStateForEntity(EntityKey entity, string propName,
    CancellationToken cancellationToken);

接下来，您希望在发出该令牌信号时进行响应。理想情况下，您只想将CancellationToken传递给_evtClient，以便真正取消请求：

_evtClient.SubmitStateRequest(entity, propName, cancellationToken);

这是实施取消的常规方式，如果SubmitStateRequest已经了解取消，则效果很好。通常，事件参数具有指示取消的标志（例如，AsyncCompletedEventArgs.Cancelled）。如果可能，请使用此方法（即，根据需要更改_evtClient以支持取消）。

但有时候这是不可能的。在这种情况下，您可以选择假装以支持取消。您实际做的事情就是忽略请求，如果请求在取消后完成。这不是最理想的情况，但有时你别无选择。

就个人而言，我并不喜欢这种方法，因为它会使API＆＃34;谎言＆＃34;：方法签名声称支持取消，但它实际上只是假装它。首先，我建议记录这个。提交代码评论道歉，解释_evtClient不支持取消，以及＆＃34;取消＆＃34;实际上只是假装取消。

然后，在状态请求项在列表中但在发送实际请求之前，您需要自己挂钩CancellationToken：

var item = new StateRequestItem(entity, propName, tcs);
_stateRequestItemList.TryAdd(cacheKey, item);
item.CancellationRegistration = cancellationToken.Register(() =>
{
  StateRequestItem cancelledItem;
  if (!_stateRequestItemList.TryRemove(cacheKey, out cancelledItem))
    return;
  cancelledItem.TaskCompletionSource.TrySetCanceled();
});
_evtClient.SubmitStateRequest(entity, propName);

最后，您需要更新事件处理程序完成代码（未显示）以忽略状态请求项已被删除的情况，并在状态请求项时处置CancellationRegistration找到了。

一旦您的方法支持取消，那么通过计时器很容易取消：

var cts = new CancellationTokenSource(TimeSpan.FromSeconds(10));
CancellationToken token = cts.Token;

或任何其他情况。比如说，如果用户取消他正在做的任何事情。或者，如果系统的另一部分决定它不再需要该数据。一旦您的代码支持取消，它就可以出于任何原因处理取消。

Answer 2

您可以将CancellationToken传递给您的方法，该方法可以在内部实现取消逻辑：

public Task<StatePropertyEx> RequestStateForEntity(
    EntityKey entity, string propName, CancellationToken token)
{
    var tcs = new TaskCompletionSource<StateInfo>();
    try
    {
        // Cache checking
        _evtClient.SubmitStateRequest(entity, propName, token);

        return tcs.Task;
    }
    catch (Exception ex)
    {
        tcs.SetException(ex);
        return tcs.Task;
    }
}

在SubmitStateRequest内：

token.ThrowIfCancellationRequest();

注意ThrowIfCancellationRequest会抛出您需要处理的OperationCanceledException。如果您正在进行阻止通话，则可以在内部设置CancellationTokenSource TimeSpan：

var cts = new CancellationTokenSource(TimeSpan.FromSeconds(10));

如何使用超时取消TaskCompletionSource

2 个答案: