Flutter应用版本更新插件playx_version_update的使用

Playx Version Update

Playx Version Update 插件让您能够轻松管理应用程序更新，为用户提供无缝体验。您可以轻松通知用户有关新更新的信息，提供灵活或立即更新选项，并自定义更新过程。

功能

• 更新对话框：通过 Android 的 Material Design 对话框和 iOS 的 Cupertino 对话框告知用户新版本的应用。
• Google Play 集成：直接从您的应用程序中启动灵活或立即更新。
• 可定制的 UI：显示包含发行说明和最低版本要求的自定义更新界面。
• 应用内更新页面：在应用程序内部展示更新信息和选项，以实现无缝用户体验。

安装

在 pubspec.yaml 文件中的 dependencies 下添加以下内容：

dependencies:
  playx_version_update: ^0.1.0

要求

• 目前仅支持 Android 和 iOS 平台。
• Flutter >=3.19.0
• Dart >=3.3.0 <4.0.0
• Android compileSDK 34
• 最低 Android SDK 版本为 23
• Java 17
• Android Gradle Plugin >=8.3.0
• Gradle wrapper >=8.4

使用方法

显示更新对话框

以下是用于显示更新对话框的代码示例：

final result = await PlayxVersionUpdate.showUpdateDialog(
  context: context,
  showReleaseNotes: false,
  googlePlayId: 'other app id',
  minVersion: '1.0.0',
  title: (info) => 'A new update is available',
  forceUpdate: true,
  showPageOnForceUpdate: true,
  isDismissible: false,
  onCancel: (info) {
    final forceUpdate = info.forceUpdate;
    if (forceUpdate) {
      exit(0);
    }
  },
);

result.when(success: (isShowed) {
  print('showUpdateDialog success :');
}, error: (error) {
  print('showUpdateDialog error : ${error.message}');
});

应用内更新

对于 Android 和 iOS，可以使用以下代码来显示应用内更新对话框：

final result = await PlayxVersionUpdate.showInAppUpdateDialog(
  context: context,
  type: PlayxAppUpdateType.flexible,
  appStoreId: 'app bundle id',
  showReleaseNotes: true,
  releaseNotesTitle: (info) => 'Recent Updates of ${info.newVersion}',
  onIosUpdate: (info, launchMode) async {
    final storeUrl = info.storeUrl;
    final res = await PlayxVersionUpdate.openStore(storeUrl: storeUrl);
    res.when(success: (success) {
      print('playx_open_store: success :$success');
    }, error: (error) {
      print('playx_open_store: error :$error');
    });
  },
);

result.when(success: (isShowed) {
  print('showInAppUpdateDialog success : $isShowed');
}, error: (error) {
  print('showInAppUpdateDialog error : $error ${error.message}');
});

检查版本并创建自定义UI

您可以通过 PlayxVersionUpdate.checkVersion 方法检查 Google Play 或 App Store 中的应用版本，并根据需要创建自定义 UI。例如，我们可以显示 PlayxUpdatePage 来展示应用更新信息：

final result = await PlayxVersionUpdate.checkVersion(
  localVersion: '1.0.0',
  newVersion: '1.1.0',
  forceUpdate: true,
  googlePlayId: 'your app package name',
  appStoreId: 'your app bundle id',
  country: 'us',
  language: 'en',
);

result.when(success: (info) {
  Navigator.push(
    context,
    MaterialPageRoute<void>(
      builder: (BuildContext context) => PlayxUpdatePage(
        versionUpdateInfo: info,
        showReleaseNotes: false,
        showDismissButtonOnForceUpdate: false,
        leading: Image.network('image url'),
        title: (info) => "It's time to update",
        description: (info) =>
            'A new version of the app is now available.\nThe app needs to be updated to the latest version in order to work properly.\nEnjoy the latest version features now.',
      ),
    ),
  );
}, error: (error) {
  // handle the error that happened here.
});

最小应用版本

您可以在 Google Play 或 App Store 的描述末尾添加 [Minimum Version :1.0.0] 来设置最小版本。这将强制用户更新到指定版本。

Google Play 应用内更新

立即更新

立即更新会占用整个屏幕，用户必须更新并重启应用才能继续使用。适用于对应用核心功能至关重要的更新。

final result = await PlayxVersionUpdate.startImmediateUpdate();
result.when(success: (isSucceeded) {
  // 用户接受并成功更新
}, error: (error) {
  print('an error occurred :${error.message}');
});

灵活更新

灵活更新允许用户在后台下载更新时继续与应用交互。

final result = await PlayxVersionUpdate.startFlexibleUpdate();
result.when(success: (isStarted) {
  // 用户接受了更新
}, error: (error) {
  print('an error occurred :${error.message}');
});

监听灵活更新状态

您可以监听 listenToFlexibleDownloadUpdate 流来监控更新进度。

void listenToFlexibleDownloadUpdates() {
  downloadInfoStreamSubscription =
      PlayxVersionUpdate.listenToFlexibleDownloadUpdate().listen((info) {
    if (info == null) return;
    if (info.status == PlayxDownloadStatus.downloaded) {
      completeFlexibleUpdate();
    } else if (info.status == PlayxDownloadStatus.downloading) {
      print('current download in progress : bytes downloaded:${info.bytesDownloaded} total bytes to download : ${info.totalBytesToDownload}');
    }
  });
}

完成灵活更新

当检测到 PlayxDownloadStatus.downloaded 状态时，需要重启应用以安装更新。

Future<void> completeFlexibleUpdate() async {
  final snackBar = SnackBar(
    content: const Text('An update has just been downloaded.'),
    action: SnackBarAction(
        label: 'Restart',
        onPressed: () async {
          final result = await PlayxVersionUpdate.completeFlexibleUpdate();
          result.when(success: (isCompleted) {
            print('completeFlexibleUpdate isCompleted : $isCompleted');
          }, error: (error) {
            print('completeFlexibleUpdate error has happened: ${error.message}');
          });
        }),
    duration: const Duration(seconds: 10),
  );
  globalKey.currentState?.showSnackBar(snackBar);
}

重要提示

应用内更新仅在应用从 Google Play 下载时有效。要测试应用内更新，可以使用 Google Play 内部应用共享 或 内部测试。

文档和参考

• In-app updates，Google Play 应用内更新 SDK。
• new_version_plus 包

示例代码

完整的示例代码可以在 GitHub 上找到。