Flutter应用升级插件upgrade的使用

Flutter应用升级插件upgrade的使用

1. Preparation

您需要提供一个服务器，该服务器提供版本配置文件（App Version Config File）查询和下载安装文件的服务。例如，可以使用以下链接提供的升级服务器：Upgrade Server

2. Config Before Use

Android

1. 创建 file_provider_path.xml 文件，并添加以下内容：

<?xml version="1 .0 " encoding="utf-8"?>
<paths>
    <files-path name="files" path="/" />
    <cache-path name="cache" path="/" />
    <external-path name="external" path="/" />
    <external-cache-path name="cache" path="/" />
    <external-files-path name="files" path="/" />
</paths>

1. 在 android/app/src/main/AndroidManifest.xml 中添加以下权限：

<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="your.package">
    <uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

    <application>
        <provider
            android:authorities="${applicationId}.fileProvider"
            android:name="androidx.core.content.FileProvider"
            android:exported="false"
            android:grantUriPermissions="true">
            <meta-data
                android:name="android.support.FILE_PROVIDER_PATHS"
                android:resource="@xml/file_provider_path"/>
        </provider>
    </application>
</manifest>

MacOS

在 .entitlements 文件中设置以下属性：

<dict>
    <key>com.apple.security.network.client</key>
    <true/>
    <key>com.apple.security.files.downloads.read-write</key>
    <true/>
</dict>

3. Create Version Config File (Appcast) at Local to Mark Current App’s Version

创建一个版本配置文件（Appcast Item），例如在 AppcastItem。

4. Init Plugin in Suitable Places

初始化插件：

void main() {
  UpgradeManager.instance.init(
      url: 'http://localhost:8000/appcast/latest', // 升级服务器 URL
      currentVersionPath: 'assets/version/version.json', 
  );

  runApp(const MyApp());
}

5. Download if Need and Install

如何使用？请参阅 UpgradeManager

// 下载更新
UpgradeManager.instance.download()

// 安装更新
UpgradeManager.instance.install()

示例代码

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

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

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const MaterialApp(
      home: HomePage(),
    );
  }
}

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

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

class _HomePageState extends State<HomePage> {

  [@override](/user/override)
  void initState() {
    super.initState();
    UpgradeManager.instance.init(
      url: 'http://localhost:8000/appcast/latest',
      currentVersionPath: 'assets/version/version.json',
    );
  }

  double progress = 0;

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Plugin example app'),
      ),
      body: Stack(
        children: [
          Align(
            alignment: Alignment.topLeft,
            child: CustomUpgradeView(
              builder: (context, state) =&gt; _buildAppcastItemInfo(title: "Upgrade Current Version", item: state.current),
            ),
          ),
          Align(
            alignment: Alignment.bottomLeft,
            child: CustomUpgradeView(
              builder: (context, state) =&gt; _buildAppcastItemInfo(title: "Upgrade Latest Version", item: state.latest),
            ),
          ),
          Align(
            alignment: Alignment.bottomRight,
            child: Padding(
              padding: const EdgeInsets.symmetric(vertical: 16, horizontal: 24),
              child: CustomUpgradeStatusIndicator(
                builder: (context, status) {
                  return Text(status.name);
                },
              ),
            ),
          ),
          Align(
            alignment: Alignment.topRight,
            child: Padding(
              padding: const EdgeInsets.symmetric(vertical: 16, horizontal: 24),
              child: Column(
                mainAxisSize: MainAxisSize.min,
                crossAxisAlignment: CrossAxisAlignment.start,
                children: [
                  const Text("Download Progress"),
                  Padding(
                    padding: const EdgeInsets.only(top: 16),
                    child: SizedBox(
                      width: 256,
                      child: LinearProgressIndicator(value: progress, minHeight: 8,),
                    ),
                  ),
                ],
              ),
            ),
          ),
          Align(
            alignment: Alignment.center,
            child: Column(
              mainAxisSize: MainAxisSize.min,
              children: [
                GestureDetector(
                  onTap: () =&gt; UpgradeManager.instance.checkForUpdates(),
                  child: const Padding(
                    padding: EdgeInsets.symmetric(vertical: 16, horizontal: 24),
                    child: Text("Check for Updates"),
                  ),
                ),
                GestureDetector(
                  onTap: () =&gt; UpgradeManager.instance.download(onReceiveProgress: (received, total, _) {
                    setState(() {
                      progress = received / total;
                    });
                  }),
                  child: const Padding(
                    padding: EdgeInsets.symmetric(vertical: 16, horizontal: 24),
                    child: Text("Download"),
                  ),
                ),
                GestureDetector(
                  onTap: () =&gt; UpgradeManager.instance.install(),
                  child: const Padding(
                    padding: EdgeInsets.symmetric(vertical: 16, horizontal: 24),
                    child: Text("Install"),
                  ),
                )
              ],
            ),
          )
        ],
      ),
    );
  }

  Widget _buildAppcastItemInfo({required String title, AppcastItem? item}) {
    if (item == null) {
      return Text("$title: null", style: const TextStyle(fontWeight: FontWeight.bold));
    }
    return Column(
      mainAxisSize: MainAxisSize.min,
      crossAxisAlignment: CrossAxisAlignment.start,
      children: [
        Text("$title: ", style: const TextStyle(fontWeight: FontWeight.bold)),
        Text("releaseNotes: ${item.releaseNotes}"),
        Text("version: ${item.version.toString()}"),
        Text("displayVersionString: ${item.displayVersionString}"),
        Text("os: ${item.os}"),
        Text("minimumSystemVersion: ${item.minimumSystemVersion}"),
        Text("maximumSystemVersion: ${item.maximumSystemVersion}"),
      ],
    );
  }
}