Czy istnieje asynchroniczny odpowiednik Process.Start?


141

Jak sugeruje tytuł, czy istnieje odpowiednik Process.Start(pozwalający na uruchomienie innej aplikacji lub pliku wsadowego), na który mogę czekać?

Gram z małą aplikacją konsolową i wydawało mi się, że to idealne miejsce do używania async i czekania, ale nie mogę znaleźć żadnej dokumentacji dla tego scenariusza.

Myślę o czymś podobnym:

void async RunCommand()
{
    var result = await Process.RunAsync("command to run");
}

2
Dlaczego po prostu nie użyjesz WaitForExit na zwróconym obiekcie Process?
SimpleVar

2
A tak przy okazji, brzmi bardziej, jakbyś szukał rozwiązania „zsynchronizowanego”, a nie rozwiązania „asynchronicznego”, więc tytuł wprowadza w błąd.
SimpleVar

2
@YoryeNathan - lol. Rzeczywiście, Process.Start jest asynchroniczny i wydaje się, że OP chce wersji synchronicznej.
Oded

10
OP mówi o nowych słowach kluczowych async /
await

4
Ok, zaktualizowałem swój post, aby był bardziej przejrzysty. Wyjaśnienie, dlaczego tego chcę, jest proste. Wyobraź sobie scenariusz, w którym musisz uruchomić zewnętrzne polecenie (coś w rodzaju 7zip), a następnie kontynuować przepływ aplikacji. Właśnie to miało ułatwić async / await, a jednak wydaje się, że nie ma sposobu, aby uruchomić proces i czekać na jego zakończenie.
linkerro

Odpowiedzi:


196

Process.Start()tylko rozpoczyna proces, nie czeka, aż się zakończy, więc nie ma sensu go robić async. Jeśli nadal chcesz to zrobić, możesz zrobić coś takiego await Task.Run(() => Process.Start(fileName)).

Ale, jeśli chcesz asynchronicznie czekać na proces do końca, można użyć do Exitedzdarzenia razem z TaskCompletionSource:

static Task<int> RunProcessAsync(string fileName)
{
    var tcs = new TaskCompletionSource<int>();

    var process = new Process
    {
        StartInfo = { FileName = fileName },
        EnableRaisingEvents = true
    };

    process.Exited += (sender, args) =>
    {
        tcs.SetResult(process.ExitCode);
        process.Dispose();
    };

    process.Start();

    return tcs.Task;
}

36
W końcu udało mi się włożyć coś do tego na githubie - nie ma on żadnej obsługi anulowania / limitu czasu, ale przynajmniej zbierze standardowe wyjście i standardowy błąd. github.com/jamesmanning/RunProcessAsTask
James Manning,

3
Ta funkcja jest również dostępna w pakiecie MedallionShell NuGet
ChaseMedallion

8
Naprawdę ważne: kolejność, w której ustawiasz różne właściwości processi process.StartInfozmienia to, co się dzieje, gdy je uruchamiasz .Start(). Jeśli na przykład wywołasz .EnableRaisingEvents = trueprzed ustawieniem StartInfowłaściwości, jak widać tutaj, wszystko działa zgodnie z oczekiwaniami. Jeśli ustawisz go później, na przykład, aby zachować go razem z .Exited, mimo że wywołasz go wcześniej .Start(), nie działa poprawnie - .Exiteduruchamia się natychmiast, zamiast czekać na zakończenie procesu. Nie wiem dlaczego, tylko słowo przestrogi.
Chris Moschini,

2
@svick W formularzu okna process.SynchronizingObjectnależy ustawić na komponent formularzy, aby uniknąć wywoływania metod obsługujących zdarzenia (takie jak Exited, OutputDataReceived, ErrorDataReceived) w oddzielnym wątku.
KevinBui,

4
To ma rzeczywiście sens zawinąć Process.Startw Task.Run. Na przykład ścieżka UNC zostanie rozwiązana synchronicznie. Process.Start(@"\\live.sysinternals.com\whatever")
Ukończenie

55

Oto moje podejście, oparte na odpowiedzi Svicka . Dodaje przekierowanie wyjścia, zachowanie kodu zakończenia i nieco lepszą obsługę błędów (usuwanie Processobiektu, nawet jeśli nie można go uruchomić):

public static async Task<int> RunProcessAsync(string fileName, string args)
{
    using (var process = new Process
    {
        StartInfo =
        {
            FileName = fileName, Arguments = args,
            UseShellExecute = false, CreateNoWindow = true,
            RedirectStandardOutput = true, RedirectStandardError = true
        },
        EnableRaisingEvents = true
    })
    {
        return await RunProcessAsync(process).ConfigureAwait(false);
    }
}    
private static Task<int> RunProcessAsync(Process process)
{
    var tcs = new TaskCompletionSource<int>();

    process.Exited += (s, ea) => tcs.SetResult(process.ExitCode);
    process.OutputDataReceived += (s, ea) => Console.WriteLine(ea.Data);
    process.ErrorDataReceived += (s, ea) => Console.WriteLine("ERR: " + ea.Data);

    bool started = process.Start();
    if (!started)
    {
        //you may allow for the process to be re-used (started = false) 
        //but I'm not sure about the guarantees of the Exited event in such a case
        throw new InvalidOperationException("Could not start process: " + process);
    }

    process.BeginOutputReadLine();
    process.BeginErrorReadLine();

    return tcs.Task;
}

1
właśnie znalazłem to interesujące rozwiązanie. Ponieważ jestem nowy w C #, nie jestem pewien, jak używać async Task<int> RunProcessAsync(string fileName, string args). Dostosowałem ten przykład i przekazałem trzy obiekty jeden po drugim. Jak mogę czekać na zwiększające się wydarzenia? na przykład. zanim moje zgłoszenie zostanie zatrzymane ... wielkie dzięki
marrrschine

3
@marrrschine Nie rozumiem dokładnie, co masz na myśli, być może powinieneś zacząć nowe pytanie od jakiegoś kodu, abyśmy mogli zobaczyć, co próbowałeś i kontynuować od tego miejsca.
Ohad Schneider,

4
Fantastyczna odpowiedź. Dziękuję Svick za przygotowanie podwalin i dziękuję Ohad za to bardzo przydatne rozszerzenie.
Gordon Bean

1
@SuperJMN odczytuje kod ( referenceource.microsoft.com/#System/services/monitoring/ ) Nie wierzę, że zeruje moduł Disposeobsługi zdarzeń, więc teoretycznie, jeśli zadzwoniłeś, Disposeale zachowałeś referencję, uważam, że byłby to wyciek. Jednak gdy nie ma już odwołań do Processobiektu i zostaje on zebrany (śmieci), nie ma nikogo, kto wskazuje na listę programów obsługi zdarzeń. Jest więc zbierany, a teraz nie ma żadnych odwołań do delegatów, którzy kiedyś znajdowali się na liście, więc w końcu zostają wyrzuceni.
Ohad Schneider,

1
@SuperJMN: Co ciekawe, jest to bardziej skomplikowane / potężne niż to. Po pierwsze, Disposeczyści niektóre zasoby, ale nie zapobiega zatrzymywaniu się wycieku odniesienia process. W rzeczywistości zauważysz, że processodnosi się to do programów obsługi, ale program Exitedobsługi ma również odniesienie do process. W niektórych systemach to cykliczne odwołanie zapobiegałoby usuwaniu elementów bezużytecznych, ale algorytm używany w .NET nadal pozwalałby to wszystko wyczyścić, o ile wszystko znajduje się na „wyspie” bez zewnętrznych odniesień.
TheRubberDuck

4

Oto inne podejście. Podobna koncepcja do odpowiedzi Svicka i Ohada , ale z zastosowaniem metody rozszerzenia na Processtypie.

Metoda przedłużenia:

public static Task RunAsync(this Process process)
{
    var tcs = new TaskCompletionSource<object>();
    process.EnableRaisingEvents = true;
    process.Exited += (s, e) => tcs.TrySetResult(null);
    // not sure on best way to handle false being returned
    if (!process.Start()) tcs.SetException(new Exception("Failed to start process."));
    return tcs.Task;
}

Przykład zastosowania w metodzie zawierającej:

public async Task ExecuteAsync(string executablePath)
{
    using (var process = new Process())
    {
        // configure process
        process.StartInfo.FileName = executablePath;
        process.StartInfo.UseShellExecute = false;
        process.StartInfo.CreateNoWindow = true;
        // run process asynchronously
        await process.RunAsync();
        // do stuff with results
        Console.WriteLine($"Process finished running at {process.ExitTime} with exit code {process.ExitCode}");
    };// dispose process
}

4

Zbudowałem klasę, aby rozpocząć proces i przez ostatnie lata rosła ona z powodu różnych wymagań. Podczas użytkowania odkryłem kilka problemów z klasą Process podczas usuwania, a nawet czytania ExitCode. Więc to wszystko jest ustalane przez moją klasę.

Klasa ma kilka możliwości, na przykład odczytywanie wyjścia, uruchamianie jako administrator lub inny użytkownik, przechwytywanie wyjątków, a także uruchamianie wszystkich asynchronicznych, w tym. Anulowanie. Fajne jest to, że wyjście odczytu jest również możliwe podczas wykonywania.

public class ProcessSettings
{
    public string FileName { get; set; }
    public string Arguments { get; set; } = "";
    public string WorkingDirectory { get; set; } = "";
    public string InputText { get; set; } = null;
    public int Timeout_milliseconds { get; set; } = -1;
    public bool ReadOutput { get; set; }
    public bool ShowWindow { get; set; }
    public bool KeepWindowOpen { get; set; }
    public bool StartAsAdministrator { get; set; }
    public string StartAsUsername { get; set; }
    public string StartAsUsername_Password { get; set; }
    public string StartAsUsername_Domain { get; set; }
    public bool DontReadExitCode { get; set; }
    public bool ThrowExceptions { get; set; }
    public CancellationToken CancellationToken { get; set; }
}

public class ProcessOutputReader   // Optional, to get the output while executing instead only as result at the end
{
    public event TextEventHandler OutputChanged;
    public event TextEventHandler OutputErrorChanged;
    public void UpdateOutput(string text)
    {
        OutputChanged?.Invoke(this, new TextEventArgs(text));
    }
    public void UpdateOutputError(string text)
    {
        OutputErrorChanged?.Invoke(this, new TextEventArgs(text));
    }
    public delegate void TextEventHandler(object sender, TextEventArgs e);
    public class TextEventArgs : EventArgs
    {
        public string Text { get; }
        public TextEventArgs(string text) { Text = text; }
    }
}

public class ProcessResult
{
    public string Output { get; set; }
    public string OutputError { get; set; }
    public int ExitCode { get; set; }
    public bool WasCancelled { get; set; }
    public bool WasSuccessful { get; set; }
}

public class ProcessStarter
{
    public ProcessResult Execute(ProcessSettings settings, ProcessOutputReader outputReader = null)
    {
        return Task.Run(() => ExecuteAsync(settings, outputReader)).GetAwaiter().GetResult();
    }

    public async Task<ProcessResult> ExecuteAsync(ProcessSettings settings, ProcessOutputReader outputReader = null)
    {
        if (settings.FileName == null) throw new ArgumentNullException(nameof(ProcessSettings.FileName));
        if (settings.Arguments == null) throw new ArgumentNullException(nameof(ProcessSettings.Arguments));

        var cmdSwitches = "/Q " + (settings.KeepWindowOpen ? "/K" : "/C");

        var arguments = $"{cmdSwitches} {settings.FileName} {settings.Arguments}";
        var startInfo = new ProcessStartInfo("cmd", arguments)
        {
            UseShellExecute = false,
            RedirectStandardOutput = settings.ReadOutput,
            RedirectStandardError = settings.ReadOutput,
            RedirectStandardInput = settings.InputText != null,
            CreateNoWindow = !(settings.ShowWindow || settings.KeepWindowOpen),
        };
        if (!string.IsNullOrWhiteSpace(settings.StartAsUsername))
        {
            if (string.IsNullOrWhiteSpace(settings.StartAsUsername_Password))
                throw new ArgumentNullException(nameof(ProcessSettings.StartAsUsername_Password));
            if (string.IsNullOrWhiteSpace(settings.StartAsUsername_Domain))
                throw new ArgumentNullException(nameof(ProcessSettings.StartAsUsername_Domain));
            if (string.IsNullOrWhiteSpace(settings.WorkingDirectory))
                settings.WorkingDirectory = Path.GetPathRoot(Path.GetTempPath());

            startInfo.UserName = settings.StartAsUsername;
            startInfo.PasswordInClearText = settings.StartAsUsername_Password;
            startInfo.Domain = settings.StartAsUsername_Domain;
        }
        var output = new StringBuilder();
        var error = new StringBuilder();
        if (!settings.ReadOutput)
        {
            output.AppendLine($"Enable {nameof(ProcessSettings.ReadOutput)} to get Output");
        }
        if (settings.StartAsAdministrator)
        {
            startInfo.Verb = "runas";
            startInfo.UseShellExecute = true;  // Verb="runas" only possible with ShellExecute=true.
            startInfo.RedirectStandardOutput = startInfo.RedirectStandardError = startInfo.RedirectStandardInput = false;
            output.AppendLine("Output couldn't be read when started as Administrator");
        }
        if (!string.IsNullOrWhiteSpace(settings.WorkingDirectory))
        {
            startInfo.WorkingDirectory = settings.WorkingDirectory;
        }
        var result = new ProcessResult();
        var taskCompletionSourceProcess = new TaskCompletionSource<bool>();

        var process = new Process { StartInfo = startInfo, EnableRaisingEvents = true };
        try
        {
            process.OutputDataReceived += (sender, e) =>
            {
                if (e?.Data != null)
                {
                    output.AppendLine(e.Data);
                    outputReader?.UpdateOutput(e.Data);
                }
            };
            process.ErrorDataReceived += (sender, e) =>
            {
                if (e?.Data != null)
                {
                    error.AppendLine(e.Data);
                    outputReader?.UpdateOutputError(e.Data);
                }
            };
            process.Exited += (sender, e) =>
            {
                try { (sender as Process)?.WaitForExit(); } catch (InvalidOperationException) { }
                taskCompletionSourceProcess.TrySetResult(false);
            };

            var success = false;
            try
            {
                process.Start();
                success = true;
            }
            catch (System.ComponentModel.Win32Exception ex)
            {
                if (ex.NativeErrorCode == 1223)
                {
                    error.AppendLine("AdminRights request Cancelled by User!! " + ex);
                    if (settings.ThrowExceptions) taskCompletionSourceProcess.SetException(ex); else taskCompletionSourceProcess.TrySetResult(false);
                }
                else
                {
                    error.AppendLine("Win32Exception thrown: " + ex);
                    if (settings.ThrowExceptions) taskCompletionSourceProcess.SetException(ex); else taskCompletionSourceProcess.TrySetResult(false);
                }
            }
            catch (Exception ex)
            {
                error.AppendLine("Exception thrown: " + ex);
                if (settings.ThrowExceptions) taskCompletionSourceProcess.SetException(ex); else taskCompletionSourceProcess.TrySetResult(false);
            }
            if (success && startInfo.RedirectStandardOutput)
                process.BeginOutputReadLine();
            if (success && startInfo.RedirectStandardError)
                process.BeginErrorReadLine();
            if (success && startInfo.RedirectStandardInput)
            {
                var writeInputTask = Task.Factory.StartNew(() => WriteInputTask());
            }

            async void WriteInputTask()
            {
                var processRunning = true;
                await Task.Delay(50).ConfigureAwait(false);
                try { processRunning = !process.HasExited; } catch { }
                while (processRunning)
                {
                    if (settings.InputText != null)
                    {
                        try
                        {
                            await process.StandardInput.WriteLineAsync(settings.InputText).ConfigureAwait(false);
                            await process.StandardInput.FlushAsync().ConfigureAwait(false);
                            settings.InputText = null;
                        }
                        catch { }
                    }
                    await Task.Delay(5).ConfigureAwait(false);
                    try { processRunning = !process.HasExited; } catch { processRunning = false; }
                }
            }

            if (success && settings.CancellationToken != default(CancellationToken))
                settings.CancellationToken.Register(() => taskCompletionSourceProcess.TrySetResult(true));
            if (success && settings.Timeout_milliseconds > 0)
                new CancellationTokenSource(settings.Timeout_milliseconds).Token.Register(() => taskCompletionSourceProcess.TrySetResult(true));

            var taskProcess = taskCompletionSourceProcess.Task;
            await taskProcess.ConfigureAwait(false);
            if (taskProcess.Result == true) // process was cancelled by token or timeout
            {
                if (!process.HasExited)
                {
                    result.WasCancelled = true;
                    error.AppendLine("Process was cancelled!");
                    try
                    {
                        process.CloseMainWindow();
                        await Task.Delay(30).ConfigureAwait(false);
                        if (!process.HasExited)
                        {
                            process.Kill();
                        }
                    }
                    catch { }
                }
            }
            result.ExitCode = -1;
            if (!settings.DontReadExitCode)     // Reason: sometimes, like when timeout /t 30 is started, reading the ExitCode is only possible if the timeout expired, even if process.Kill was called before.
            {
                try { result.ExitCode = process.ExitCode; }
                catch { output.AppendLine("Reading ExitCode failed."); }
            }
            process.Close();
        }
        finally { var disposeTask = Task.Factory.StartNew(() => process.Dispose()); }    // start in new Task because disposing sometimes waits until the process is finished, for example while executing following command: ping -n 30 -w 1000 127.0.0.1 > nul
        if (result.ExitCode == -1073741510 && !result.WasCancelled)
        {
            error.AppendLine($"Process exited by user!");
        }
        result.WasSuccessful = !result.WasCancelled && result.ExitCode == 0;
        result.Output = output.ToString();
        result.OutputError = error.ToString();
        return result;
    }
}

1

Myślę, że wszystko, czego powinieneś użyć, to:

using System.Diagnostics;
using System.Threading;
using System.Threading.Tasks;

namespace Extensions
{
    public static class ProcessExtensions
    {
        public static async Task<int> WaitForExitAsync(this Process process, CancellationToken cancellationToken = default)
        {
            process = process ?? throw new ArgumentNullException(nameof(process));
            process.EnableRaisingEvents = true;

            var completionSource = new TaskCompletionSource<int>();

            process.Exited += (sender, args) =>
            {
                completionSource.TrySetResult(process.ExitCode);
            };
            if (process.HasExited)
            {
                return process.ExitCode;
            }

            using var registration = cancellationToken.Register(
                () => completionSource.TrySetCanceled(cancellationToken));

            return await completionSource.Task.ConfigureAwait(false);
        }
    }
}

Przykład użycia:

public static async Task<int> StartProcessAsync(ProcessStartInfo info, CancellationToken cancellationToken = default)
{
    path = path ?? throw new ArgumentNullException(nameof(path));
    if (!File.Exists(path))
    {
        throw new ArgumentException(@"File is not exists", nameof(path));
    }

    using var process = Process.Start(info);
    if (process == null)
    {
        throw new InvalidOperationException("Process is null");
    }

    try
    {
        return await process.WaitForExitAsync(cancellationToken).ConfigureAwait(false);
    }
    catch (OperationCanceledException)
    {
        process.Kill();

        throw;
    }
}

Jaki jest sens akceptowania a CancellationToken, jeśli anulowanie go nie Killoznacza?
Theodor Zoulias

CancellationTokenw WaitForExitAsyncmetodzie jest potrzebna po prostu do anulowania oczekiwania lub ustawienia limitu czasu. Zabicie procesu można wykonać w StartProcessAsync: `` try {await process.WaitForExitAsync (cancellationToken); } catch (OperationCanceledException) {process.Kill (); } ``
Konstantin S.

Uważam, że gdy metoda akceptuje a CancellationToken, anulowanie tokena powinno skutkować anulowaniem operacji, a nie anulowaniem oczekującego. Tego normalnie oczekiwałby wywołujący metodę. Jeśli dzwoniący chce anulować tylko oczekiwanie i pozwolić, aby operacja nadal działała w tle, jest to dość łatwe do wykonania na zewnątrz ( tutaj jest metoda rozszerzenia, AsCancelablektóra właśnie to robi).
Theodor Zoulias

Myślę, że ta decyzja powinna zostać podjęta przez dzwoniącego (szczególnie w tym przypadku, ponieważ ta metoda zaczyna się od Wait, generalnie zgadzam się z tobą), tak jak w nowym przykładzie użycia.
Konstantin S.

0

Naprawdę martwię się o pozbycie się procesu, a co z oczekiwaniem na asynchroniczne wyjście? Oto moja propozycja (na podstawie poprzedniej):

public static class ProcessExtensions
{
    public static Task WaitForExitAsync(this Process process)
    {
        var tcs = new TaskCompletionSource<object>();
        process.EnableRaisingEvents = true;
        process.Exited += (s, e) => tcs.TrySetResult(null);
        return process.HasExited ? Task.CompletedTask : tcs.Task;
    }        
}

Następnie użyj tego w ten sposób:

public static async Task<int> ExecAsync(string command, string args)
{
    ProcessStartInfo psi = new ProcessStartInfo();
    psi.FileName = command;
    psi.Arguments = args;

    using (Process proc = Process.Start(psi))
    {
        await proc.WaitForExitAsync();
        return proc.ExitCode;
    }
}
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.