Flutter构建工具插件build_cli的使用

build_cli 是一个用于解析命令行参数并将其直接映射到注解类的Dart包，它利用了Dart的构建系统（Dart Build System）。本文将详细介绍如何使用 build_cli 插件，并提供完整的示例代码。

示例代码及说明

1. 添加依赖

首先，在 pubspec.yaml 文件中添加以下依赖：

dependencies:
  build_cli_annotations: ^1.0.0

dev_dependencies:
  build_cli: ^1.0.0
  build_runner: ^1.0.0

• build_cli_annotations：包含用于注解类和成员的注解，通常放在 dependencies 中。
• build_cli 和 build_runner：分别包含生成代码的逻辑和运行构建的逻辑，通常放在 dev_dependencies 中。

2. 定义选项类

接下来，定义一个类来表示命令行选项。使用 @CliOptions() 注解该类，并为每个字段添加 @CliOption() 注解以指定命令行参数的细节。

import 'package:build_cli_annotations/build_cli_annotations.dart';

part 'example.g.dart';

/// 使用 @CliOptions 注解选项类
@CliOptions()
class Options {
  /// 使用 @CliOption 注解字段以自定义选项和标志
  @CliOption(abbr: 'n', help: 'Required. The name to use in the greeting.')
  final String name;

  /// 未注解的字段 [name]WasParsed 将被自动填充为 ArgResult.wasParsed('name')
  final bool nameWasParsed;

  /// 布尔字段会自动转换为标志
  late bool yell;

  /// 字段名称会自动转换为连字符格式（如 --display-language）
  @CliOption(defaultsTo: Language.en, abbr: 'l')
  late Language displayLanguage;

  /// 不可否定的标志
  @CliOption(negatable: false, help: 'Prints usage information.')
  late bool help;

  /// 构造函数参数与字段匹配时会自动填充
  Options(this.name, {this.nameWasParsed = false});
}

/// 枚举类型是定义固定值选项的好方法
enum Language { en, es }

3. 解析命令行参数

在 main 函数中调用 parseOptions 方法来解析命令行参数，并根据解析结果执行相应操作。

import 'dart:io';

void main(List<String> args) {
  Options options;
  try {
    options = parseOptions(args);
    if (!options.nameWasParsed) {
      throw const FormatException('You must provide a name.');
    }
  } on FormatException catch (e) {
    print(e.message);
    print('');
    _printUsage();
    exitCode = 64;
    return;
  }

  if (options.help) {
    _printUsage();
    return;
  }

  final buffer = StringBuffer();

  switch (options.displayLanguage) {
    case Language.en:
      buffer.write('Hello, ');
    case Language.es:
      buffer.write('¡Hola, ');
  }

  buffer
    ..write(options.name)
    ..write('!');

  if (options.yell) {
    print(buffer.toString().toUpperCase());
  } else {
    print(buffer);
  }
}

void _printUsage() {
  print('Usage: example/example.dart [arguments]');
  print(_$parserForOptions.usage);
}

4. 运行构建

确保所有文件都已保存后，运行以下命令来生成代码：

dart run build_runner build

这将生成一个名为 example.g.dart 的文件，其中包含解析命令行参数所需的辅助代码。

5. 测试命令行工具

现在可以运行生成的命令行工具，测试不同的命令行参数：

dart run bin/example.dart --help
dart run bin/example.dart -n "World" -l es --yell

更多资源

• 官方GitHub仓库 包含更多详细文档和示例。
• 完整示例项目 提供了一个端到端的例子。
• 测试目录 包含了更多功能测试。

通过以上步骤，您可以轻松地使用 build_cli 插件来构建功能强大的命令行工具。希望这些信息对您有所帮助！