CommandLineUtils 命令行参数解析：Arguments 详解-CSDN博客

CommandLineUtils 命令行参数解析：Arguments 详解

引言

在开发命令行工具时，参数解析是最基础也是最重要的功能之一。CommandLineUtils 是一个强大的.NET命令行参数解析库，它提供了两种方式来定义和解析命令行参数：通过特性(Attributes)和构建器API(Builder API)。本文将深入讲解CommandLineUtils中Arguments（位置参数）的使用方法。

基本概念

命令行参数通常分为两类：

Arguments（位置参数）：通过位置顺序来识别，不需要参数名
Options（选项参数）：通过名称来识别，需要参数名（将在其他文章中详细介绍）

基础用法

使用特性(Attributes)方式

特性方式通过在类属性上添加[Argument]特性来定义位置参数：

public class Program
{
    // 定义第一个位置参数（索引0），并标记为必填
    [Argument(0)]
    [Required]
    public string FirstName { get; }

    // 定义第二个位置参数（索引1），可选
    [Argument(1)]
    public string LastName { get; }

    private void OnExecute()
    {
        Console.WriteLine($"Hello {FirstName} {LastName}");
    }

    public static int Main(string[] args) => CommandLineApplication.Execute<Program>(args);
}

使用示例：

myapp John Doe

John会被赋值给FirstName
Doe会被赋值给LastName

使用构建器API(Builder API)方式

构建器API提供了更灵活的编程方式来定义参数：

public class Program
{
    public static int Main(string[] args)
    {
        var app = new CommandLineApplication();

        // 定义第一个位置参数
        var firstNameArg = app.Argument("first name", "the first name of the person")
            .IsRequired();
        
        // 定义第二个位置参数
        var lastNameArg = app.Argument("last name", "the last name of the person");

        app.OnExecute(() =>
        {
            Console.WriteLine($"Hello {firstNameArg.Value} {lastNameArg.Value}");
        });

        return app.Execute(args);
    }
}

可变数量参数

有时我们需要处理数量不定的参数，比如处理多个文件：

myapp file1.txt file2.txt file3.txt

特性方式实现

public class Program
{
    [Argument(0)]
    public string[] Files { get; } // 自动收集所有位置参数

    private void OnExecute()
    {
        foreach (var file in Files)
        {
            // 处理每个文件
        }
    }

    public static int Main(string[] args) => CommandLineApplication.Execute<Program>(args);
}

构建器API实现

public class Program
{
    public static int Main(string[] args)
    {
        var app = new CommandLineApplication();
        
        // 设置multipleValues为true以接收多个值
        var files = app.Argument("Files", "Files to process", multipleValues: true);
        
        app.OnExecute(() =>
        {
            foreach (var file in files.Values)
            {
                // 处理每个文件
            }
        });
        
        return app.Execute(args);
    }
}

参数透传

开发包装其他命令的工具时，经常需要将部分参数透传给内部命令。例如Unix的time命令：

time -l ls -a -l ./

特性方式实现

public class Program
{
    [Option("-l")]
    public bool ShowDetails { get; }

    // 剩余参数会自动收集到RemainingArguments属性
    public string[] RemainingArguments { get; }

    private void OnExecute()
    {
        // 使用RemainingArguments中的参数调用其他命令
    }

    public static int Main(string[] args) => CommandLineApplication.Execute<Program>(args);
}

构建器API实现

public class Program
{
    public static int Main(string[] args)
    {
        var app = new CommandLineApplication
        {
            // 设置如何处理未识别参数
            UnrecognizedArgumentHandling = UnrecognizedArgumentHandling.StopParsingAndCollect,
            // 允许使用--分隔符
            AllowArgumentSeparator = true
        };

        var showDetails = app.Option("-l", "Show details", CommandOptionType.NoValue);
        
        app.OnExecute(() =>
        {
            // 使用app.RemainingArguments调用其他命令
        });
        
        return app.Execute(args);
    }
}