【r_upgrade】快来升级你的Flutter应用

image

介绍

在移动开发过程中,应用升级是必不可少的一个环节,所以,r_upgrade应用升级插件就出现了,这里先鼓掌欢迎👏👏,下面是使用介绍

r_upgrade

Android和IOS的升级应用插件==Flutter应用升级插件

  • 网页链接形式升级
  • apk下载形式升级使用Service或者DownloadManager
  • 跳转到应用商店升级
  • Android热更新
  • Android增量升级

开始吧

1.使用插件:

pubspec.yaml文件添加下面代码

dependencies:
  r_upgrade: last version

2.使用打开链接的方式进行更新(AndroidIOS通用)

    void upgradeFromUrl()async{
        bool isSuccess =await RUpgrade.upgradeFromUrl(
                    'https://www.baidu.com',
                  );
        print(isSuccess);
    }

Android平台

1.跳转到应用商店升级

    void upgradeFromAndroidStore(){
       bool isSuccess = await RUpgrade.upgradeFromAndroidStore(AndroidStore.BAIDU);
       print('${isSuccess?'跳转成功':'跳转失败'}');
    }

2.通过下载链接进行apk下载

注意,在Android应用中,请确保AndroidManifest.xml中声明以下权限,并在6.0系统上进行动态授权,不然会调用升级方法将抛出权限异常

    <uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />
    <uses-permission android:name="android.permission.INTERNET"/>
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>

1.添加升级下载进度监听

RUpgrade.stream.listen((DownloadInfo info){
  ///...
});

info 里包含的信息如下:

字段 含义
(int) id 当前下载任务的id
(int) max_length 所需下载的总大小 (bytes)
(int) current_length 当前已下载的大小 (bytes)
(double) percent 当前下载进度(0-100)
(double) planTime 计划下载完成所需时间/秒 (需要.toStringAsFixed(0))
(String) path 当前下载的文件路径
(double) speed 当前下载的速度kb/s
(DownloadStatus) status 当前下载状态
STATUS_PAUSED 下载已暂停
STATUS_PENDING等待下载
STATUS_RUNNING下载中
STATUS_SUCCESSFUL下载成功
STATUS_FAILED下载失败
STATUS_CANCEL下载取消

注意: 部分http下载链接可能返回 max_length = -1,请自行判断

2.立即升级你的应用

目前分为两部分
useDownloadManager:

  • true: 调用系统的DownloadManager进行下载
    • 优势:接入简单,无需担心操作,下载全由系统管理
    • 劣势:无法使用http方式进行下载,无法在下载过程中点击通知栏进行暂停,无法根据有无网络进行暂停和继续下载,适配机型问题等
    • 支持的方法:RUpgrade.streaminstallcancel
  • false: 调用Service进行下载(默认使用)
    • 优势:功能较全,支持http/https下载,支持网络断开后自动暂停下载,连接上后继续下载,支持断点续传,支持查询最后一次下载等
    • 劣势:暂无发现,如果发现bug欢迎提issue.
    • 支持的方法:默认全部
    // [isAutoRequestInstall] 下载完成后自动弹出安装
    // [apkName] 安装包的名字(需要包含.apk)
    // [notificationVisibility] 通知栏显示方式
    // [useDownloadManager] 是否使用DownloadManager,默认不使用(DownloadManager不支持http下载,下载手动暂停,断点续传等,不建议使用)
    // [upgradeFlavor] 升级的口味,默认全量升级(默认)
    void upgrade() async {
      int id = await RUpgrade.upgrade(
                 'https://raw.githubusercontent.com/rhymelph/r_upgrade/master/apk/app-release.apk',
                 apkName: 'app-release.apk',isAutoRequestInstall: true);
    }

新增升级的口味:(不支持使用DownloadManager下载)

enum RUpgradeFlavor {
  normal, // 全量升级
  hotUpgrade, // 热更新
  incrementUpgrade, // 增量升级
}

3. 取消下载

    void cancel() async {
      bool isSuccess=await RUpgrade.cancel(id);
    }

4. 安装应用

    void install() async {
      bool isSuccess=await RUpgrade.install(id);
    }

5. 暂停下载

    void pause() async {
      bool isSuccess=await RUpgrade.pause(id);
    }

6. 继续下载

    void pause() async {
      bool isSuccess=await RUpgrade.upgradeWithId(id);
      // 返回 false 即表示从来不存在此ID
      // 返回 true
      //    调用此方法前状态为 [STATUS_PAUSED]、[STATUS_FAILED]、[STATUS_CANCEL],将继续下载
      //    调用此方法前状态为 [STATUS_RUNNING]、[STATUS_PENDING],不会发生任何变化
      //    调用此方法前状态为 [STATUS_SUCCESSFUL],将会安装应用
      // 当文件被删除时,重新下载
    }

7. 获取最后一次下载的ID

该方法只会寻找当前应用版本名和版本号下下载过的ID

    void getLastUpgradeId() async {
     int id = await RUpgrade.getLastUpgradedId();
    }

8. 获取ID对应的下载状态

    void getDownloadStatus()async{
    DownloadStatus status = await RUpgrade.getDownloadStatus(id);
   }

9. 增量升级

  • 1.下载bsdiff工具到本地
  • 2.准备两个安装包,一个是即将需要升级的安装包(old.apk)、一个是你需要更新的安装包(new.apk)
  • 3.在命令行切换到上面下载的bsdiff目录下,运行命令./bsdiff old.apk new.apk increment.patch
  • 4.将上面生成的increment.patch上传到服务器
  • 5.调用RUpgrade.upgrade(...,upgradeFlavor:RUpgradeFlavor.incrementUpgrade)方法进行下载,即可
  • 6.调用RUpgrade.install(id)进行安装

代码如下:

    int id;
    void incrementUpgrade(){
        id = await RUpgrade.upgrade(
                'https://mydata-1252536312.cos.ap-guangzhou.myqcloud.com/r_upgrade.patch',
                fileName: 'r_upgrade.patch',
                useDownloadManager: false,
                isAutoRequestInstall: false,
                upgradeFlavor: RUpgradeFlavor.incrementUpgrade,
              );
    }

    void install(){
        try {
            await RUpgrade.install(id);
        } catch (e) {
            _state.currentState
                .showSnackBar(SnackBar(content: Text('增量更新失败!')));
        }
    }

10. 热更新

  • 你可以使用升级返回的id进行热更新,下载的文件需要将新版本生成的isolate_snapshot_datakernel_blob.binvm_snapshot_data打进zip文件中下载
    步骤:
    • 运行 flutter clean 清理build文件
    • 运行 flutter build bundle 生成需要的产物,下面标记星号为必须文件
|- AssetManifest.json
|- FontManifest.json
|- fonts
    |- ...
|- isolate_snapshot_data *
|- kernel-blob.bin       *
|- LICENSE
|- packages
    |- ...
|- vm_snapshot_data      *
- 将标记星号的文件打包成zip文件,上传到服务器
- 调用`RUpgrade.upgrade(...,upgradeFlavor:RUpgradeFlavor.hotUpgrade)`方法进行下载
- 下载完成后,将上面获取到的id进行热更新,调用如下代码
           bool isSuccess = await RUpgrade.install(id);
           if (isSuccess) {
              _state.currentState
                    .showSnackBar(SnackBar(content: Text('热更新成功,3s后退出应用,请重新进入')));
                Future.delayed(Duration(seconds: 3)).then((_){
                  SystemNavigator.pop(animated: true);
                });
           }else{
              _state.currentState
                    .showSnackBar(SnackBar(content: Text('热更新失败,请等待更新包下载完成')));
              }
- 重启应用即可

注意:目前热更新尚处于测试阶段,只支持Flutter代码的变更,不支持资源文件等,热更新造成的一切的后果插件的作者概不负责,由使用者承担。

安卓平台通知栏

如果你想自定义通知栏显示的内容, 可以这样做, 修改或添加文件路径为project/android/app/main/res/r_upgrade_value.xml,添加下面代码

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string name="r_upgrade_download_speech">%.2fkb/s</string>
    <string name="r_upgrade_download_planTime">预计%.0f秒后完成</string>
    <string name="r_upgrade_download_finish">下载完成</string>
    <string name="r_upgrade_download_paused">下载被暂停</string>
    <string name="r_upgrade_download_failed">下载失败</string>
</resources>

然后.当你使用upgrade方法时,你应该设置参数notificationStyle,默认为显示预计完成时间.

/// Notification show style about content text
enum NotificationStyle {
  speechAndPlanTime, // 100kb/s 预计1秒后完成
  planTimeAndSpeech, // 预计1秒后完成 100kb/s
  speech,// 100kb/s
  planTime, // 预计1秒后完成
  none, //
}

IOS平台

1.跳转到AppStore进行更新

    void upgradeFromAppStore() async {
        bool isSuccess =await RUpgrade.upgradeFromAppStore(
                '您的AppId',//例如:微信的AppId:414478124
              );
        print(isSuccess);
    }

2.获取AppStore中你的应用最后的版本名

    void getVersionFromAppStore() async {
        String versionName = await RUpgrade.getVersionFromAppStore(
                '您的AppId',//例如:微信的AppId:414478124
               );
        print(versionName);
    }

结尾:Dart客栈已经推出Aqueduct框架系列教程专辑,欢迎喜欢学习Dart语言开发的小伙伴关注👏👏

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,736评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,167评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,442评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,902评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,302评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,573评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,847评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,562评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,260评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,531评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,021评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,367评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,016评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,068评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,827评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,610评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,514评论 2 269