Flutter插件信息构建插件cli_info_builder的使用

Flutter插件信息构建插件cli_info_builder的使用

cli_info_builder 是一个用于生成包含 Dart CLI 应用程序信息类的包。通过该插件，开发者可以轻松地获取并利用应用程序的相关信息。

使用

1. 添加必要的依赖

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

dependencies:
  cli_info: ^x.x.x

dev_dependencies:
  build_runner: ^x.x.x
  cli_info_builder: ^x.x.x

然后运行以下命令以安装这些依赖项：

dart pub add cli_info
dart pub add dev:build_runner
dart pub add dev:cli_info_builder

2. 运行构建任务

安装完依赖后，运行构建任务以生成包含应用程序信息的类文件：

dart pub run build_runner build

3. 生成的文件

上述构建任务将生成一个文件，路径默认为 lib/gen/cli_info.dart，内容如下：

// coverage:ignore-file
// GENERATED CODE - DO NOT MODIFY BY HAND
// ignore_for_file: type=lint
// ignore_for_file: lines_longer_than_80_chars

import 'package:cli_info/cli_info.dart';

const cliInfo = CliInfo(
    //...
);

可选配置

如果您希望更改目标可执行文件的名称索引或生成文件的路径，可以在项目的根目录下创建一个 build.yaml 文件，并写入以下内容：

targets:
  $default:
    builders:
      cli_info_builder:
        options:
          executables-index: 1 # 默认是 0
          output: "lib/gen/info.dart" # 默认是 "lib/gen/cli_info.dart"

示例代码

下面是一个简单的示例，展示了如何在应用中使用生成的信息类：

import 'package:example/gen/info.dart';

void printCliInfo() {
  final text = '''
CLI Information:
- name: ${cliInfo.name}
- description: ${cliInfo.description}
- version: ${cliInfo.version}
''';
  print(text);
}

通过调用 printCliInfo() 函数，您可以输出应用程序的信息：

void main() {
  printCliInfo();
}

更多关于Flutter插件信息构建插件cli_info_builder的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter插件信息构建插件cli_info_builder的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然，下面是一个关于如何在Flutter项目中使用cli_info_builder插件的示例代码。cli_info_builder插件通常用于在构建Flutter应用时自动生成和嵌入应用信息（如版本、构建时间等）到应用中。

1. 添加依赖

首先，你需要在你的pubspec.yaml文件中添加cli_info_builder依赖：

dependencies:
  flutter:
    sdk: flutter
  cli_info_builder: ^x.y.z  # 请替换为最新版本号

然后运行flutter pub get来安装依赖。

2. 配置build.yaml

接下来，你需要在项目的根目录下创建或编辑build.yaml文件，添加如下配置：

targets:
  $default:
    builders:
      cli_info_builder:cli_info:
        enabled: true

3. 创建构建脚本

在项目的根目录下创建一个名为build.dart的脚本文件，并添加以下内容：

import 'package:cli_info_builder/cli_info_builder.dart';
import 'package:build_runner/build_runner.dart';

Future<void> main(List<String> args) async {
  final cliInfo = CliInfoBuilder(
    appName: 'MyFlutterApp',
    appVersion: '1.0.0',
    buildTimestamp: DateTime.now().toIso8601String(),
    // 你可以添加更多的自定义信息
  ).toJson();

  // 将构建信息写入到生成的 Dart 文件中
  await build(
    options: BuildOptions()
      ..config = BuildConfig.fromBuildConfig(
        BuildConfig(
          (context) => [
            CliInfoBuilder(cliInfo: cliInfo),
          ],
        ),
      ),
  );
}

4. 运行构建脚本

在终端中运行以下命令来执行构建脚本：

dart run build.dart

这个命令会生成一个包含应用信息的Dart文件（通常是lib/generated/cli_info.dart）。

5. 使用生成的信息

现在你可以在你的Flutter应用中使用生成的应用信息。例如，在lib/main.dart中：

import 'package:flutter/material.dart';
import 'generated/cli_info.dart' as cli_info; // 根据实际生成的文件路径调整

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Flutter App Info Demo'),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              Text('App Name: ${cli_info.cliInfo.appName}'),
              Text('App Version: ${cli_info.cliInfo.appVersion}'),
              Text('Build Timestamp: ${cli_info.cliInfo.buildTimestamp}'),
            ],
          ),
        ),
      ),
    );
  }
}

总结

通过上述步骤，你已经在Flutter项目中成功配置并使用了cli_info_builder插件来嵌入应用信息。这种方式可以帮助你在应用中轻松展示版本号和构建时间等信息，便于调试和发布管理。

回到顶部