process.WaitForExit() 异步

Question

我想等待进程完成，但process.WaitForExit() 挂起我的 GUI。是否有基于事件的方式，还是我需要生成一个线程阻塞直到退出，然后自己委托事件？

Answer 1

从 .NET 4.0/C# 5 开始，使用异步模式表示这一点会更好。

/// <summary>
/// Waits asynchronously for the process to exit.
/// </summary>
/// <param name="process">The process to wait for cancellation.</param>
/// <param name="cancellationToken">A cancellation token. If invoked, the task will return 
/// immediately as canceled.</param>
/// <returns>A Task representing waiting for the process to end.</returns>
public static Task WaitForExitAsync(this Process process, 
    CancellationToken cancellationToken = default(CancellationToken))
{
    if (process.HasExited) return Task.CompletedTask;

    var tcs = new TaskCompletionSource<object>();
    process.EnableRaisingEvents = true;
    process.Exited += (sender, args) => tcs.TrySetResult(null);
    if(cancellationToken != default(CancellationToken))
        cancellationToken.Register(() => tcs.SetCanceled());

    return process.HasExited ? Task.CompletedTask : tcs.Task;
}

用法：

public async void Test() 
{
   var process = new Process("processName");
   process.Start();
   await process.WaitForExitAsync();

   //Do some fun stuff here...
}

Answer 2

process.EnableRaisingEvents = true;
process.Exited += [EventHandler]

Answer 3

这是一个稍微干净的扩展方法，因为它清除了取消令牌注册和退出事件。它还处理竞争条件边缘情况，在这种情况下，进程可以在它开始之后但在附加 Exited 事件之前结束。它使用 C# 7 中新的局部函数语法。

public static class ProcessExtensions
{
    public static async Task WaitForExitAsync(this Process process, CancellationToken cancellationToken = default)
    {
        var tcs = new TaskCompletionSource<bool>(TaskCreationOptions.RunContinuationsAsynchronously);

        void Process_Exited(object sender, EventArgs e)
        {
             tcs.TrySetResult(true);
        }

        process.EnableRaisingEvents = true;
        process.Exited += Process_Exited;

        try
        {
            if (process.HasExited)
            {
                return;
            }

            using (cancellationToken.Register(() => tcs.TrySetCanceled()))
            {
                await tcs.Task.ConfigureAwait(false);
            }
        }
        finally
        {
            process.Exited -= Process_Exited;
        }
    }
}

编辑：

我已将TaskCreationOptions.RunContinuationsAsynchronously 添加到TaskCompletionSource 构造函数中，该构造函数应该修复TrySetResult() 尝试同步运行延续时可能发生的死锁。

这种死锁条件实际上很难追踪。原来TaskCompletionSource.SetResult()默认是同步运行continuation，这会导致await下的所有代码都在SetResult()里面运行。这通常不是问题，因为Process.Exited 在线程池线程上运行。但是，整个Process.Exited 回调在this 上的锁定中运行，在新线程池线程中，其中this 是Process 实例。这个可以看here。

process.Exited -= Process_Exited; 也会锁定 this，这是由于 C# 语言规范实现事件处理程序的方式。最终结果是两个单独的线程池线程最终阻塞了Process 实例上的锁。疯狂的！更疯狂的是，如果你没有同步上下文，紧接在await WaitForExitAsync() 下方的代码也可能会同步运行，因此你最终会在lock 内部Process.Exited 内运行大量代码打回来。如果您不知道这种行为，TaskCompletionSource 是非常危险的！

解决方案是将TaskCreationOptions.RunContinuationsAsynchronously 添加到TaskCompletionSource 构造函数中。这允许TaskCompletionSource.SetResult() 立即返回，一切都会“按预期”工作。

Answer 4

如果您选择@MgSam 答案，请注意，如果您通过WaitForExitAsync 一些CancellationToken，将在指定延迟后自动取消，您可以获得InvalidOperationException。要解决这个问题，你需要改变

cancellationToken.Register(tcs.SetCanceled);

到

cancellationToken.Register( () => { tcs.TrySetCanceled(); } );

P.S.：不要忘记及时处理你的CancellationTokenSource。

Answer 5

According to this linkWaitForExit() 方法用于使当前线程等待，直到关联进程终止。但是，Process 确实有一个您可以挂钩的 Exited 事件。

Answer 6

Ryan 解决方案在 Windows 上运行良好。在 OSX 上发生了奇怪的事情，它可能是 tcs.TrySetResult() 的死锁！有两种解决方案：

第一个：

将tcs.TrySetResult() 包装到Task.Run()：

    public static async Task WaitForExitAsync(this Process process, CancellationToken cancellationToken = default)
    {
        var tcs = new TaskCompletionSource<bool>();

        void Process_Exited(object sender, EventArgs e)
        {
            Task.Run(() => tcs.TrySetResult(true));
        }

        process.EnableRaisingEvents = true;
        process.Exited += Process_Exited;

        try
        {
            if (process.HasExited)
            {
                return;
            }

            using (cancellationToken.Register(() => Task.Run(() => tcs.TrySetCanceled())))
            {
                await tcs.Task;
            }
        }
        finally
        {
            process.Exited -= Process_Exited;
        }
    }

关于这个和更多细节的对话： Calling TaskCompletionSource.SetResult in a non blocking manner

第二个：

    public static async Task WaitForExitAsync(this Process process, CancellationToken cancellationToken)
    {
        while (!process.HasExited)
        {
            await Task.Delay(100, cancellationToken);
        }
    }

您可以将轮询间隔从 100 毫秒增加到更多，具体取决于您的应用程序。

Answer 7

截至.NET5，现在Process class 提供了一个WaitForExitAsync。

await process.WaitForExitAsync( token );

Answer 8

快速简单的解决方案：

async Task RunProcessWait(string Path)
{
    Process MyProcess = Process.Start(Path);
    while (!MyProcess.HasExited)
        await Task.Delay(100);
}

await RunProcessWait("C:\...")

Answer 9

使用System.Diagnostics.Process.Exited