C#命令行参数解析库System.CommandLine使用

C#命令行参数解析库System.CommandLine是一个开源的命令行工具，可以帮助开发者更方便地解析命令行参数，并生成相应的帮助文档。

安装

在使用System.CommandLine之前，需要先安装该库。可以通过NuGet进行安装，在Visual Studio的Package Manager Console中执行下面的命令：

Install-Package System.CommandLine

也可以在NuGet官网上搜索System.CommandLine进行安装。

使用方法

使用System.CommandLine的基本流程如下：

1. 创建根命令（RootCommand）对象
2. 配置根命令的选项和参数
3. 解析命令行参数并执行相应的逻辑

根据这个流程，我们来详细说明如何使用System.CommandLine。

1. 创建根命令

首先，我们需要创建一个根命令对象，可以使用System.CommandLine.RootCommand类来创建。

var rootCommand = new RootCommand();

2. 配置命令选项和参数

然后，我们需要为根命令添加选项和参数。可以使用Option和Argument类分别定义选项和参数。

rootCommand.AddOption(new Option<string>(
    "--name",
    "Your name",
    defaultValue: "World"));

rootCommand.AddOption(new Option<int>(
    "--age",
    "Your age"));

rootCommand.AddArgument(new Argument<string>(
    "file",
    "Input file path"));

上面的代码中，我们定义了一个--name选项，一个--age选项以及一个名为file的参数。

选项（Option）和参数（Argument）的区别是，前者是可选的，而后者是必须提供的。

对于每一个选项和参数，都可以指定其类型、名称、描述、缺省值等属性。

3. 解析命令行参数并执行逻辑

最后，我们需要解析命令行参数并执行相应的逻辑。可以使用System.CommandLine.Invocation.CommandHandler委托来指定执行的逻辑。

rootCommand.Handler = CommandHandler.Create<string, int, string>((name, age, file) =>
{
    Console.WriteLine($"Hello, {name} ({age})!");
    Console.WriteLine($"Input file: {file}");
});

上面的代码指定了一个简单的逻辑：输出用户的姓名和年龄，并打印输入文件的路径。

最后，我们调用System.CommandLine.Parser类的Parse方法进行参数解析，然后就可以执行上面指定的逻辑了。

var args = new[] { "--name", "Alice", "--age", "30", "input.txt" };
var parser = new Parser(rootCommand);

parser.Invoke(args);

以上代码将会输出：

Hello, Alice (30)!
Input file: input.txt

示例

下面是一个稍微复杂一些的示例，演示如何使用System.CommandLine解析命令行参数和生成帮助文档。

using System;
using System.CommandLine;
using System.CommandLine.Invocation;
using System.IO;

namespace CommandLineDemo
{
    class Program
    {
        static void Main(string[] args)
        {
            var rootCommand = new RootCommand()
            {
                // 允许使用“-h”、“--help”选项获取帮助信息
                Description = "Demo for System.CommandLine",
                TreatUnmatchedTokensAsErrors = true,
                Handler = CommandHandler.Create<string, int, FileInfo>((name, age, file) =>
                {
                    Console.WriteLine($"Hello, {name} ({age})!");
                    Console.WriteLine($"Input file: {file.FullName}");
                })
            };

            rootCommand.AddOption(new Option<string>(
                "--name",
                "Your name",
                defaultValue: "World"));

            rootCommand.AddOption(new Option<int>(
                "--age",
                "Your age"));

            rootCommand.AddArgument(new Argument<FileInfo>(
                "file",
                "Input file path")
            {
                Arity = ArgumentArity.ExactlyOne
            });

            var addressOption = new Option<string>("-a", "Your address");
            rootCommand.AddOption(addressOption);

            var emailOption = new Option<string>("--email", "Your email address")
            {
                Required = true
            };
            rootCommand.AddOption(emailOption);

            var phoneOption = new Option<string>("--phone", "Your phone number")
            {
                Arity = ArgumentArity.OneOrMore
            };
            rootCommand.AddOption(phoneOption);

            var showHelpOption = new Option<bool>("-h", "Show help information");
            rootCommand.AddOption(showHelpOption);

            rootCommand.Handler = CommandHandler.Create<bool>((bool showHelp) =>
            {
                if (showHelp)
                {
                    new HelpBuilder().Write(rootCommand);
                    return;
                }

                throw new ArgumentException("No options were specified.");
            });

            var parser = new CommandLineParser(rootCommand);
            parser.Invoke(args);
        }
    }
}

在上面的代码中，我们添加了更多的选项和参数，用来广泛演示System.CommandLine的各种用法。

当命令行参数不符合要求时，执行错误处理函数，并输出帮助文档。

CommandLineDemo.exe -h
CommandLineDemo.exe -a "Shanghai" input.txt
CommandLineDemo.exe --email "[e-mail]" --phone "1234567890" --name "Alice" --age 30 input.txt

上述命令将分别输出帮助信息、地址选项的值以及输入文件、用户名、年龄、邮箱和电话号码。

总结

本文介绍了如何使用System.CommandLine解析命令行参数。通过使用System.CommandLine可以方便地定义和解析命令行选项和参数，并生成帮助文档。希望读者能够通过本文了解System.CommandLine的基本用法，更好地应用于实际项目。