即使 CancelIsRequested，Task.IsCompleted 也保持为假

Question

在我的 LogManager 中，我有一个异步任务，它运行一个 while 循环来将日志信息写入文本文件（并将其添加到集合中）。当我尝试取消这个任务时，循环似乎停止了（我尝试了几个 Console.WriteLines），但是任务没有完成。

下面是这个类的主要方法：

public static DateTime StartTime;
private static CancellationTokenSource SaveLoopToken;
private static Task SaveLoopTask;

public static void Start()
{
    LogMessage startMessage = new LogMessage("Logging Started");
    startMessage.SetCaller("StartLogging", "LogManager");
    StartTime = startMessage.Time;
    LogQueue.Post(startMessage);
    StartSaveLoop();
}

public static void Stop()
{
    LogMessage stopMessage = new LogMessage("Logging Stopped");
    stopMessage.SetCaller("StopLogging", "LogManager");
    LogQueue.Post(stopMessage);
    StopSaveLoop();
}

private static void StartSaveLoop()
{
    SaveLoopToken = new CancellationTokenSource();
    SaveLoopTask = SaveLoop(SaveLoopToken);
    Console.WriteLine("Loop started!");
}

private static void StopSaveLoop()
{
    Console.WriteLine("Stop requested");

    SaveLoopToken.Cancel();

    while (!SaveLoopTask.IsCompleted)
    {
        Thread.Sleep(100);
    }

    Console.WriteLine("Loop stopped!");
}

private static void AddLogToCollection(LogMessage logMessage)
{
    // Add to MessageList
    MessageList.Add(logMessage);

    // Add to CurrentMessageList
    CurrentMessageList.Add(logMessage);

    // Add to FilteredMessageList
    if (logMessage.Level >= FilterLevel)
    {
        FilteredMessageList.Add(logMessage);
    }
}

private static async Task SaveLoop(CancellationTokenSource cancel)
{
    string logPath = "logs\\";
    string logFile = StartTime.ToString("yyyy-MM-dd_HH-mm-ss") + ".log";
    string fullPath = Path.Combine(logPath, logFile);

    if (!Directory.Exists(logPath))
        Directory.CreateDirectory(logPath);

    using (FileStream fileStream = new FileStream(fullPath, FileMode.Append, FileAccess.Write, FileShare.Read, 8192, useAsync: true))
    {
        using (StreamWriter writer = new StreamWriter(fileStream))
        {
            while (true)
            {
                LogMessage logMessage = await LogQueue.ReceiveAsync(cancel.Token);

                AddLogToCollection(logMessage);

                await writer.WriteAsync(String.Format("({0}) ", logMessage.LogID));
                await writer.WriteAsync(String.Format("[{0}][{1}] ", logMessage.Time.ToString("HH:mm:ss:fff"), logMessage.Level.ToString()));
                await writer.WriteAsync(logMessage.Message);
                await writer.WriteLineAsync(String.Format(" ({0} - {1})", logMessage.Method, logMessage.Location));

                if (cancel.IsCancellationRequested)
                    break;
            }
        }
    }
}

---

以前的 Start/StopSaveLoop 方法：

private static async void StartSaveLoop()
{
    SaveLoopToken = new CancellationTokenSource();
    Console.WriteLine("Loop started!");

    await SaveLoop(SaveLoopToken);
    Console.WriteLine("Loop stoped!");
}

private static void StopSaveLoop()
{
    Console.WriteLine("Stop requested");
    SaveLoopToken.Cancel();
}

Answer 1

我怀疑您可能会看到我描述的on my blog 和in a recent MSDN article 的死锁情况。如果 Application 启动和退出事件在 WPF UI 上下文中运行（我怀疑它们是），那么 SaveLoop 将尝试在 UI 线程上完成其 Task（它不能，因为 @987654326 @事件正在阻塞等待Task完成的UI线程。

您可以忽略这个问题（所有文件都已正确关闭，但缓冲的数据可能会丢失）。或者您可以调整您的解决方案以支持完全关闭。

一个调整选项是在后台线程上运行日志写入器（或者像以前一样使用Task.Run 来包装SaveLoop，或者对SaveLoop 中的每个await 使用ConfigureAwait(false)）。这种方法的问题在于，如果集合是数据绑定到 UI 元素，它可能无法很好地与 AddLogToCollection 配合使用。