如何使用C# 捕获进程输出
Intro
很多时候我们可能会需要执行一段命令获取一个输出,遇到的比较典型的就是之前我们需要用 FFMpeg 实现视频的编码压缩水印等一系列操作,当时使用的是 FFMpegCore 这个类库,这个类库的实现原理是启动另外一个进程,启动 ffmpeg 并传递相应的处理参数,并根据进程输出获取处理进度
为了方便使用,实现了两个帮助类来方便的获取进程的输出,分别是 ProcessExecutor 和 CommandRunner,前者更为灵活,可以通过事件添加自己的额外事件订阅处理,后者为简化版,主要是只获取输出的场景,两者的实现原理大体是一样的,启动一个 Process,并监听其输出事件获取输出
ProcessExecutor
使用示例,这个示例是获取保存 nuget 包的路径的一个示例:
using var executor = new ProcessExecutor("dotnet", "nuget locals global-packages -l"); var folder = string.Empty; executor.OnOutputDataReceived += (sender, str) => { if(str is null) return; Console.WriteLine(str); if(str.StartsWith("global-packages:")) { folder = str.Substring("global-packages:".Length).Trim(); } }; executor.Execute(); Console.WriteLine(folder);
ProcessExecutor
实现代码如下:
public class ProcessExecutor : IDisposable { public event EventHandler<int> OnExited; public event EventHandler<string> OnOutputDataReceived; public event EventHandler<string> OnErrorDataReceived; protected readonly Process _process; protected bool _started; public ProcessExecutor(string exePath) : this(new ProcessStartInfo(exePath)) { } public ProcessExecutor(string exePath, string arguments) : this(new ProcessStartInfo(exePath, arguments)) { } public ProcessExecutor(ProcessStartInfo startInfo) { _process = new Process() { StartInfo = startInfo, EnableRaisingEvents = true, }; _process.StartInfo.UseShellExecute = false; _process.StartInfo.CreateNoWindow = true; _process.StartInfo.RedirectStandardOutput = true; _process.StartInfo.RedirectStandardInput = true; _process.StartInfo.RedirectStandardError = true; } protected virtual void InitializeEvents() { _process.OutputDataReceived += (sender, args) => { if (args.Data != null) { OnOutputDataReceived?.Invoke(sender, args.Data); } }; _process.ErrorDataReceived += (sender, args) => { if (args.Data != null) { OnErrorDataReceived?.Invoke(sender, args.Data); } }; _process.Exited += (sender, args) => { if (sender is Process process) { OnExited?.Invoke(sender, process.ExitCode); } else { OnExited?.Invoke(sender, _process.ExitCode); } }; } protected virtual void Start() { if (_started) { return; } _started = true; _process.Start(); _process.BeginOutputReadLine(); _process.BeginErrorReadLine(); _process.WaitForExit(); } public async virtual Task SendInput(string input) { try { await _process.StandardInput.WriteAsync(input!); } catch (Exception e) { OnErrorDataReceived?.Invoke(_process, e.ToString()); } } public virtual int Execute() { InitializeEvents(); Start(); return _process.ExitCode; } public virtual async Task<int> ExecuteAsync() { InitializeEvents(); return await Task.Run(() => { Start(); return _process.ExitCode; }).ConfigureAwait(false); } public virtual void Dispose() { _process.Dispose(); OnExited = null; OnOutputDataReceived = null; OnErrorDataReceived = null; } }
CommandExecutor
上面的这种方式比较灵活但有些繁琐,于是有了下面这个版本
使用示例:
[Fact] public void HostNameTest() { if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) { return; } var result = CommandRunner.ExecuteAndCapture("hostname"); var hostName = Dns.GetHostName(); Assert.Equal(hostName, result.StandardOut.TrimEnd()); Assert.Equal(0, result.ExitCode); }
实现源码:
public static class CommandRunner { public static int Execute(string commandPath, string arguments = null, string workingDirectory = null) { using var process = new Process() { StartInfo = new ProcessStartInfo(commandPath, arguments ?? string.Empty) { UseShellExecute = false, CreateNoWindow = true, WorkingDirectory = workingDirectory ?? Environment.CurrentDirectory } }; process.Start(); process.WaitForExit(); return process.ExitCode; } public static CommandResult ExecuteAndCapture(string commandPath, string arguments = null, string workingDirectory = null) { using var process = new Process() { StartInfo = new ProcessStartInfo(commandPath, arguments ?? string.Empty) { UseShellExecute = false, CreateNoWindow = true, RedirectStandardOutput = true, RedirectStandardError = true, WorkingDirectory = workingDirectory ?? Environment.CurrentDirectory } }; process.Start(); var standardOut = process.StandardOutput.ReadToEnd(); var standardError = process.StandardError.ReadToEnd(); process.WaitForExit(); return new CommandResult(process.ExitCode, standardOut, standardError); } } public sealed class CommandResult { public CommandResult(int exitCode, string standardOut, string standardError) { ExitCode = exitCode; StandardOut = standardOut; StandardError = standardError; } public string StandardOut { get; } public string StandardError { get; } public int ExitCode { get; } }
More
如果只要执行命令获取是否执行成功则使用 CommandRunner.Execute 即可,只获取输出和是否成功可以用 CommandRunner.ExecuteAndCapture 方法,如果想要进一步的添加事件订阅则使用 ProcessExecutor
Reference
https://github.com/rosenbjerg/FFMpegCore
https://github.com/WeihanLi/WeihanLi.Common/blob/dev/src/WeihanLi.Common/Helpers/ProcessExecutor.cs
https://github.com/WeihanLi/WeihanLi.Common/blob/dev/test/WeihanLi.Common.Test/HelpersTest/ProcessExecutorTest.cs
https://github.com/WeihanLi/WeihanLi.Common/blob/dev/test/WeihanLi.Common.Test/HelpersTest/CommandRunnerTest.cs
以上就是如何使用C# 捕获进程输出的详细内容,更多关于C# 捕获进程输出的资料请关注猪先飞其它相关文章!
相关文章
- 我们在使用C#做项目的时候,基本上都需要制作登录界面,那么今天我们就来一步步看看,如果简单的实现登录界面呢,本文给出2个例子,由简入难,希望大家能够喜欢。...2020-06-25
- 这篇文章主要介绍了C# 字段和属性的的相关资料,文中示例代码非常详细,供大家参考和学习,感兴趣的朋友可以了解下...2020-11-03
- 这篇文章主要介绍了C#中截取字符串的的基本方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2020-11-03
- 本文给大家分享C#连接SQL数据库和查询数据功能的操作技巧,本文通过图文并茂的形式给大家介绍的非常详细,需要的朋友参考下吧...2021-05-17
- 这篇文章主要介绍了C#实现简单的Http请求的方法,以实例形式较为详细的分析了C#实现Http请求的具体方法,需要的朋友可以参考下...2020-06-25
- 本文主要介绍了C#中new的几种用法,具有很好的参考价值,下面跟着小编一起来看下吧...2020-06-25
使用Visual Studio2019创建C#项目(窗体应用程序、控制台应用程序、Web应用程序)
这篇文章主要介绍了使用Visual Studio2019创建C#项目(窗体应用程序、控制台应用程序、Web应用程序),小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧...2020-06-25- 这篇文章主要介绍了C#开发Windows窗体应用程序的简单操作步骤,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2021-04-12
- 这篇文章主要介绍了C#从数据库读取图片并保存的方法,帮助大家更好的理解和使用c#,感兴趣的朋友可以了解下...2021-01-16
- 最近做一个小项目不可避免的需要前端脚本与后台进行交互。由于是在asp.net中实现,故问题演化成asp.net中jiavascript与后台c#如何进行交互。...2020-06-25
- 这篇文章主要用实例讲解C#递归算法的概念以及用法,文中代码非常详细,帮助大家更好的参考和学习,感兴趣的朋友可以了解下...2020-06-25
- 本文通过例子,讲述了C++调用C#的DLL程序的方法,作出了以下总结,下面就让我们一起来学习吧。...2020-06-25
- 轻松学习C#的基础入门,了解C#最基本的知识点,C#是一种简洁的,类型安全的一种完全面向对象的开发语言,是Microsoft专门基于.NET Framework平台开发的而量身定做的高级程序设计语言,需要的朋友可以参考下...2020-06-25
- 本文主要介绍了C#变量命名规则小结,文中介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2021-09-09
- 这篇文章主要介绍了c#中(&&,||)与(&,|)的区别详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2020-06-25
- 本文主要介绍了C# 中取绝对值的函数。具有很好的参考价值。下面跟着小编一起来看下吧...2020-06-25
- 这篇文章主要介绍了C#绘制曲线图的方法,以完整实例形式较为详细的分析了C#进行曲线绘制的具体步骤与相关技巧,具有一定参考借鉴价值,需要的朋友可以参考下...2020-06-25
- 这篇文章主要介绍了c#自带缓存使用方法,包括获取数据缓存、设置数据缓存、移除指定数据缓存等方法,需要的朋友可以参考下...2020-06-25
- 下面小编就为大家带来一篇C#学习笔记- 随机函数Random()的用法详解。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧...2020-06-25
- 这篇文章主要介绍了C#中list用法,结合实例形式分析了C#中list排序、运算、转换等常见操作技巧,具有一定参考借鉴价值,需要的朋友可以参考下...2020-06-25