C#异步方法中如何将文本写入剪贴板（.NET Framework 4.7）

在基于 .NET Framework 4.7 的 C# 控制台应用中，同步 Main 方法加 [STAThread] 特性时，可以正常通过如下代码将文本复制到剪贴板：

using System.Windows.Forms;

class Program {
    [STAThread]
    public static void Main(string[] args) {
        Clipboard.SetText("this works");
    }
}

但业务逻辑要求 Main 方法必须为 async 类型，方便内部调用其他异步方法。将 Main 改为异步后，所有访问剪贴板的操作都会抛出异常，测试代码如下：

using System.Windows.Forms;

class Program {
    
    [STAThread]
    public static async Task Main(string[] args) {
        string text = await GetTextAsync();

        // 此处抛出 System.Threading.ThreadStateException
        Clipboard.SetText(text);

        // 同样抛出异常
        await Task.Run(()=>Clipboard.SetText("this throws too"));

        // 以下代码无法编译
        // await Task.Run([STAThread]()=>Clipboard.SetText("this doesn't compile"));
    }

    // 该特性对异步方法无效
    [STAThread]
    public static async Task<string> GetTextAsync() {
        // 模拟耗时数据库查询操作
        await Task.Delay(1000);
        return "value fetched from database"; 
    }
}

需要实现异步方法内部正常写入剪贴板的功能。

补充说明 #

已尝试过网上给出的 STATask 相关参考方案，存在两个编译问题：

1. 无法识别 [NotNull] 特性，移除该特性后仍报错
2. 抛出编译错误：

   The type arguments for method STATask.Run(Func) cannot be inferred from the usage. Try specifying the type arguments explicitly.

出现这个问题的核心原因是：[STAThread] 特性只对方法初始执行的线程生效，异步方法在 await 之后会默认回到 MTA 模型的线程池线程，不满足剪贴板 COM 访问要求的 STA 线程模型；同时不能给 Lambda 表达式直接加 [STAThread] 特性，普通 Task.Run 也只会调度到 MTA 的线程池线程。

可以手动创建单独的 STA 线程，在该线程上启动任务循环专门处理剪贴板操作，完整可运行代码如下：

using System.Windows.Forms;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Concurrent;

class Program {
    // 用于调度STA操作的任务调度器实例
    private static readonly StaTaskScheduler _staScheduler = new StaTaskScheduler();

    [STAThread]
    public static async Task Main(string[] args) {
        string text = await GetTextAsync();

        // 将剪贴板操作调度到STA线程执行，不会抛出线程状态异常
        await Task.Factory.StartNew(() => {
            Clipboard.SetText(text);
        }, CancellationToken.None, TaskCreationOptions.None, _staScheduler);

        Console.WriteLine("文本已成功写入剪贴板");
        Console.ReadKey();
    }

    public static async Task<string> GetTextAsync() {
        await Task.Delay(1000);
        return "value fetched from database"; 
    }
}

// 自定义STA线程任务调度器，无第三方依赖，兼容.NET Framework 4.7
public class StaTaskScheduler : TaskScheduler
{
    [ThreadStatic]
    private static bool _isStaThread;
    private readonly BlockingCollection<Task> _taskQueue = new BlockingCollection<Task>();
    private readonly Thread _staWorkThread;

    public StaTaskScheduler()
    {
        _staWorkThread = new Thread(RunStaThreadLoop) {
            IsBackground = true,
            Name = "STA Work Thread"
        };
        _staWorkThread.SetApartmentState(ApartmentState.STA);
        _staWorkThread.Start();
    }

    private void RunStaThreadLoop()
    {
        _isStaThread = true;
        try
        {
            foreach (var task in _taskQueue.GetConsumingEnumerable())
            {
                TryExecuteTask(task);
            }
        }
        finally
        {
            _isStaThread = false;
        }
    }

    protected override void QueueTask(Task task) => _taskQueue.Add(task);

    protected override bool TryExecuteTaskInline(Task task, bool taskWasPreviouslyQueued)
    {
        return _isStaThread && TryExecuteTask(task);
    }

    protected override IEnumerable<Task> GetScheduledTasks() => _taskQueue.ToArray();
}

方案说明 #

• 不需要修改现有异步业务逻辑，只需要把所有剪贴板相关的操作，通过 Task.Factory.StartNew 调度到自定义的 STA 线程上执行即可
• 该 STA 线程是常驻后台线程，内部会阻塞等待任务队列，不需要每次操作剪贴板都新建线程
• 不存在之前参考方案里的特性识别、泛型推断失败的问题，在 .NET Framework 4.7 环境下可以直接编译运行
• 注意不要在该 STA 线程上执行耗时阻塞操作，避免阻塞后续剪贴板任务调度

内容的提问来源于stack exchange，提问作者Ahmad