我們可以在命令行中操作 git,但是作為一名程序員,如果在大量重復的時候還手動敲命令行,那就太笨了。
本文介紹使用 C# 編寫一個 .NET 程序來自動化地使用 git 命令行來操作 git 倉庫。
這是一篇很基礎的入門文章。
在 .NET 中,運行一個命令只需要使用 Process.Start
開啟一個子進程就好了。于是要運行一個 git
命令,我們其實只需要這句足以:
Process.Start("git", "status");
當然,直接能簡寫成 git
是因為 git.exe
在我的環境變量里面,一般開發者在安裝 Git 客戶端的時候,都會自動將此命令加入到環境變量。如果沒有,你需要使用完整路徑 C:\Program Files\Git\mingw64\bin\git.exe
只是每個人的路徑可能不同,所以這是不靠譜的。
對于上節中寫的 Process.Start
,你一眼就能看出來這是完全沒有用的代碼。因為 git status
命令只是獲得倉庫當前的狀態,這個命令完全不影響倉庫,只是為了看狀態的。
所以,命令最好要能夠獲得輸出。
而要獲得輸出,你需要使用 ProcessStartInfo
來指定如何啟動一個進程。
var info = new ProcessStartInfo(ExecutablePath, arguments) { CreateNoWindow = true, RedirectStandardOutput = true, UseShellExecute = false, WorkingDirectory = WorkingDirectory, };
需要設置至少這四個屬性:
CreateNoWindow
表示不要為這個命令單獨創建一個控制臺窗口實際上如果使用此代碼的程序也是一個控制臺程序,這句是沒有必要的,因為子進程會共用父進程的控制臺窗口;但是對于 GUI 程序來說,這句還是很重要的,這可以避免在執行命令的過程中意外彈出一個黑色的控制臺窗口出來。
RedirectStandardOutput
進行輸出的重定向這是一定要設置為 true
的屬性,因為我們希望拿到命令的輸出結果。
WorkingDirectory
設置工作路徑本來這是一個可選設置,不過對于 git
命令來說,一般都是對一個已有的 git 倉庫進行操作,所以當然要指定一個合理的 git 倉庫了。
UseShellExecute
設置為 false
表示不要使用 ShellExecute
函數創建進程此屬性的詳細說明,
UseShellExecute 的默認值是 true
。
如果有以下需求,那么建議設置此值為 false
:
如果你有以下需求,那么建議設置此值為 true 或者保持默認:
這里我們必須指定為 false
,因為要重定向輸出的話,這是唯一有效值。順便一提,此屬性如果不設置,默認值是 true
。
為了方便起見,我將全部運行一個命令的代碼封裝到了一個 CommandRunner
的類當中。
using System; using System.Diagnostics; using System.IO; namespace Walterlv.GitDemo { public class CommandRunner { public string ExecutablePath { get; } public string WorkingDirectory { get; } public CommandRunner(string executablePath, string workingDirectory = null) { ExecutablePath = executablePath ?? throw new ArgumentNullException(nameof(executablePath)); WorkingDirectory = workingDirectory ?? Path.GetDirectoryName(executablePath); } public string Run(string arguments) { var info = new ProcessStartInfo(ExecutablePath, arguments) { CreateNoWindow = true, RedirectStandardOutput = true, UseShellExecute = false, WorkingDirectory = WorkingDirectory, }; var process = new Process { StartInfo = info, }; process.Start(); return process.StandardOutput.ReadToEnd(); } } }
以上 CommandRunner
命令的使用非常簡單, new
出來之后,得到一個可以用來執行命令的實例,然后每次執行調用 Run
方法傳入參數即可。
var git = new CommandRunner("git", @"D:\Developments\Blogs\walterlv.github.io"); git.Run("add ."); git.Run(@"commit -m ""這是自動提交的""");
如果需要獲得命令的執行結果,直接使用 Run
方法的返回值即可。
比如下面我貼了 Main
函數的完整代碼,可以輸出我倉庫的當前狀態:
using System; namespace Walterlv.GitDemo { class Program { static void Main(string[] args) { Console.WriteLine("walterlv 的自動 git 命令"); var git = new CommandRunner("git", @"D:\Developments\Blogs\walterlv.github.io"); var status = git.Run("status"); Console.WriteLine(status); Console.WriteLine("按 Enter 退出程序……"); Console.ReadLine(); } } }
聲明:本網頁內容旨在傳播知識,若有侵權等問題請及時與本網聯系,我們將在第一時間刪除處理。TEL:177 7030 7066 E-MAIL:11247931@qq.com