等待和同步由非托管应用程序托管的托管组件中的上下文

Task testTask;
public void Test()
{
    this.testTask = TestAsync();
}
async Task TestAsync()
{
    Debug.Print("thread before await: {0}", Thread.CurrentThread.ManagedThreadId);
    var ctx1 = SynchronizationContext.Current;
    Debug.Print("ctx1: {0}", ctx1 != null? ctx1.GetType().Name: null);
    if (!(ctx1 is WindowsFormsSynchronizationContext))
        SynchronizationContext.SetSynchronizationContext(new WindowsFormsSynchronizationContext());
    var ctx2 = SynchronizationContext.Current;
    Debug.Print("ctx2: {0}", ctx2.GetType().Name);
    await TaskEx.Delay(1000);
    Debug.WriteLine("thread after await: {0}", Thread.CurrentThread.ManagedThreadId);
    var ctx3 = SynchronizationContext.Current;
    Debug.Print("ctx3: {0}", ctx3 != null? ctx3.GetType().Name: null);
    Debug.Print("ctx3 == ctx1: {0}, ctx3 == ctx2: {1}", ctx3 == ctx1, ctx3 == ctx2);
}

等待前线程：1ctx1：同步上下文ctx2： WindowsFormsSynchronizationContext等待后的线程：1ctx3：同步上下文ctx3 == ctx1：真，ctx3 == ctx2：假

这会有点长。首先，感谢Matt Smith和Hans Passant的想法，他们非常有帮助。

这个问题是由一位老朋友引起的，Application.DoEvents，尽管以一种新奇的方式。汉斯有一篇关于为什么DoEvents是邪恶的好文章。遗憾的是，由于旧版非托管主机应用带来的同步 API 限制，我无法避免在此控件中使用 DoEvents（稍后将详细介绍）。我很清楚DoEvents的现有含义，但在这里我相信我们有一个新的：

在没有显式 WinForms 消息循环的线程（即任何尚未输入 Application.Run 或 Form.ShowDialog 的线程）上，调用 Application.DoEvents 会将当前同步上下文替换为默认SynchronizationContext，前提是WindowsFormsSynchronizationContext.AutoInstall true（默认情况下如此）。

如果它不是一个错误，那么这是一个非常令人不快的未记录的行为，可能会严重影响一些组件开发人员。

这是一个重现该问题的简单控制台 STA 应用程序。请注意WindowsFormsSynchronizationContext如何在Test的第一遍中（错误地）替换为SynchronizationContext，而在第二遍中则不被替换。

using System;
using System.Diagnostics;
using System.Threading;
using System.Threading.Tasks;
using System.Windows.Forms;
namespace ConsoleApplication
{
    class Program
    {
        [STAThreadAttribute]
        static void Main(string[] args)
        {
            Debug.Print("ApartmentState: {0}", Thread.CurrentThread.ApartmentState.ToString());
            Debug.Print("*** Test 1 ***");
            Test();
            SynchronizationContext.SetSynchronizationContext(null);
            WindowsFormsSynchronizationContext.AutoInstall = false;
            Debug.Print("*** Test 2 ***");
            Test();
        }
        static void DumpSyncContext(string id, string message, object ctx)
        {
            Debug.Print("{0}: {1} ({2})", id, ctx != null ? ctx.GetType().Name : "null", message);
        }
        static void Test()
        {
            Debug.Print("WindowsFormsSynchronizationContext.AutoInstall: {0}", WindowsFormsSynchronizationContext.AutoInstall);
            var ctx1 = SynchronizationContext.Current;
            DumpSyncContext("ctx1", "before setting up the context", ctx1);
            if (!(ctx1 is WindowsFormsSynchronizationContext))
                SynchronizationContext.SetSynchronizationContext(new WindowsFormsSynchronizationContext());
            var ctx2 = SynchronizationContext.Current;
            DumpSyncContext("ctx2", "before Application.DoEvents", ctx2);
            Application.DoEvents();
            var ctx3 = SynchronizationContext.Current;
            DumpSyncContext("ctx3", "after Application.DoEvents", ctx3);
            Debug.Print("ctx3 == ctx1: {0}, ctx3 == ctx2: {1}", ctx3 == ctx1, ctx3 == ctx2);
        }
    }
}

调试输出：

公寓状态： STA测试 1 ***WindowsFormsSynchronizationContext.AutoInstall： TrueCTX1：空（在设置上下文之前）ctx2：WindowsFormsSynchronizationContext（在Application.DoEvents之前）ctx3：SynchronizationContext（在Application.DoEvents之后）ctx3 == ctx1：假，ctx3 == ctx2：假测试 2 ***WindowsFormsSynchronizationContext.AutoInstall： FalseCTX1：空（在设置上下文之前）ctx2：WindowsFormsSynchronizationContext（在Application.DoEvents之前）ctx3：WindowsFormsSynchronizationContext（在Application.DoEvents之后）ctx3 == ctx1：假，ctx3 == ctx2：真

对框架的Application.ThreadContext.RunMessageLoopInner和WindowsFormsSynchronizationContext.InstalIifNeeded/Uninstall的实施进行了一些调查，以了解它发生的原因。条件是线程当前不执行Application消息循环，如上所述。RunMessageLoopInner的相关文章：

if (this.messageLoopCount == 1)
{
    WindowsFormsSynchronizationContext.InstallIfNeeded();
}

然后，WindowsFormsSynchronizationContext.InstallIfNeeded/Uninstall对方法中的代码无法正确保存/还原线程的现有同步上下文。在这一点上，我不确定这是一个错误还是一个设计功能。

解决方案是 禁用WindowsFormsSynchronizationContext.AutoInstall ，就像这样简单：

struct SyncContextSetup
{
    public SyncContextSetup(bool autoInstall)
    {
        WindowsFormsSynchronizationContext.AutoInstall = autoInstall;
        SynchronizationContext.SetSynchronizationContext(new WindowsFormsSynchronizationContext());
    }
}
static readonly SyncContextSetup _syncContextSetup =
    new SyncContextSetup(autoInstall: false);

关于我为什么首先在这里使用Application.DoEvents的几句话。它是使用嵌套消息循环在 UI 线程上运行的典型异步到同步桥接代码。这是一种不好的做法，但旧版主机应用希望所有 API 同步完成。此处描述了原始问题。在稍后的某个时候，我用 Application.DoEvents/MsgWaitForMultipleObjects 的组合替换了 CoWaitForMultipleHandles，现在看起来像这样：

[编辑] WaitWithDoEvents的最新版本在这里。[/已编辑]

这个想法是使用 .NET 标准机制调度消息，而不是依赖CoWaitForMultipleHandles来执行此操作。就在那时，由于DoEvents的描述行为，我隐式地引入了同步上下文的问题。

旧版应用目前正在使用现代技术重写，控件也是如此。当前实施面向因我们无法控制的原因而无法升级的 Windows XP 现有客户。

最后，这是我在问题中提到的自定义等待程序的实现，作为缓解问题的选项。这是一次有趣的经历，它有效，但不能被认为是一个正确的解决方案。

/// <summary>
/// AwaitHelpers - custom awaiters
/// WithContext continues on the control's thread after await
/// E.g.: await TaskEx.Delay(1000).WithContext(this)
/// </summary>
public static class AwaitHelpers
{
    public static ContextAwaiter<T> WithContext<T>(this Task<T> task, Control control, bool alwaysAsync = false)
    {
        return new ContextAwaiter<T>(task, control, alwaysAsync);
    }
    // ContextAwaiter<T>
    public class ContextAwaiter<T> : INotifyCompletion
    {
        readonly Control _control;
        readonly TaskAwaiter<T> _awaiter;
        readonly bool _alwaysAsync;
        public ContextAwaiter(Task<T> task, Control control, bool alwaysAsync)
        {
            _awaiter = task.GetAwaiter();
            _control = control;
            _alwaysAsync = alwaysAsync;
        }
        public ContextAwaiter<T> GetAwaiter() { return this; }
        public bool IsCompleted { get { return !_alwaysAsync && _awaiter.IsCompleted; } }
        public void OnCompleted(Action continuation)
        {
            if (_alwaysAsync || _control.InvokeRequired)
            {
                Action<Action> callback = (c) => _awaiter.OnCompleted(c);
                _control.BeginInvoke(callback, continuation);
            }
            else
                _awaiter.OnCompleted(continuation);
        }
        public T GetResult()
        {
            return _awaiter.GetResult();
        }
    }
}

WindowsFormsSynchronizationContext 在创建控件时自动安装，除非您已将其关闭。 因此，除非在创建控件后其他人踩踏它，否则没有什么特别的事情要做。

您可以在WindowsFormsSynchronizationContext.InstalIifNeed上设置断点，以查看何时发生。

看：

• http://msdn.microsoft.com/en-us/library/system.windows.forms.windowsformssynchronizationcontext.autoinstall.aspx
• http://msdn.microsoft.com/en-us/magazine/gg598924.aspx

（我知道这不能回答你的问题，但不想把它放在评论中）