flutter_xupdate 一键实现Flutter应用版本更新

时间 2020-02-12

标签 flutter xupdate 一键实现应用版本更新繁體版

原文原文链接

前言

自2018年我开源了XUpdate以后,至今已迭代了14个版本,月下载量达4k+,Github的star量也已经有700+.android

最近在研究Flutter,因而就随手写了一个Flutter小项目练练手,在写的时候我就发现,目前并无很是好用的版本更新Flutter插件,尝试了使用Bugly的版本更新Flutter插件,可是效果很是很差.而后百度了一下,基本上都是以下方案:ios

1.使用package_info插件获取当前应用的版本信息
2.使用dio插件进行网络请求获取最新版本信息
3.使用flutter_downloader插件下载最新APP并安装

我想了一下,这实在是太麻烦了,要知道个人XUpdate把这些都已经作好了,只须要一行代码就能够实现应用内的版本更新,不只如此咱们彻底不必把这个几乎通用的功能在本身的应用内再实现一遍.git

为此我仔细研究了一下Flutter的插件开发,用了不到1天的时间,就把XUpdate的绝大多数功能在Flutter插件上实现了,这下我就能够舒舒服服地使用一行代码来实现版本更新了!github

下面我给出flutter_xupdate插件的地址:json

pub.dev/packages/fl…api

演示

默认版本更新
支持后台更新
屏幕宽高比限制显示更新
强制更新

快速集成指南

添加引用依赖

在你的flutter项目中的pubspec.yaml文件中添加flutter_xupdate依赖.bash

方法一: pub集成

dependencies:
  flutter_xupdate: ^0.0.1
复制代码

方法二: github集成

dependencies:
  flutter_xupdate:
    git:
      url: git://github.com/xuexiangjys/flutter_xupdate.git
      ref: master
复制代码

Android设置

修改Android项目的主题为AppCompat主题，文件路径: android/app/src/main/res/values/styles.xml, 例如:微信

<resources>
    <style name="LaunchTheme" parent="Theme.AppCompat.Light.NoActionBar">
        <item name="android:windowBackground">@drawable/launch_background</item>
    </style>
</resources>
复制代码

初始化

调用FlutterXUpdate.init方法进行初始化.
调用FlutterXUpdate.setErrorHandler方法设置错误监听.

import 'package:flutter_xupdate/flutter_xupdate.dart';

   ///初始化
   void initXUpdate() {
     if (Platform.isAndroid) {
       FlutterXUpdate.init(
         ///是否输出日志
         debug: true,
         ///是否使用post请求
         isPost: false,
         ///post请求是不是上传json
         isPostJson: false,
         ///是否开启自动模式
         isWifiOnly: false,
         ///是否开启自动模式
         isAutoMode: false,
         ///须要设置的公共参数
         supportSilentInstall: false,
         ///在下载过程当中，若是点击了取消的话，是否弹出切换下载方式的重试提示弹窗
         enableRetry: false
       ).then((value) {
         updateMessage("初始化成功: $value");
       }).catchError((error) {
         print(error);
       });

       FlutterXUpdate.setErrorHandler(
           onUpdateError: (Map<String, dynamic> message) async {
         print(message);
         setState(() {
           _message = "$message";
         });
       });
     } else {
       updateMessage("ios暂不支持XUpdate更新");
     }
   }
复制代码

使用说明

版本更新返回的Json格式

{
  "Code": 0, //0表明请求成功，非0表明失败
  "Msg": "", //请求出错的信息
  "UpdateStatus": 1, //0表明不更新，1表明有版本更新，不须要强制升级，2表明有版本更新，须要强制升级
  "VersionCode": 3, //编译版本号(惟一)
  "VersionName": "1.0.2", //版本名(用于展现)
  "ModifyContent": "一、优化api接口。\r\n二、添加使用demo演示。\r\n三、新增自定义更新服务API接口。\r\n四、优化更新提示界面。", //更新内容
  "DownloadUrl": "https://raw.githubusercontent.com/xuexiangjys/XUpdate/master/apk/xupdate_demo_1.0.2.apk",// 文件下载地址
  "ApkSize": 2048, //文件的大小(单位:kb)
  "ApkMd5": "..."  //md5值没有的话，就没法保证apk是否完整，每次都会从新下载。框架默认使用的是md5加密。
}
复制代码

版本更新

默认更新

FlutterXUpdate.checkUpdate(url: _updateUrl);
复制代码

默认App更新 + 支持后台更新

FlutterXUpdate.checkUpdate(url: _updateUrl, supportBackgroundUpdate: true);
复制代码

调整宽高比显示的版本更新

FlutterXUpdate.checkUpdate(url: _updateUrl, widthRatio: 0.6);
复制代码

自动模式下版本更新, 若是须要彻底无人干预，自动更新，须要root权限【静默安装须要】

FlutterXUpdate.checkUpdate(url: _updateUrl, isAutoMode: true);
复制代码

下载时点击取消容许切换下载方式

FlutterXUpdate.checkUpdate(
      url: _updateUrl,
      overrideGlobalRetryStrategy: true,
      enableRetry: true,
      retryContent: "Github下载速度太慢了，是否考虑切换蒲公英下载？",
      retryUrl: "https://www.pgyer.com/flutter_learn");
复制代码