2023-12-29

.NET 好用套件 - commandline

在.NET Framework 的時候，沒有內建的 CLI 指令參數解析，再到.NET Core 時，雖然有個套件System.CommandLine，但覺得沒有很好使用，之前有發現一個套件 commandline，設定及讀取參考很簡單易用，寫篇心得文分享一下。

設定

public class DefaultOptions
    {

        [Option('n', "name", Required = true, HelpText = "名稱")]
        public string Name { get; set; }

        [Option('r', "retry", HelpText = "是否要重新執行")]
        public bool Retry { get; set; }

        [Option('d', "date", HelpText = "要執行的日期")]
        public string Date { get; set; }
    }

首先建立 Options 類別，Commandline會透過 Attribute將屬性和 CLI 參數對應，可以參考文件，所以第一個參數設定簡短名稱，第二個參數設定完整名稱，看起來很淺顯易懂。

解析參數

await Parser.Default.ParseArguments<DefaultOptions>(args).WithParsedAsync(RunJob);

 async Task RunJob(DefaultOptions options)
{
    //do something
    Console.WriteLine($"name:{options.Name}");
}

使用ParseArguments 及 WithParsedAsync來解析參數，並取得 options 物件，也是很淺顯易懂的。

接著就可以使用熟悉的 unix style 方式設定參數來執行。

另一種方式

有時會需要根據不同的參數，取得不同的 Options 物件。看了一下原始檔，發現 ParseArguments 還有另一個多戴方法，可傳入 factory 工廠方式，來決定傳出的 Options 物件。

public class ActionAOptions: DefaultOptions
 {
        [Option('a', "action")]
        public string Action { get; set; }
  }

await Parser.Default.ParseArguments<DefaultOptions>(SelectOptions(args), args)
.WithParsedAsync(RunJob2);

async Task RunJob2(DefaultOptions options)
{
    var actionOptions = (ActionAOptions)options;

    //do something
    Console.WriteLine($"name:{actionOptions.Name}, action:{actionOptions.Action}");
}

Func<DefaultOptions> SelectOptions(string[] args)
{
    return () =>
    {
        var isAction = args[1]?.IndexOf("action") != -1;
        if (isAction)
        {
            return new ActionAOptions();
        }
        return new DefaultOptions();
    };
}

如同上面的程式碼，可以根據不同名稱，取回不同的 options 物件，例如名稱(-n/--name)為 action 時，可以多傳入參數 action。

結論

總結來說，使用命令列參數解析工具可以讓我們更輕鬆地處理參數，這不僅讓程式碼更易讀，也讓程式開發更加輕鬆。藉由簡單的設定和解析過程，我們能夠更專注於實際的工作。這種方式不僅提高了效率，同時也增加了程式碼的整體易讀性。