Flutter应用更新管理插件update_helper的使用

update_helper 是一个帮助你更轻松地控制更新对话框的Flutter插件。它还支持强制用户更新以继续使用应用程序的功能。

插件功能

• 控制更新对话框。
• 支持强制更新。
• 可配置的更新信息和日志。
• 自定义对话框支持。

示例截图

使用方法

版本格式

版本号必须为 major.minor.patch 格式，例如 1.0.0。

简单用法

import 'package:flutter/material.dart';
import 'package:update_helper/update_helper.dart';

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: HomeScreen(),
    );
  }
}

class HomeScreen extends StatefulWidget {
  @override
  _HomeScreenState createState() => _HomeScreenState();
}

class _HomeScreenState extends State<HomeScreen> {
  final updateHelper = UpdateHelper.instance;

  @override
  void initState() {
    super.initState();
    WidgetsBinding.instance.addPostFrameCallback((_) async {
      await updateHelper.initial(
        context: context,
        updateConfig: UpdateConfig(
          defaultConfig: UpdatePlatformConfig(latestVersion: '3.0.0'),
        ),
        // forceUpdate: true, // 如果需要强制更新，请取消注释此行
      );
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Update Helper Example'),
      ),
      body: Center(
        child: Text('Check your console for update dialog logs.'),
      ),
    );
  }
}

高级用法

final latestVersion = '1.0.0';
final bannedVersions = ['<=0.9.0'];

final updateHelper = UpdateHelper.instance;

await updateHelper.initial(
    context: context,
    updateConfig: UpdateConfig(
        defaultConfig: UpdatePlatformConfig(latestVersion: latestVersion),
    ),
    title: 'Update',
    content: 'A new version is available!\n\n'
        'Current version: %currentVersion\n'
        'Latest version: %latestVersion\n\n'
        'Would you like to update?',
    bannedVersions: bannedVersions,
    onlyShowDialogWhenBanned: false,
    forceUpdateContent: 'A new version is available!\n\n'
        'Current version: %currentVersion\n'
        'Latest version: %latestVersion\n\n'
        'Please update to continue using the app.',
    changelogsText: 'Changelogs',
    changelogs: [
        'Improve performances', 
        'Minor bugfixes',
    ],
    failToOpenStoreError:'Got an error when trying to open the Store, '
        'please update the app manually. '
        '\nSorry for the inconvenience.\n(Logs: %error)',
);

自定义对话框

await updateHelper.initial(
    context: context,
    updateConfig: UpdateConfig(
        defaultConfig: UpdatePlatformConfig(latestVersion: latestVersion),
    ),
    dialogBuilder: (context, config) {
        return AlertDialog.adaptive(
              title: const Text('Update'),
              content: const Text(
                  'This is a custom dialog.\n\nWould you like to update?'),
              actions: [
                TextButton(
                    onPressed: config.onOkPressed, child: const Text('OK')),
                TextButton(
                  onPressed: config.onLaterPressed,
                  child: Text(
                    'Later',
                    style: TextStyle(color: Theme.of(context).disabledColor),
                  ),
                ),
              ],
        );
    }
);

其他功能

打开应用商店

UpdateHelper.openStore();

注意事项

• %currentVersion 和 %latestVersion 会被替换为实际版本号。
• forceUpdate 和 bannedVersions 不可同时使用。
• onlyShowDialogWhenBanned: 仅在当前版本被禁止或 forceUpdate 为 true 时显示更新对话框。
• 更多关于 bannedVersions 的使用请参考 satisfied_version 插件。
• changelogsText 和 changelogs 用于显示变更日志。
• 当无法打开应用商店时，会显示错误日志，可以通过 failToOpenStoreError 参数自定义错误信息。

以上是 update_helper 插件的基本使用方法及示例代码，希望能帮助你在Flutter应用中更好地实现应用更新管理功能。