Flutter版本生成管理插件version_gen的使用

Flutter版本生成管理插件version_gen的使用

插件简介

version_gen 是一个用于 Dart 代码生成的工具，它可以帮助你从 pubspec.yaml 文件中获取包的版本信息。在 Dart 生态系统中，无法直接从代码中获取包的版本。

安装步骤

1. 在你的 pubspec.yaml 文件中添加 build_runner 和 version_gen：

   dev_dependencies:
     build_runner: ^2.0.4
     version_gen: ^1.0.0
   

2. 安装 version_gen：

   $ flutter pub get
   

3. 使用 version_gen 生成版本文件：

   $ flutter packages pub run build_runner build
   

配置文件

version_gen 根据 pubspec.yaml 文件中的 VersionGen 键生成 Dart 文件。默认配置可以在这里找到。

# pubspec.yaml
# ...

dev_dependencies:
  build_runner: ^2.0.4
  version_gen: ^1.0.0

# Optional (default: lib/gen/)
version_gen:
  path: lib/gen/

输出文件

version_gen 会生成一个包含版本信息的 Dart 文件，如下所示：

/// DO NOT MODIFY BY HAND, Generated by version_gen
String packageVersion = '1.0.0+1';

示例项目

以下是一个完整的示例项目，展示如何使用 version_gen 获取和显示包的版本信息。

main.dart

import 'package:flutter/material.dart';
// 导入生成的版本文件
import 'package:your_project_name/gen/package_version.dart';

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

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headline4,
            ),
            // 显示包的版本信息
            Text(
              'Package Version: $packageVersion',
              style: Theme.of(context).textTheme.headline6,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}