背景
前段时间我写了一篇介绍我的一个开源我的项目XUpdate的博客: 史上最好用的Android全量版本更新库XUpdate使用指南, 收到了大家广泛的认可,但与此同时也有人向我反馈了不少倡议,比如说:
- 是否提供一个一键可应用的库?
- 是否反对断点续传下载性能?
出于以上的倡议, 同时也是为了可能更加欠缺我的XUpdate生态圈,于是我抽出一点工夫,简略地实现了一个XUpdate拓展库 XUpdateAPI, 我的项目的地址如下:
https://github.com/xuexiangjys/XUpdateAPI
我的项目介绍
为了不便大家更快地应用XUpdate, 升高集成的难度,我编写了这个配套的拓展库。本库目前蕴含如下两局部内容:
- EasyUpdate: 提供疾速接入XUpdate的性能,无需初始化便可间接应用。
- AriaDownloader: 提供断点续传下载的性能。
集成指南
增加Gradle依赖
1.先在我的项目根目录的 build.gradle 的 repositories 增加:
allprojects { repositories { ... maven { url "https://jitpack.io" } } }
2.而后在dependencies增加:
implementation 'com.github.xuexiangjys:XUpdate:2.0.6' implementation 'com.github.xuexiangjys:XUpdateAPI:xupdate-easy:1.0.0' // 如果须要应用断点续传下载性能的话增加该依赖(可选) implementation 'com.github.xuexiangjys:XUpdateAPI:xupdate-downloader-aria:1.0.0'
3.自定义初始化配置(可选)
因为本库采取了主动初始化的性能,因而你无需进行初始化,然而如果你须要自定义初始化配置的话,你能够实现IUpdateConfigProvider
,并在Application
的attachBaseContext
前调用EasyUpdate.setUpdateConfigProvider
办法设置自定义配置。
@Override protected void attachBaseContext(Context base) { // 实现自定义配置 EasyUpdate.setUpdateConfigProvider(new CustomUpdateConfigProvider()); super.attachBaseContext(base); }
4.开启断点续传下载性能(可选)
- 办法一: 在自定义配置中设置下载代理
UpdateConfig.create() // 开启断点续传下载性能 .setDownloadServiceProxy(new AriaDownloadServiceProxyImpl(context))
- 办法二: 应用
AriaDownloader.enable
开启
AriaDownloader.enable(this);
- 办法三: 应用
AriaDownloader.getUpdateHttpService
获取下载服务
EasyUpdate.create(getContext(), Constants.UPDATE_DEFAULT_URL) .updateHttpService(AriaDownloader.getUpdateHttpService(getContext()))
注意事项
须要留神的是,在应用EasyUpdate
的时候,务必保障服务器返回的json格局应包含如下内容:
{ "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 "ApkMd5": "..." //md5值没有的话,就无奈保障apk是否残缺,每次都会从新下载。 }
如果你不想应用默认的json格局的话,可参考XUpdate中如何自定义版本更新解析器
应用办法
EasyUpdate次要提供了如下两个办法:
- EasyUpdate.create: 构建版本更新查看管理者
- EasyUpdate.checkUpdate: 间接版本更新
具体应用参见 EasyUpdateFragment。
当然XUpdate的所有办法也都是反对的,具体能够参考XUpdate的应用阐明.
混同配置
- XUpdate
-keep class com.xuexiang.xupdate.entity.** { *; } //留神,如果你应用的是自定义Api解析器解析,还须要给你自定义Api实体配上混同,如下是本demo中配置的自定义Api实体混同规定: -keep class com.xuexiang.xupdatedemo.entity.** { *; }
- AriaDownloader
-dontwarn com.arialyy.aria.** -keep class com.arialyy.aria.**{*;} -keep class **$$DownloadListenerProxy{ *; } -keep class **$$UploadListenerProxy{ *; } -keep class **$$DownloadGroupListenerProxy{ *; } -keep class **$$DGSubListenerProxy{ *; } -keepclasseswithmembernames class * { @Download.* <methods>; @Upload.* <methods>; @DownloadGroup.* <methods>; }
配套设置
- XUpdate外围库: https://github.com/xuexiangjys/XUpdate
- 后盾版本更新治理服务: https://github.com/xuexiangjys/XUpdateService
- 后盾版本更新管理系统: https://github.com/xuexiangjys/xupdate-management
- Flutter插件: https://github.com/xuexiangjys/flutter_xupdate
- React-Native插件: https://github.com/xuexiangjys/react-native-xupdate
联系方式
更多资讯内容,欢送扫描关注我的集体微信公众号:【我的Android开源之旅】