自2018年我开源了XUpdate之后,至今已迭代了14个版本,月下载量达7k+,Github的star量也已经有1.1k+.
最近在研究Flutter,于是就随手写了一个Flutter小项目练练手,在写的时候我就发现,目前并没有非常好用的版本更新Flutter插件,尝试了使用Bugly的版本更新Flutter插件,但是效果非常不好.然后百度了一下,基本上都是如下方案:
package_info
插件获取当前应用的版本信息dio
插件进行网络请求获取最新版本信息flutter_downloader
插件下载最新APP并安装我想了一下,这实在是太麻烦了,要知道我的XUpdate把这些都已经做好了,只需要一行代码就可以实现应用内的版本更新,不仅如此我们完全没必要把这个几乎通用的功能在自己的应用内再实现一遍.
为此我仔细研究了一下Flutter的插件开发,用了不到1天的时间,就把XUpdate的绝大多数功能在Flutter插件上实现了,这下我就可以舒舒服服地使用一行代码来实现版本更新了!
下面我给出flutter_xupdate
插件的地址:
https://pub.dev/packages/flutter_xupdate
在你的flutter项目中的pubspec.yaml
文件中添加flutter_xupdate
依赖.
dependencies:
flutter_xupdate: ^1.0.0
dependencies:
flutter_xupdate:
git:
url: git://github.com/xuexiangjys/flutter_xupdate.git
ref: master
修改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更新");
}
}
混淆配置文件可参考混淆配置样例。如果不开启混淆的话可以忽略.
# XUpdate需要配置的内容
#gson
-keepattributes Signature
-keep class sun.misc.Unsafe { *; }
-keep class com.google.gson.** { *; }
-keep class com.google.gson.examples.android.model.** { *; }
# xupdate
-keep class com.xuexiang.xupdate.entity.** { *; }
{
"Code": 0, //0代表请求成功,非0代表失败
"Msg": "", //请求出错的信息
"UpdateStatus": 1, //0代表不更新,1代表有版本更新,不需要强制升级,2代表有版本更新,需要强制升级
"VersionCode": 3, //编译版本号(唯一)
"VersionName": "1.0.2", //版本名(用于展示)
"ModifyContent": "1、优化api接口。\r\n2、添加使用demo演示。\r\n3、新增自定义更新服务API接口。\r\n4、优化更新提示界面。", //更新内容
"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);
FlutterXUpdate.checkUpdate(url: _updateUrl, supportBackgroundUpdate: true);
FlutterXUpdate.checkUpdate(url: _updateUrl, widthRatio: 0.6);
FlutterXUpdate.checkUpdate(url: _updateUrl, isAutoMode: true);
FlutterXUpdate.checkUpdate(
url: _updateUrl,
overrideGlobalRetryStrategy: true,
enableRetry: true,
retryContent: "Github下载速度太慢了,是否考虑切换蒲公英下载?",
retryUrl: "https://www.pgyer.com/flutter_learn");
1.定义一个自定义的版本更新解析器
FlutterXUpdate.setCustomParseHandler(onUpdateParse: (String json) async {
//这里是自定义json解析
return customParseJson(json);
});
///将自定义的json内容解析为UpdateEntity实体类
UpdateEntity customParseJson(String json) {
AppInfo appInfo = AppInfo.fromJson(json);
return UpdateEntity(
hasUpdate: appInfo.hasUpdate,
isIgnorable: appInfo.isIgnorable,
versionCode: appInfo.versionCode,
versionName: appInfo.versionName,
updateContent: appInfo.updateLog,
downloadUrl: appInfo.apkUrl,
apkSize: appInfo.apkSize);
}
2.调用checkUpdate
方法,并设置isCustomParse
参数为true.
FlutterXUpdate.checkUpdate(url: _updateUrl3, isCustomParse: true);
///直接传入UpdateEntity进行更新提示
void checkUpdate8() {
FlutterXUpdate.updateByInfo(updateEntity: customParseJson(_customJson));
}
目前只支持主题色和顶部图片的自定义
1.配置顶部图片的资源路径, 路径: android/app/src/main/res/values/drawable
, 千万不要放到mipmap
文件下,否则资源将找不到。例如:
2.调用checkUpdate
方法,并设置themeColor
、 topImageRes
和 buttonTextColor
参数。
///自定义更新弹窗样式
void customPromptDialog() {
FlutterXUpdate.checkUpdate(url: _updateUrl, themeColor: '#FFFFAC5D', topImageRes: 'bg_update_top', buttonTextColor: '#FFFFFFFF');
}
Name | Type | Default | Description |
---|---|---|---|
debug | bool | false | 是否输出日志 |
isPost | bool | false | 是否使用post请求 |
isPostJson | bool | false | post请求是否是上传json |
isWifiOnly | bool | true | 是否只在wifi下才能进行更新 |
isAutoMode | bool | false | 是否开启自动模式 |
supportSilentInstall | bool | false | 是否支持静默安装,这个需要设备有root权限 |
enableRetry | bool | false | 在下载过程中,如果点击了取消的话,是否弹出切换下载方式的重试提示弹窗 |
retryContent | String | '' | 重试提示弹窗的提示内容 |
retryUrl | String | '' | 重试提示弹窗点击后跳转的url |
params | Map | / | 需要设置的公共参数 |
Name | Type | Default | Description |
---|---|---|---|
url | String | / | 版本检查的地址 |
params | Map | / | 传递的参数 |
supportBackgroundUpdate | bool | false | 是否支持后台更新 |
isAutoMode | bool | false | 是否开启自动模式 |
isCustomParse | bool | false | 是否是自定义解析协议 |
themeColor | String | '' | 应用弹窗的主题色 |
topImageRes | String | '' | 应用弹窗的顶部图片资源名 |
buttonTextColor | String | '' | 按钮文字的颜色 |
widthRatio | double | / | 版本更新提示器宽度占屏幕的比例, 不设置的话不做约束 |
heightRatio | double | / | 版本更新提示器高度占屏幕的比例, 不设置的话不做约束 |
overrideGlobalRetryStrategy | bool | false | 是否覆盖全局的重试策略 |
enableRetry | bool | false | 在下载过程中,如果点击了取消的话,是否弹出切换下载方式的重试提示弹窗 |
retryContent | String | '' | 重试提示弹窗的提示内容 |
retryUrl | String | '' | 重试提示弹窗点击后跳转的url |
flutter build apk --release
打出来的包却不能正常更新?答:这里建议不要使用flutter build apk --release
进行打包。因为原生的组件使用需要配置混淆,目前使用flutter build apk --release
命令打包的话,混淆配置并不会生效(因为该指令默认使用的是R8压缩,会有问题)。
这里有三个方法可以解决:
flutter build apk --no-shrink
指令代替。android
目录下,修改gradle.properties
如下:org.gradle.jvmargs=-Xmx1536M
# 开启D8压缩
android.enableD8=true
android.useAndroidX=true
android.enableJetifier=true
# 关闭R8压缩
#android.enableR8=true
./gradlew assembleRelease
命令进行打包。答:
ndk {
abiFilters 'armeabi', 'armeabi-v7a'
// , 'arm64-v8a'
}
Code:5000, msg:安装APK失败!(apk文件校验不通过!)
呢?答:这里需要说明的是,这里填写的MD5值是APK文件进行MD5加密后的值,并不是对APK签名的MD5。框架默认使用的是MD5加密,如果你觉得不够安全,也可以使用其他加密方式,不过这可能涉及到原生的编码,详情参见:自定义文件加密校验器.
如果不想使用MD5的话就不需要配置这个字段,不过这样每次检查的话都会去重新下载APK,建议配置。
安装
按钮后一直提示更新失败呢?答:出现这种问题的情况有很多种。
错误码 | 备注 |
---|---|
2000 | 查询更新失败 |
2001 | 没有wifi |
2002 | 没有网络 |
2003 | 正在进行版本更新 |
2004 | 无最新版本 |
2005 | 版本检查返回空 |
2006 | 版本检查返回json解析失败 |
2007 | 已经被忽略的版本 |
2008 | 应用下载的缓存目录为空 |
3000 | 版本提示器异常错误 |
3001 | 版本提示器所在Activity页面被销毁 |
4000 | 新应用安装包下载失败 |
4001 | 读写权限申请失败 |
4002 | 取消下载 |
5000 | apk安装失败 |
5100 | 未知错误 |
本文分享自 我的Android开源之旅 微信公众号,前往查看
如有侵权,请联系 cloudcommunity@tencent.com 删除。
本文参与 腾讯云自媒体同步曝光计划 ,欢迎热爱写作的你一起参与!