我們可以在命令行中操作 git,但是作為一名程序員,如果在大量重復(fù)的時(shí)候還手動(dòng)敲命令行,那就太笨了。
本文介紹使用 C# 編寫一個(gè) .NET 程序來(lái)自動(dòng)化地使用 git 命令行來(lái)操作 git 倉(cāng)庫(kù)。
這是一篇很基礎(chǔ)的入門文章。
在 .NET 中,運(yùn)行一個(gè)命令只需要使用 Process.Start
開啟一個(gè)子進(jìn)程就好了。于是要運(yùn)行一個(gè) git
命令,我們其實(shí)只需要這句足以:
Process.Start("git", "status");
當(dāng)然,直接能簡(jiǎn)寫成 git
是因?yàn)?git.exe
在我的環(huán)境變量里面,一般開發(fā)者在安裝 Git 客戶端的時(shí)候,都會(huì)自動(dòng)將此命令加入到環(huán)境變量。如果沒(méi)有,你需要使用完整路徑 C:\Program Files\Git\mingw64\bin\git.exe
只是每個(gè)人的路徑可能不同,所以這是不靠譜的。
對(duì)于上節(jié)中寫的 Process.Start
,你一眼就能看出來(lái)這是完全沒(méi)有用的代碼。因?yàn)?git status
命令只是獲得倉(cāng)庫(kù)當(dāng)前的狀態(tài),這個(gè)命令完全不影響倉(cāng)庫(kù),只是為了看狀態(tài)的。
所以,命令最好要能夠獲得輸出。
而要獲得輸出,你需要使用 ProcessStartInfo
來(lái)指定如何啟動(dòng)一個(gè)進(jìn)程。
var info = new ProcessStartInfo(ExecutablePath, arguments) { CreateNoWindow = true, RedirectStandardOutput = true, UseShellExecute = false, WorkingDirectory = WorkingDirectory, };
需要設(shè)置至少這四個(gè)屬性:
CreateNoWindow
表示不要為這個(gè)命令單獨(dú)創(chuàng)建一個(gè)控制臺(tái)窗口實(shí)際上如果使用此代碼的程序也是一個(gè)控制臺(tái)程序,這句是沒(méi)有必要的,因?yàn)樽舆M(jìn)程會(huì)共用父進(jìn)程的控制臺(tái)窗口;但是對(duì)于 GUI 程序來(lái)說(shuō),這句還是很重要的,這可以避免在執(zhí)行命令的過(guò)程中意外彈出一個(gè)黑色的控制臺(tái)窗口出來(lái)。
RedirectStandardOutput
進(jìn)行輸出的重定向這是一定要設(shè)置為 true
的屬性,因?yàn)槲覀兿M玫矫畹?/pre>輸出結(jié)果。
WorkingDirectory
設(shè)置工作路徑本來(lái)這是一個(gè)可選設(shè)置,不過(guò)對(duì)于 git
命令來(lái)說(shuō),一般都是對(duì)一個(gè)已有的 git 倉(cāng)庫(kù)進(jìn)行操作,所以當(dāng)然要指定一個(gè)合理的 git 倉(cāng)庫(kù)了。
UseShellExecute
設(shè)置為 false
表示不要使用 ShellExecute
函數(shù)創(chuàng)建進(jìn)程此屬性的詳細(xì)說(shuō)明,
UseShellExecute 的默認(rèn)值是 true
。
如果有以下需求,那么建議設(shè)置此值為 false
:
如果你有以下需求,那么建議設(shè)置此值為 true 或者保持默認(rèn):
這里我們必須指定為 false
,因?yàn)橐囟ㄏ?/pre>輸出的話,這是唯一有效值。順便一提,此屬性如果不設(shè)置,默認(rèn)值是 true
。
為了方便起見,我將全部運(yùn)行一個(gè)命令的代碼封裝到了一個(gè) CommandRunner
的類當(dāng)中。
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
命令的使用非常簡(jiǎn)單, new
出來(lái)之后,得到一個(gè)可以用來(lái)執(zhí)行命令的實(shí)例,然后每次執(zhí)行調(diào)用 Run
方法傳入?yún)?shù)即可。
var git = new CommandRunner("git", @"D:\Developments\Blogs\walterlv.github.io"); git.Run("add ."); git.Run(@"commit -m ""這是自動(dòng)提交的""");
如果需要獲得命令的執(zhí)行結(jié)果,直接使用 Run
方法的返回值即可。
比如下面我貼了 Main
函數(shù)的完整代碼,可以輸出我倉(cāng)庫(kù)的當(dāng)前狀態(tài):
using System; namespace Walterlv.GitDemo { class Program { static void Main(string[] args) { Console.WriteLine("walterlv 的自動(dòng) 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(); } } }
聲明:本網(wǎng)頁(yè)內(nèi)容旨在傳播知識(shí),若有侵權(quán)等問(wèn)題請(qǐng)及時(shí)與本網(wǎng)聯(lián)系,我們將在第一時(shí)間刪除處理。TEL:177 7030 7066 E-MAIL:11247931@qq.com