C#通過(guò)System.CommandLine快速生成支持命令行的應(yīng)用程序

第C#通過(guò)System.CommandLine快速生成支持命令行的應(yīng)用程序一直以來(lái)，當(dāng)我們想讓我們的控制臺(tái)程序支持命令行啟動(dòng)時(shí)，往往需要編寫大量代碼來(lái)實(shí)現(xiàn)這一看起來(lái)很簡(jiǎn)單的功能。雖然有一些庫(kù)可以簡(jiǎn)化一些操作，但整個(gè)過(guò)程仍然是一個(gè)相當(dāng)枯燥而乏味的過(guò)程。

今天，我這里要介紹一個(gè)新的命令行庫(kù)：System.CommandLine，通過(guò)他我們可以幾乎無(wú)需任何額外的編碼就可以獲得命令行的支持，它能大幅減少程序員花在提供命令行API（CLI）上的時(shí)間，改善CLI程序用戶的體驗(yàn)，讓開(kāi)發(fā)者能專注于編寫應(yīng)用程序。

目前這個(gè)庫(kù)還是預(yù)覽版本，要體驗(yàn)的話需要可以使用如下庫(kù)：System.CommandLine.DragonFruit。首先以一個(gè)簡(jiǎn)單的示例來(lái)演示它的功能。

staticvoidMain(stringinput,stringoutput)

Console.WriteLine($"Input:{input},Output:{output}");

}

這里我們并沒(méi)有要顯式使用這個(gè)庫(kù)，只需要將Main函數(shù)的入?yún)⒏某晌覀冃枰褂玫念愋停绦虮阕詣?dòng)實(shí)現(xiàn)了命令行的支持。我們甚至可以用help查看程序的命令行的配置方式

ConsoleApp1.exe--help

Usage:

ConsoleApp1[options]

Options:

--inputINPUTinput

--outputOUTPUToutput

--versionDisplayversioninformation

可見(jiàn)，它能自動(dòng)根據(jù)Main函數(shù)的參數(shù)自動(dòng)解析出命令行的格式，并生成幫助文檔。

接著，我們?cè)賮?lái)看看命令行的使用：

ConsoleApp1--inputii--outputout

Input:ii,Output:out

完美的進(jìn)行了命令行的解析，它也可以讀取xml注釋，實(shí)現(xiàn)更加復(fù)雜的說(shuō)明。

///summary

///Convertsanimagefilefromoneformattoanother.

////summary

///paramname="input"Thepathtotheimagefilethatistobeconverted./param

///paramname="output"Thenameoftheoutputfromtheconversion./param

///paramname="xCropSize"Thexdimensionsizetocropthepicture.Thedefaultis0indicatingnocroppingisrequired./param

///paramname="yCropSize"Thexdimensionsizetocropthepicture.Thedefaultis0indicatingnocroppingisrequired./param

staticvoidMain(stringinput,stringoutput,intxCropSize=0,intyCropSize=0)

}

生成的幫助輸出效果如下：

ConsoleApp1:

Convertsanimagefilefromoneformattoanother.

Usage:

ConsoleApp1[options]

Options:

--inputINPUTThepathtotheimagefilethatistobeconverted.

--outputOUTPUTThenameoftheoutputfromtheconversion.

--x-crop-sizeX-CROP-SIZEThexdimensionsizetocropthepicture.Thedefaultis0indicatingnocroppingisrequired.

--y-crop-sizeY-CROP-SIZEThexdimensionsizetocropthepicture.Thedefaultis0indicatingnocroppingisrequired.

--versionDisplayversioninformation

相比傳統(tǒng)的命令行庫(kù)，這個(gè)庫(kù)的優(yōu)勢(shì)非常明顯，我們可以幾乎不編寫任何代碼就可以獲得命令行程序的支持。對(duì)于復(fù)雜的命令行程序來(lái)說(shuō)，可能這里的方式并不能滿足需求。System.CommandLine雖然也支持像傳統(tǒng)命令行的庫(kù)那樣編寫復(fù)雜的命令行支持程序，但這不在本文的介紹范圍內(nèi)。感興趣的