取消 BlockingCollection.GetConsumingEnumerable() 并处理剩下的

Question

我有一个进程生成工作，第二个进程使用 BlockingCollection<> 消耗该工作。当我关闭我的程序时，我需要我的消费者停止消费工作，但我仍然需要快速记录等待但尚未消费的工作。

现在，我的消费者产生了一个具有foreach (<object> in BlockingCollection.GetConsumingEnumerable()) 循环的线程。当我停止我的程序时，我的制片人会打电话给Consumer.BlockingCollection.CompleteAdding()。我发现我的消费者继续处理队列中的所有内容。

谷歌搜索问题告诉我我需要使用CancellationToken。所以我试了一下：

private void Process () { // This method runs in a separate thread
    try {
        foreach (*work* in BlockingCollection.GetConsumingEnumerable(CancellationToken)) {
            // Consume
        }
    }
    catch (OperationCancelledException) {
        foreach (*work* in BlockingCollection.GetConsumingEnumerable()) {
            // quickly log
        }
    }
}

我的制作人有：

private CancellationTokenSource StopFlag = new CancellationTokenSource ();
MyConsumer.CancellationToken = StopFlag.Token;
// Make the consumer spawn it's consuming thread...
StopFlag.Cancel ();
MyConsumer.BlockingCollection.CompleteAdding ();

当我尝试这个时，没有任何迹象表明 OperationCancelledException 曾经发生过。

This question 试图解释取消令牌的使用，但似乎没有正确使用它。 （论点：如果它有效，那么它“足够正确”。）this question 似乎与我的问题完全相同，但没有示例。 （同样here。）

所以重申一下：我如何在BlockingCollection.GetConsumingEnumerable() 上正确使用CancellationToken，但需要注意的是，在使用不同的方法取消队列后，我需要处理队列中的剩余项目？

（我认为我的问题集中在正确使用 CancellationToken 上。我的测试均未表明该进程实际上已被取消。（StopFlag.IsCancellationRequested 始终等于 false。））

Answer 1

我的问题在于我是如何尝试取消操作的。我没有让生产者拥有 CancellationTokenSource，而是将其全部放在消费者中。

public class cProducer {
    private cConsumer myConsumer = new cConsumer ();

    public void onStart () {
        myConsumer.OnStart ();
    }

    public void onStop () {
        myConsumer.OnStop ();
    }

    public void OnOrderReceived (cOrder newOrder) {
        myConsumer.orderQueue.Add (cOrder);
    }
}

public class cConsumer {
    private CancellationTokenSource stopFlag;
    public BlockingCollection<cOrder> orderQueue = new BlockingCollection<cOrder> ();
    private Task processingTask;

    public void OnStart () {
        stopFlag = new CancellationTokenSource ();
        processingTask = Task.Factory.StartNew (() => Process ());
    }

    public void OnStop () {
        stopFlag.Cancel ();
        orderQueue.CompleteAdding ();
        processingTask.Wait ();
    }

    private void Process () {
        try {
            foreach (cOrder newOrder in orderQueue.GetConsumingEnumerable (stopFlag.Token)) {
                // process
            }
        }
        catch (OperationCanceledException) {
            foreach (cOrder cancelledOrder in orderQueue.GetConsumingEnumerable ()) {
                // log it
            }
        }
    }
}

Answer 2

当您将CancellationToken 传递给GetConsumingEnumerable 时，它不会抛出请求取消的异常，它只会停止吐出项目。与其捕获异常，不如检查令牌：

foreach (var item in BlockingCollection.
    GetConsumingEnumerable(CancellationToken))
{
    //consume item
}
if (CancellationToken.IsCancellationRequested)
    foreach (var item in BlockingCollection)
    {
        //log item
    }

还要注意，如果请求取消，并且可能没有调用 CompletedAdding，那么您应该只迭代集合，而不是调用 GetConsumingEnumerable。如果您知道取消操作时生产者将完成添加，那么这不是问题。