Flutter应用升级管理插件upgrade_util的使用

Flutter应用升级管理插件upgrade_util的使用

目前，该插件仅支持Android和iOS。

第三方库的使用

• 使用dio下载apk文件，此功能已经内置在插件中，无需单独引用。

准备工作

版本约束

  sdk: ">=3.1.0 <4.0.0"
  flutter: ">=3.13.0"

依赖项

1. 在pubspec.yaml文件中添加upgrade_util依赖。

dependencies:
  upgrade_util: ^latest_version

1. 执行flutter pub get命令获取包。

flutter pub get

1. 引入upgrade_util库。

import 'package:upgrade_util/upgrade_util.dart';

本地化配置

在MaterialApp中添加本地化配置。

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      ...
      localizationsDelegates: const <LocalizationsDelegate<dynamic>>[
        ...
        UpgradeLocalizationsDelegate.delegate,
      ],
      ...
    );
  }
}

使用方法

showUpgradeDialog

通过调用showUpgradeDialog来弹出更新对话框。

UpgradeConfig

IosUpgradeConfig

AndroidUpgradeConfig

方法

要跳转到App Store或应用市场，使用jumpToStore方法。

• 必须的项是jumpMode，目前有三种模式；

  1. JumpMode.detailPage，跳转到应用详情页面（即产品介绍页面）；
  2. JumpMode.reviewsPage，跳转到应用评论页面；
  3. JumpMode.writeReview，跳转到应用评论页面并评论。

• 对于iOS，appleId是必需的，这是App Store的应用编号；

• 对于Android，marketPackageName是跳转到的应用市场的包名，不是必需的；

• 字段packageName不再提供，因为项目统一使用包名。

Android特有的方法

1. getDownloadPath，获取软件下载保存路径；
2. installApk，安装APK，并跳转到安装引导页；
3. getMarkets，获取手机内包含的应用市场列表。

示例代码

import 'dart:io';

import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:flutter_localizations/flutter_localizations.dart';
import 'package:upgrade_util/upgrade_util.dart';

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

/// 程序入口
class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      theme: ThemeData(useMaterial3: true),
      // locale: const Locale('zh', 'CN'),
      // locale: const Locale('en', 'US'),
      localizationsDelegates: const <LocalizationsDelegate<dynamic>>[
        GlobalMaterialLocalizations.delegate,
        GlobalWidgetsLocalizations.delegate,
        GlobalCupertinoLocalizations.delegate,
        UpgradeLocalizationsDelegate.delegate,
      ],
      supportedLocales: const <Locale>[Locale('en', 'US'), Locale('zh', 'CN')],
      home: const HomePage(),
      debugShowCheckedModeBanner: false,
    );
  }
}

/// 主页
class HomePage extends StatefulWidget {
  const HomePage({super.key});

  [@override](/user/override)
  State<HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  final List<String> list = [
    'Android Test: Get the download of apk',
    'Android Test: Get Available Market',
    'Jump To AppStore Reviews Page',
    'Jump To AppStore and Write Review',
    'Jump To Detail Page',
    'Upgrade Dialog',
  ];

  /// 微信应用商店编号
  final String wechatAppleID = '414478124';

  /// 微信包名
  final String wechatPackageName = 'com.tencent.mm';

  [@override](/user/override)
  Widget build(BuildContext context) => _platformWidget();

  Widget _platformWidget() {
    Widget child = Center(
      child: Text('不支持【 ${operatingSystem} 】平台'),
    );

    if (defaultTargetPlatform == TargetPlatform.iOS ||
        defaultTargetPlatform == TargetPlatform.android) {
      child = _buildBodyWidget();
    }

    return Scaffold(
      appBar: AppBar(title: const Text('App升级示例')),
      body: child,
    );
  }

  Widget _buildBodyWidget() {
    return ListView.builder(
      itemBuilder: (BuildContext context, int index) {
        final ElevatedButton child = ElevatedButton(
          onPressed: () async => onPressed(index),
          child: Text(list[index]),
        );

        return Container(
          margin: const EdgeInsets.only(top: 10),
          padding: const EdgeInsets.symmetric(horizontal: 15),
          child: child,
        );
      },
      itemCount: list.length,
    );
  }

  Future<void> onPressed(int index) async {
    switch (index) {
      case 0:
        final String result = await UpgradeUtil.getDownloadPath();
        debugPrint(result);
        break;
      case 1:
        // 获取手机内的所有应用市场列表
        final List<AndroidMarketModel> marketPackages =
            await UpgradeUtil.getMarkets(AndroidMarket.allTrue.toMarkets());
        debugPrint(marketPackages.toString());
        break;
      case 2:
        // 跳转到AppStore评论页面，这里以微信为例
        await UpgradeUtil.jumpToStore(
          jumpMode: JumpMode.reviewsPage,
          appleId: wechatAppleID,
        );
        break;
      case 3:
        // 跳转到AppStore并评论，这里以微信为例
        await UpgradeUtil.jumpToStore(
          jumpMode: JumpMode.writeReview,
          appleId: wechatAppleID,
        );
        break;
      case 4:
        // 跳转到详情页面，这里以微信为例
        await UpgradeUtil.jumpToStore(
          jumpMode: JumpMode.detailPage,
          appleId: wechatAppleID,
        );
        break;
      case 5:
        // 显示更新对话框，这里以微信为例
        await showUpgradeDialog<void>(
          context,
          upgradeConfig: UpgradeConfig(
            title: '发现新版本V8.8.8.414174360',
            content: '1.修复已知Bug\n2.优化软件性能，提升用户体验效果\n3.更多新功能等待您的探索',
          ),
          iOSUpgradeConfig: IosUpgradeConfig(appleId: wechatAppleID),
          androidUpgradeConfig: AndroidUpgradeConfig(androidMarket: AndroidMarket.allTrue),
        );
        break;
      default:
        break;
    }
  }

  /// 操作系统描述
  static String get operatingSystem {
    if (Platform.isAndroid) {
      return 'Android';
    } else if (Platform.isIOS) {
      return 'iOS';
    } else if (Platform.isWindows) {
      return 'Windows';
    } else if (Platform.isMacOS) {
      return 'macOS';
    } else if (Platform.isLinux) {
      return 'Linux';
    } else if (Platform.isFuchsia) {
      return 'Fuchsia OS';
    } else if (kIsWeb) {
      return 'Web';
    }

    return '';
  }
}