C#通过System.CommandLine快速生成支持命令行的应用程序

一直以来，当我们想让我们的控制台程序支持命令行启动时，往往需要编写大量代码来实现这一看起来很简单的功能。虽然有一些库可以简化一些操作，但整个过程仍然是一个相当枯燥而乏味的过程。

今天，我这里要介绍一个新的命令行库：System.CommandLine，通过他我们可以几乎无需任何额外的编码就可以获得命令行的支持，它能大幅减少程序员花在提供命令行API（CLI）上的时间，改善CLI程序用户的体验，让开发者能专注于编写应用程序。

目前这个库还是预览版本，要体验的话需要可以使用如下库：System.CommandLine.DragonFruit。首先以一个简单的示例来演示它的功能。

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

这里我们并没有要显式使用这个库，只需要将Main函数的入参改成我们需要使用的类型，程序便自动实现了命令行的支持。我们甚至可以用—help查看程序的命令行的配置方式

ConsoleApp1.exe --help
    Usage:
     ConsoleApp1 [options]
    Options:
     --input <INPUT> input
     --output <OUTPUT> output
     --version Display version information

可见，它能自动根据Main函数的参数自动解析出命令行的格式，并生成帮助文档。

接着，我们再来看看命令行的使用：

ConsoleApp1 --input ii --output out
    Input: ii, Output: out

完美的进行了命令行的解析，它也可以读取xml注释，实现更加复杂的说明。

/// <summary>
/// Converts an image file from one format to another.
/// </summary>
/// <param name="input">The path to the image file that is to be converted.</param>
/// <param name="output">The name of the output from the conversion.</param>
/// <param name="xCropSize">The x dimension size to crop the picture. The default is 0 indicating no cropping is required.</param>
/// <param name="yCropSize">The x dimension size to crop the picture. The default is 0 indicating no cropping is required.</param>
static void Main(string input, string output, int xCropSize = 0, int yCropSize = 0)
{
}

生成的帮助输出效果如下：

ConsoleApp1:
     Converts an image file from one format to another.
    Usage:
     ConsoleApp1 [options]
    Options:
     --input <INPUT> The path to the image file that is to be converted.
     --output <OUTPUT> The name of the output from the conversion.
     --x-crop-size <X-CROP-SIZE> The x dimension size to crop the picture. The default is 0 indicating no cropping is required.
     --y-crop-size <Y-CROP-SIZE> The x dimension size to crop the picture. The default is 0 indicating no cropping is required.
     --version Display version information

相比传统的命令行库，这个库的优势非常明显，我们可以几乎不编写任何代码就可以获得命令行程序的支持。对于复杂的命令行程序来说，可能这里的方式并不能满足需求。System.CommandLine虽然也支持像传统命令行的库那样编写复杂的命令行支持程序，但这不在本文的介绍范围内。感兴趣的朋友可以看一下参考文章的内容。

参考文章：

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持我们。

赞 (0)

相关推荐

  • C#访问命令行的两种方法

    本文实例讲述了C#访问命令行的两种方法.分享给大家供大家参考.具体如下: 方法1: // 参数:A B C using System; public class CommandLine { public static void Main(string[] args) { // Length 属性用于获取数组的长度. // 注意,Length 是只读属性: Console.WriteLine("Number of command line parameters = {0}", args.

  • C#开发交互式命令行应用示例

    C#开发交互式命令行应用示例

    目录 前言 Sharprompt介绍 Demo 结论 前言 如果你开发过vue应用,应该对其交互式命令行印象深刻: 它允许你无需任何编程经验,仅需回答问题,就可完成vue应用创建. 虽然作为.NETer,大部分情况下我们不会使用命令行,但是还是希望能用C#开发出这样的交互式命令行应用,比如代码生成器. Sharprompt介绍 Sharprompt是一个基于C#的交互式命令行应用框架,具有如下特点: 多平台支持 支持常用的提示方式(普通输入/密码/选择项等) 支持基于模型的提示(预览中) 输入值

  • C# 调用命令行执行Cmd命令的操作

    C# 调用命令行执行Cmd命令的操作

    1.不知道为啥 process.StartInfo.Arguments = "/c" + "start D:/Tim/Bin/QQScLauncher.exe"; 这个执行命令一定要加/c ,/c ,/c,重要的事说3遍 才能正常编译并运行 cmd /c dir:是执行完dir命令后关闭命令窗口: cmd /k dir:是执行完dir命令后不关闭命令窗口. process.StartInfo.Arguments 我猜测这个调用的是第一张图的窗口,而不是二图的窗口 代

  • C#读取命令行参数的方法

    本文实例讲述了C#读取命令行参数的方法.分享给大家供大家参考.具体如下: 下面的代码用于从命令行读取参数,参数个数不定,程序将会输出用户在命令行输入的所有参数列表 using System; namespace W3M { class ArgsExample { public static int Main(string[] args) { for (int i = 0; i < args.Length; i++) { Console.WriteLine(args[i]); } return 0

  • C#命令行编译器配置方法

    大家好!下面由我给大家讲解一下如何 配置C#命令行编译器 1.配置C#命令行编译器: 我的电脑 -〉高级 -〉环境变量 -〉Path -〉添 加";C:\Windows\Microsoft.NET\Framework\v2.0.50727"(Path的最后一个路径虽版本 的改变而改变).csc.exe(C#命令行编译器)就放在该目录下.通过csc /?来查看所有参 数.   2.配置其它.NET命令行工具 我的电脑 -〉高级 -〉环境变量 -〉Path -〉添加";D:\Pr

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

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

    命令行参数 平常在日常的开发过程中,会经常用到命令行工具.如cmd下的各种命令. 以下为sc命令执行后的截图,可以看到,由于没有输入任何附带参数,所以程序并未执行任何操作,只是输出了描述和用法. 系统在创建一个新进程时,会传一个命令行给它,也就是命令行字符串. 程序需要对命令行字符串进行解析,并执行相应操作. 如使用sc query可以查询当前系统的服务: 在C#中的控制台程序中,Main函数中传入的args字符串数组,就是系统传入进程的命令行参数. 在构建具有复杂命令行参数的控制台程序时 ,手

  • C#从命令行读取参数的方法

    本文实例讲述了C#从命令行读取参数的方法.分享给大家供大家参考.具体如下: using System; class MainClass { public static void Main(string[] args) { foreach (string arg in args) Console.WriteLine("Arg: {0}", arg); } } 将上面的代码保存为:readfile.cs,编辑源文件: csc readfile.cs 执行命令: readfile.exe j

  • C#通过System.CommandLine快速生成支持命令行的应用程序

    一直以来,当我们想让我们的控制台程序支持命令行启动时,往往需要编写大量代码来实现这一看起来很简单的功能.虽然有一些库可以简化一些操作,但整个过程仍然是一个相当枯燥而乏味的过程. 今天,我这里要介绍一个新的命令行库:System.CommandLine,通过他我们可以几乎无需任何额外的编码就可以获得命令行的支持,它能大幅减少程序员花在提供命令行API(CLI)上的时间,改善CLI程序用户的体验,让开发者能专注于编写应用程序. 目前这个库还是预览版本,要体验的话需要可以使用如下库:System.Co

  • 使用Golang快速构建出命令行应用程序

    目录 urfave/cli spf13/cobra 在日常开发中,大家对命令行工具(CLI)想必特别熟悉了,如果说你不知道命令工具,那你可能是个假开发.每天都会使用大量的命令行工具,例如最常用的Git.Go.Docker等. 不管是做技术开发还是业务开发,都会有开发命令行程序的场景.例如如果是开发框架,会开发一个命令行工具帮助使用者快速生成项目结构:如果是开发一个定时任务程序,会开发一个命令行工具来启动这个任务.本文就介绍两个专门用来开发命令行应用程序的库. urfave/cli urfave/

  • php生成curl命令行的方法

    本文实例讲述了php生成curl命令行的方法.分享给大家供大家参考,具体如下: 示例: curl "http://localhost/other/serverInfo.php?dd=ddd" -H "Host:localhost" -H "Connection:keep-alive" -H "Cache-Control:max-age=0" -H "Accept:text/html,application/xhtml

  • 网络基础版各种命令行集锦

    Switching 命令大全 Switching 命令大全 1. 在基于IOS的交换机上设置主机名/系统名: switch(config)# hostname hostname 在基于CLI的交换机上设置主机名/系统名: switch(enable) set system name name-string 2.在基于IOS的交换机上设置登录口令: switch(config)# enable password level 1 password 在基于CLI的交换机上设置登录口令: switch(

  • 使用Apache commons-cli包进行命令行参数解析的示例代码

    Apache的commons-cli包是专门用于解析命令行参数格式的包. 依赖: <dependency> <groupId>commons-cli</groupId> <artifactId>commons-cli</artifactId> <version>1.3.1</version> </dependency> 使用此包需要: 1.先定义有哪些参数需要解析.哪些参数有额外的选项.每个参数的描述等等,对应

  • go Cobra命令行工具入门教程

    go Cobra命令行工具入门教程

    目录 简介 为什么需要cobra 基本概念 安装 命令行工具 入门实践 命令构成 新增命令 如何显示自己的命令用法 总结 简介 Github:https://github.com/spf13/ cobraStar:26.5K Cobra是一个用Go语言实现的命令行工具.并且现在正在被很多项目使用,例如:Kubernetes.Hugo和Github CLI等.通过使用Cobra,我们可以快速的创建命令行工具,特别适合写测试脚本,各种服务的Admin CLI等.比如 Mattermost 项目,就写

  • 超级好用的4个Python命令行可视化库

    超级好用的4个Python命令行可视化库

    Python命令行可视化库 ① 使用Bashplotlib在命令行中绘图 如果你想在命令行窗口中绘制数据的情况,那么Bashplotlib是非常适合的. 首先安装Bashplotlib这个库. pip install bashplotlib -i https://mirror.baidu.com/pypi/simple/ 下面我们可以使用Bashplotlib来绘制一组正态分布的数据图表. 使用NumPy来生成一个正态分布数字列表. 如果还没有NumPy,同样可以使用pip安装. pip ins

  • python argparse命令行参数解析(推荐)

    argparse是python用于解析命令行参数和选项的标准模块. 很多时候,需要用到解析命令行参数的程序,目的是在终端窗口输入训练的参数和选项. argparse 模块可以让人轻松编写用户友好的命令行接口. 程序定义它需要的参数,然后 argparse 将弄清如何从 sys.argv 解析出那些参数. argparse 模块还会自动生成帮助和使用手册,并在用户给程序传入无效参数时报出错误信息. test.py # -*- coding: utf-8 -*- import argparse #

  • Java命令行运行错误之找不到或无法加载主类问题的解决方法

    Java命令行运行错误之找不到或无法加载主类问题的解决方法

    目录 前言: 一. 问题分析 二. 问题解决 1. 类名错误 2. 类所在位置未添加至类加载路径中 三.扩展知识 1. JDK目录结构及环境变量介绍 2. 为什么jdk1.5后不需要配置环境变量了? 总结 前言: 虽然学习Java语言约有两年多,但在最近需要使用命令行工具编译并运行Java程序时,还是报错了.花费了一些时间,解决了该问题,发现解决方法在初学Java时使用过.一则,为了避免以后再出现同样的问题而浪费不必要的时间:二则,作为使用该语言的程序员,对于该语言的一些基本问题,应该有清晰的理

随机推荐