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

更新时间：2021年06月03日 11:47:14 作者：zhaotianff

System.CommandLine是一个基于.Net Standard 2.0的命令行参数解析库，该项目还是属于beta状态，期待以后的正式版本，文章通过示例代码给大家介绍了System.CommandLine使用讲解，感兴趣的朋友一起看看吧

命令行参数

平常在日常的开发过程中，会经常用到命令行工具。如cmd下的各种命令。

以下为sc命令执行后的截图，可以看到，由于没有输入任何附带参数，所以程序并未执行任何操作，只是输出了描述和用法。

系统在创建一个新进程时，会传一个命令行给它，也就是命令行字符串。

程序需要对命令行字符串进行解析，并执行相应操作。

如使用sc query可以查询当前系统的服务：

在C#中的控制台程序中，Main函数中传入的args字符串数组，就是系统传入进程的命令行参数。

在构建具有复杂命令行参数的控制台程序时，手动解析参数就变得非常麻烦。这里推荐一个开源的库，可以更加方便的解析命令行参数。

System.CommandLine介绍

System.CommandLine是一个基于.Net Standard 2.0（支持.Net FrameWork 4.6.1.2+和.Net Core 2.0+）的命令行参数解析库，项目地址https://github.com/dotnet/command-line-api，目前，该项目还是属于beta状态，期待以后的正式版本。

由于不是正式版本，在Nuget中引用时，需要钩上Include prerelease，才能找到这个包。

System.CommandLine的一些基本概念

Token(标记)

命令行的每个单词都是一个标记，如下面的"sc"、"query"和"eventlog"都是一个Token

Commands(命令)

Commands就是应用程序根据Token执行相应的操作(在System.CommandLine库中，对应 Command类)

Root Command(根命令)

根命令是代表可执行程序本身的Commands，如 sc(在System.CommandLine库中，对应RootCommand类)

SubCommands(子命令)

一些命令行程序会有SubCommands，如上面的sc query中的query就是子命令(在System.CommandLine，对应Command类)

Options(可选项)

Options就是传递给Commands的命名参数，如 app -myoption123中的 -myoption 123就是一个Options

Argument(参数)

参数就是传递给选项或命令的值。

说明：

常规的调用如下：

xx.exe [options] <argument> [command]

Delimiters（分隔符）

分隔符就是把Options的命令和值分开的符号

如下三种写法都是一样的，可以使用空格、=或：符号

app -myoption 123

app -myoption=123

app -myoption:123

Aliases(别名)

可以为命令或选项设置较短的别名，如

-v, --verbose

--o, --option

System.CommandLine使用

在下面的示例中，我们会构建一个简单的控制台爬虫工具。

1、使用Visual Studio 2019创建一个.Net Core控制台程序crawler-line

2、导入System.CommandLine包

3、创建一个RootCommand

var rootCommand = new RootCommand
            {
                new Argument<string>(
                    "url","web site url"),
                new Option<bool>(new string[]{ "--gethtml" ,"-html"},"Get html source"),
                new Option<bool>(new string[]{ "--getimage" ,"-image"},"Get images"),
                new Option<bool>(new string[]{ "--regex-option" ,"-regex"},"Use regex"),
                new Option<bool>(new string[]{ "--htmlagilitypack-option", "-agpack"},"Use HtmlAgilityPack"),
                new Option<bool>(new string[]{ "--anglesharp-option", "-agsharp"},"Use AngleSharp"),
                new Option<string>(new string[]{ "--download-path" ,"-path"},"Designate download path"),13             };

说明：

可通过Option类的构造函数重载，为Option指定默认值。

public Option(string alias, Func<T> getDefaultValue, string? description = null);

如上面的-path Option，指定默认值为D:\download，如下：

 new Option<string>(new string[]{ "--download-path" ,"-path"},getDefaultValue:()=>"D:\\download","Designate download path"),

也可以先实例化RootCommand对象，再通过Add的方式添加Argument和Option，如下：

var rootCommand = new RootCommand();
 //添加 Argument
rootCommand.AddArgument(new Argument<string>("url","web site url"));
//添加 Option
rootCommand.AddOption(new Option<string>(new string[] {"--download-path","-path" },"download path"));

4、添加当前命令行程序的描述信息

rootCommand.Description = ".Net Core command-line crawler.";

5、解析Argument和Option

rootCommand.Handler = CommandHandler.Create<string, bool, bool, bool, bool, bool, string>((string url, bool html, bool image, bool regex, bool agpack, bool agsharp, string path) => {
                
            });

如果觉得参数太长，可以封装成类，再进行调用，如下：

public class CrawlerOption
    {
        public string Url { get; set; }
        public bool GetHtml { get; set; }
        public bool GetImage { get; set; }
        public bool RegexOption { get; set; }
        public bool HtmlagilitypackOption { get; set; }
        public bool AnglesharpOption { get; set; }
        public string DownloadPath { get; set; }
    }

rootCommand.Handler = CommandHandler.Create<CrawlerOption>((crawlerOption) =>
            {

            })

6、添加Command并为Command添加处理函数

             //添加 Command
             var githubCommand = new Command("github", "fork me on github");
             //添加 Command的处理函数
             githubCommand.Handler = CommandHandler.Create(() => { System.Diagnostics.Process.Start(new System.Diagnostics.ProcessStartInfo("cmd", $"/c start https://github.com/zhaotianff/Crawler-Line")); });
             //将Command添加 到RootCommand
            rootCommand.AddCommand(githubCommand);

说明：

1、RootCommand是顶级命令，RootCommand可以添加Command，Command又可以再添加SubCommand。如此可以无限循环，没有限制。但建议还是不要添加太多级的Command，调用的时候会不太友好

2、Command和RootCommand原理一样，如果需要为Command添加Argument、Option和Command，可以参照前面的示例

7、调用解析

return rootCommand.InvokeAsync(args).Result;

8、调用示例

#执行github command
crawler-line.exe github
#执行github subcommand
crawler-line.exe github sub
#执行argument option
crawler-line.exe http://www.baidu.com -path "D:\test"

特别提示：

前面示例中，都是为RootCommand添加的Argument和Option，如果又指定 -path(Option)，又执行github（Command）肯定会失败。因为github这个命令是RootCommand的子命令，而-path选项是为RootCommand添加的

示例代码

https://github.com/zhaotianff/Crawler-Line/tree/v1.0

以上就是C#命令行参数解析库System.CommandLine介绍的详细内容，更多关于C#命令行参数解析库System.CommandLine的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

c#读取文件详谈
你平时是怎么读取文件的？使用流读取。是的没错，C#给我们提供了非常强大的类库（又一次吹捧了.NET一番）
2013-09-09
C# List实现行转列的通用方案
本篇通过行转列引出了System.Linq.Dynamic，并且介绍了过滤功能，具有很好的参考价值。下面跟着小编一起来看下吧
2017-03-03
C# BitArray点阵列的使用
本文主要介绍了C# BitArray点阵列的使用，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-03-03
在C#中如何使用JSON
JSON（JavaScript Object Notation）是一种轻量级的数据交换格式,具有易读、易解析的特点,广泛用于API数据交互、配置文件等,本文介绍在C#中如何使用JSON,感兴趣的朋友跟随小编一起看看吧
2024-09-09
C#实现伪装文件夹功能
这篇文章主要为大家详细介绍了如何利用C#实现伪装文件夹的功能，文中的示例代码讲解详细，对我们学习C#有一定的帮助，感兴趣的小伙伴可以跟随小编一起了解一下
2022-12-12
简单对比C#程序中的单线程与多线程设计
这篇文章主要介绍了C#程序中的单线程与多线程设计的简单对比,通过实际的代码演示可以清晰看出多线程并发来避免单线程阻塞问题的特点,需要的朋友可以参考下
2016-04-04
史上最简洁C# 生成条形码图片思路及示例分享
这篇文章主要介绍了史上最简洁C# 生成条形码图片思路及示例分享,需要的朋友可以参考下
2015-01-01
在C#中List集合使用First()方法获取第一个元素的操作
这篇文章主要介绍了在C#中List集合使用First()方法获取第一个元素的操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-12-12
C# WebApi 接口返回值不困惑：返回值类型详解
这篇文章主要介绍了C# WebApi 接口返回值不困惑：返回值类型详解,小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-07-07
.NET使用C#设置Excel单元格数值格式
这篇文章主要为大家详细介绍了如何使用C#在.NET程序中实现对Excel单元格数字格式的设置,帮助实现更完善的Excel文件处理,感兴趣的小伙伴可以了解下
2024-12-12