Flutter应用安装插件easy_app_installer的使用

easy_app_installer简介

easy_app_installer为Flutter提供简便的应用内升级功能，主要支持以下功能：

• 下载并安装apk（仅支持 Android）
• 取消下载中的任务（仅支持 Android）
• 仅安装apk（仅支持 Android）
• 跳转到应用市场-指定应用详情页（支持Android与iOS）
• 跳转到设置-应用详情页（支持Android与iOS）

效果演示可以查看这里，更多英文文档请参考这里。

配置 - Android

FileProvider配置

1. 在android/app/src/main/res下新建xml文件夹，并在其中创建file_provider_path.xml文件，内容如下：

<?xml version="1.0" encoding="utf-8"?>
<paths xmlns:android="http://schemas.android.com/apk/res/android">
    <root-path name="root" path="."/>
    <files-path name="files" path="."/>
    <cache-path name="cache" path="."/>
    <external-path name="external" path="."/>
    <external-cache-path name="external_cache" path="."/>
    <external-files-path name="external_file" path="."/>
</paths>

1. 打开android/app/src/main/AndroidManifest.xml文件，在application标签下添加：

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

示例文件可参考这里。

使用

安装

安装插件请参考官方文档。

功能使用说明

1. 下载并安装apk

此功能适用于Android平台。首次同意’允许安装应用’权限可能会导致应用进程关闭，这是系统行为，Android 12已经修复了这个问题。

示例代码：

String _cancelTag = "";

EasyAppInstaller.instance.downloadAndInstallApk(
    fileUrl: "https://xxxx.apk",
    fileDirectory: "updateApk",
    fileName: "new.apk",
    downloadListener: (progress) {
        if (progress < 100) {
            EasyLoading.showProgress(progress / 100, status: "下载中");
        } else {
            EasyLoading.showSuccess("下载成功");
        }
    },
    cancelTagListener: (cancelTag) {
        _cancelTag = cancelTag;
    },
    stateListener: (newState, attachParam) {
        _handleDownloadStateChanged(newState, attachParam);
    }
);

2. 取消下载中的任务

示例代码：

EasyAppInstaller.instance.cancelDownload(_cancelTag);

3. 仅安装apk

示例代码：

await EasyAppInstaller.instance.installApk(filePath);

4. 跳转到应用市场-指定应用页面

仅支持Android平台。

示例代码：

await EasyAppInstaller.instance.openAppMarket();

5. 跳转到AppStore-指定应用页面

仅支持iOS平台。

示例代码：

EasyAppInstaller.instance.openAppStore(appId: "${appId}");

6. 跳转到设置-应用详情页

支持Android和iOS平台。

示例代码：

await EasyAppInstaller.instance.openAppSettingDetails(applicationPackageName: "$targetAppPackage");

类说明

下载状态

enum EasyAppInstallerState {
    //准备下载 (该状态回调在获取到权限之后)
    onPrepared,
    //下载中
    onDownloading,
    //下载成功
    onSuccess,
    //下载失败
    onFailed,
    //取消下载
    onCanceled
}

示例Demo

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

import 'package:flutter/services.dart';
import 'package:easy_app_installer/easy_app_installer.dart';
import 'package:flutter_dotenv/flutter_dotenv.dart';
import 'package:flutter_easyloading/flutter_easyloading.dart';

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

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';

  String _cancelTag = "";
  String _apkFilePath = "";
  String _currentDownloadStateCH = "当前下载状态：还未开始";

  @override
  void initState() {
    super.initState();
    initData();
  }

  Future<void> initData() async {
    String platformVersion;
    try {
      platformVersion = await EasyAppInstaller.instance.platformVersion ??
          'Unknown platform version';
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }
    if (!mounted) return;

    setState(() {
      _platformVersion = platformVersion;
    });
    await dotenv.load(fileName: "assets/testdata.env");
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      builder: EasyLoading.init(),
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
          child: Column(
            mainAxisSize: MainAxisSize.min,
            children: [
              Text(_currentDownloadStateCH),
              _buildButton("打开AppStore", () async {
                final appId = dotenv.get("IOS_APP_ID", fallback: "");
                final openAppStoreResult =
                    await EasyAppInstaller.instance.openAppStore(appId);
                print("gfs openAppStoreResult: $openAppStoreResult");
              }),
              _buildButton('下载并安装apk', () {
                downloadAndInstalApk();
              }),
              _buildButton('取消下载任务', () {
                if (_cancelTag.isNotEmpty) {
                  EasyLoading.dismiss();
                  EasyAppInstaller.instance.cancelDownload(_cancelTag);
                } else {
                  EasyLoading.showError("没有下载中的任务");
                }
              }),
              _buildButton('仅安装', () async {
                final path =
                    await EasyAppInstaller.instance.installApk(_apkFilePath);
                print("gfs installApk: $path");
              }),
              _buildButton('打开应用市场', () {
                EasyAppInstaller.instance.openAppMarket();
              }),
              _buildButton('打开设置详情页', () async {
                final openResult =
                    await EasyAppInstaller.instance.openAppSettingDetails();
                print("gfs openResult: $openResult");
              }),
            ],
          ),
        ),
      ),
    );
  }

  void downloadAndInstalApk() async {
    //fileUrl需替换为指定apk地址
    await EasyAppInstaller.instance.downloadAndInstallApk(
        fileUrl: dotenv.get("APK_URL", fallback: ""),
        fileDirectory: "updateApk",
        fileName: "newApk.apk",
        explainContent: "快去开启权限！！！",
        onDownloadingListener: (progress) {
          if (progress < 100) {
            EasyLoading.showProgress(progress / 100, status: "下载中");
          } else {
            EasyLoading.showSuccess("下载成功");
          }
        },
        onCancelTagListener: (cancelTag) {
          _cancelTag = cancelTag;
        },
        onStateListener: (newState, attachParam) {
          _handleDownloadStateChanged(newState, attachParam);
        });
  }

  /// 处理下载状态更改
  void _handleDownloadStateChanged(
      EasyAppInstallerState newState, String? attachParam) {
    switch (newState) {
      case EasyAppInstallerState.onPrepared:
        _currentDownloadStateCH = "当前下载状态：开始下载";
        break;
      case EasyAppInstallerState.onDownloading:
        _currentDownloadStateCH = "当前下载状态：下载中";
        break;
      case EasyAppInstallerState.onSuccess:
        if (attachParam != null) {
          _currentDownloadStateCH = "当前下载状态：下载成功, $attachParam";
          _apkFilePath = attachParam;
        }
        break;
      case EasyAppInstallerState.onFailed:
        _currentDownloadStateCH = "当前下载状态：下载失败, $attachParam";
        break;
      case EasyAppInstallerState.onCanceled:
        _currentDownloadStateCH = "当前下载状态：取消下载";
        break;
    }
    setState(() {});
  }

  Widget _buildButton(String text, Function function) {
    return MaterialButton(
      color: Colors.blue,
      child: Text(
        text,
        style: const TextStyle(color: Colors.white),
      ),
      onPressed: () {
        function();
      },
    );
  }

  @override
  void dispose() {
    EasyAppInstaller.instance.dispose();
    super.dispose();
  }
}

通过上述内容，您可以更好地理解和使用easy_app_installer插件来实现Flutter应用内的升级功能。希望这些信息对您有所帮助！