Flutter应用版本获取插件application_version的使用

特性

• 获取应用版本：检索应用的版本和构建号。
• VersionData 类：
  • 解析：解析版本字符串并确保语义化版本（例如，“1.0”变为“1.0.0”）。
  • 比较：实现 Comparable<VersionData> 接口以进行版本比较。
  • 相等性：重写 == 和 hashCode 以便正确检查相等性和在集合中使用。
  • 字符串表示形式：提供 toString 方法以可读格式显示版本。

为什么创建这个项目？

许多开发者使用 package_info 包，它提供了广泛的功能。然而，package_info 的广泛功能伴随着许多依赖项，这些依赖项可能会与其他包冲突。因此，创建了这个小包来仅做一件事：显示应用程序的版本。它的目标是轻量级且依赖项最少，从而减少冲突的风险。

安装

在你的 pubspec.yaml 文件中添加 application_version 作为依赖项：

dependencies:
  application_version: "^0.0.1"

如何使用

在你的 Dart 文件中导入以下包：

import 'package:application_version/application_version.dart';

然后你可以这样获取版本信息：

VersionData? version = await ApplicationVersion.getVersion();

VersionData 类

VersionData 类包含用于比较的方法，这在从后端接收最低要求版本时可能很有用。

final version1 = VersionData.parse('1.2+100');
final version2 = VersionData.parse('1.2.0+101');
final version3 = VersionData.parse('1.3');
final version4 = VersionData.parse('1.2.0');

print(version1 < version2); // true
print(version1 > version3); // false
print(version2 >= version1); // true
print(version3 <= version2); // false
print(version1 == version4); // true 

// 忽略构建号的比较
print(version1 == version4); // true 

// 检查当前版本是否符合最低要求版本
final currentVersion = VersionData.parse('2.0.1');
final minRequiredVersion = VersionData.parse('2.0.0');

if (currentVersion >= minRequiredVersion) {
  print('Current version meets the minimum required version.');
} else {
  print('Current version does not meet the minimum required version.');
}

示例代码

import 'package:application_version/version_data.dart';
import 'package:flutter/material.dart';
import 'dart:async';

import 'package:flutter/services.dart';
import 'package:application_version/application_version.dart';

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

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  VersionData? _version;

  [@override](/user/override)
  void initState() {
    super.initState();
    initVersionState();
  }

  Future<void> initVersionState() async {
    VersionData? version;

    try {
      version = await ApplicationVersion.getVersion();
    } on PlatformException {
      version = null;
    }

    // 如果在异步平台消息飞行期间小部件被从树中移除，我们想丢弃回复而不是调用 setState 更新不存在的外观。
    if (!mounted) return;

    setState(() {
      _version = version;
    });
  }

  final v1 = VersionData.parse('0.0.1');
  final v2 = VersionData.parse('1.0.0');
  final v3 = VersionData.parse('1.0.0+2');
  final v4 = VersionData.parse('1.0.2');

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('插件应用版本'),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              Text('运行于: $_version\n'),
              if (_version != null) ...[
                Text('版本: ${_version!.semantic}\n'),
                Text('构建号: ${_version!.buildNumber}\n'),
                Text('$v1 > $_version: ${v1 > _version!}\n'),
                Text('$v2 == $_version: ${v2 == _version!}\n'),
                Text('$v3 > $_version: ${v3 > _version!}\n'),
                Text('$v4 > $_version: ${v4 > _version!}\n'),
              ],
            ],
          ),
        ),
      ),
    );
  }
}