.NET WinForm后台线程消息缓存未实时推送UI、界面锁死问题求助

问题根源 #

1. Execute方法本质是同步执行：虽然返回Task类型，但方法内部没有任何异步等待逻辑，所有耗时操作都是同步阻塞运行，完全占满当前执行线程。
2. 大概率存在上层同步等待：如果调用异步方法的地方使用了.Wait()或者.Result同步等待结果，会直接触发WinForm的经典异步死锁，UI线程被完全阻塞，无法处理任何消息队列中的更新请求，直到后台逻辑全部跑完才会批量处理所有UI更新。
3. 后台线程设置同步上下文属于无效操作，对逻辑没有任何帮助，反而容易混淆线程上下文。

解决方案 #

1. 移除所有上层同步阻塞代码 #

UI层调用异步方法时必须用await关键字，绝对不要使用.Wait()/.Result同步等待，UI层的await不要加ConfigureAwait(false)，保证await之后的逻辑回到UI线程执行。
错误示例：

// 绝对不要这么写
controller.Execute(model, task).Wait();
var res = controller.Execute(model, task).Result;

正确示例：

// UI层直接await
await controller.Execute(model, task);

2. 改造Execute方法，把同步耗时逻辑丢到线程池 #

将方法内所有CPU密集的同步运算包裹到Task.Run中，交给线程池线程执行，避免阻塞UI线程：

protected override async Task Execute(iNhdPlusBaseModel pModel, string sTask)
{
    // 删掉这句无效代码
    // SyncrhonizationContext.SetSynchronizationContext(Form_StepProcessor.SynchronizationContext);

    await Task.Run(() =>
    {
        // 原有的所有耗时操作、InvokeMessage调用都放到这个块里
        // do stuff ...
        this.InvokeMessage("here's a sample log message!", 10);
        // do stuff ...
        this.InvokeMessage("here's a second sample log message!", 20);
        // etc.
    }).ConfigureAwait(false);
}

3. （推荐）替换自定义事件为.NET标准IProgress实现进度上报 #

用框架自带的IProgress<T>/Progress<T>替代自定义事件，无需手动处理同步上下文，逻辑更简洁，也能避免静态事件导致的内存泄漏问题：
第一步：保持你现有的ProcessResultEventArgs不变。
第二步：修改Execute方法，增加IProgress<ProcessResultEventArgs>参数：

protected override async Task Execute(iNhdPlusBaseModel pModel, string sTask, IProgress<ProcessResultEventArgs> progress = null)
{
    await Task.Run(() =>
    {
        // do stuff ...
        progress?.Report(new ProcessResultEventArgs
        {
            Status = enpls_ProcessStatus.Message,
            Message = $"{DateTime.Now:HH:mm:ss}->here's a sample log message!",
            PercentComplete = 10
        });
        // do stuff ...
    }).ConfigureAwait(false);
}

第三步：UI层调用时构造Progress<T>实例，回调自动在UI线程执行，直接更新UI即可：

var progress = new Progress<ProcessResultEventArgs>(e =>
{
    // 直接操作UI控件，无需手动Post到同步上下文
    txtLog.AppendText(e.Message + Environment.NewLine);
    progressBar1.Value = e.PercentComplete;
});
await controller.Execute(model, task, progress);

4. 修复静态事件潜在问题 #

你当前使用的静态ProcessResult事件会导致订阅过的窗体无法被GC回收，引发内存泄漏，要么将事件改为实例事件，要么在窗体FormClosing事件中手动取消订阅：

private void Form_StepProcessor_FormClosing(object sender, FormClosingEventArgs e)
{
    AbsNhdPlusDotNetControllerAsync.ProcessResult -= this.OnProcessDotNetAsyncResult;
}

以上修改完成后即可解决UI卡死、进度批量更新的问题。 #

内容的提问来源于stack exchange，提问作者GIS-Monkey