C# 零代码实现命令行工具：System.CommandLine.DragonFruit 快速入门

纸上星河

发布时间：2026-10-13| 6人浏览过

原创

在使用 .NET 开发控制台应用程序时，传统方式往往需要引入复杂的第三方库来解析命令行参数，或者手动编写繁琐的字符串匹配逻辑。System.CommandLine.DragonFruit 提供了一种声明式的方式，允许开发者仅通过定义 Main 方法的参数类型和顺序，即可自动生成健壮的命令行接口（CLI），包括自动解析、验证和帮助信息输出，显著降低开发门槛。

预期效果与目标

通过引入 System.CommandLine.DragonFruit 预览版库，你的 C# 控制台程序将具备以下能力：

自动参数映射：Main 方法的参数自动对应命令行选项（如 --input）或位置参数。
自动生成帮助文档：支持 --help 查看用法，且能读取 XML 文档注释作为详细说明。
类型安全：支持基本数据类型、枚举等，由库自动完成格式校验与转换。

准备条件

安装 .NET SDK（推荐 .NET Core 3.1 或 .NET 5+，以确保对预览包的良好支持）。
创建一个新的 Console 项目：
```
dotnet new console -n MyCliApp
```
安装 NuGet 包：由于 DragonFruit 通常为预览版本，需添加源并安装：
```
dotnet add package System.CommandLine.DragonFruit --prerelease
```

基本操作示例

第 1 步：定义简单的入口参数

这是最核心的步骤。你不需要调用任何 API，只需改变 Main 方法的签名。

操作说明：

入口：Program.cs 中的 Main 方法。
动作：将传统 string[] args 替换为你希望支持的参数变量。参数的名称将被自动转换为命令行选项名（通常转为小写短横线格式）。

using System;

class Program
{
    // 无需显式引用 System.CommandLine，库会自动注入
    static void Main(string input, string output)
    {
        Console.WriteLine($"Input: {input}, Output: {output}");
    }
}

可观察的完成状态：

编译运行后，直接执行 --help，系统会自动生成如下帮助文本，展示了两个可选参数：

Usage: MyCliApp [options]
Options:
  --input <INPUT>    input
  --output <OUTPUT>  output
  --version          Display version information

第 2 步：执行命令行操作

操作说明：

入口：命令行终端。
动作：传入参数值。

MyCliApp.exe --input ii.jpg --output out.png

结果：

Input: ii.jpg, Output: out.png

即使参数顺序交换，只要带有命名前缀，也能正确解析：

MyCliApp.exe --output out.png --input ii.jpg

第 3 步：配置带默认值与复杂类型的参数

目的：利用 C# 的特性支持默认值和多维度配置，并通过 XML 注释增强用户指引。

操作说明：

入口：Main 方法。
重要参数：= 0 设定默认值；XML 注释用于生成 Help 详情。

/// <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 y 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)
{
    Console.WriteLine($"Processing {input} to {output}. Crop: {xCropSize}x{yCropSize}");
}

生成的帮助效果：

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 y dimension size to crop the picture. The default is 0 indicating no cropping is required.

注意事项与局限

DragonFruit 主要适用于声明式的简单到中等复杂度 CLI。它通过反射和特性约定自动工作，因此具有以下特点：

无自定义逻辑干扰：如果需要在参数解析前后执行复杂的 Hook 逻辑（如全局异常捕获、特定初始化），DragonFruit 的标准用法可能不够灵活。
版本兼容性：文中使用的为预览包，正式生产环境建议评估 System.CommandLine 的正式发布版本（RC 或 RTM），其底层机制相同，但提供了更高级的手动构建器 API 以满足复杂需求。
参数命名规范：C# 参数名会被自动转换为 kebab-case（小写+连字符），例如 myConfig 变为 --my-config。