在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
开源软件名称:XUpdate开源软件地址:https://gitee.com/xuexiangjys/XUpdate开源软件介绍:XUpdate英文 | 中文 | 视频教程一个轻量级、高可用性的Android版本更新框架。赶紧点击使用说明文档,体验一下吧! 在提issue前,请先阅读【提问的智慧】,并严格按照issue模板进行填写,节约大家的时间。 在使用前,请一定要仔细阅读使用说明文档,重要的事情说三遍!!! 在使用前,请一定要仔细阅读使用说明文档,重要的事情说三遍!!! 在使用前,请一定要仔细阅读使用说明文档,重要的事情说三遍!!! 关于我
简化使用想要更快地使用XUpdate,降低集成的难度,支持断点续传下载等拓展功能,可以尝试使用XUpdateAPI. X系列库快速集成为了方便大家快速集成X系列框架库,我提供了一个空壳模版供大家参考使用: https://github.com/xuexiangjys/TemplateAppProject 特征
Star趋势图组成结构本框架借鉴了AppUpdate中的部分思想和UI界面,将版本更新中的各部分环节抽离出来,形成了如下几个部分:
除此之外,还有两个监听器:
更新调度核心:
更新流程调用update之后的流程: IUpdateProxy/XUpdate --- (update) ---> IUpdateChecker --->(请求服务器,获取最新版本信息)---> IUpdateParser ---> (解析服务器返回的数据,并构建UpdateEntity版本更新实体)---> IUpdateProxy ---> (如无最新版本,直接结束,否则进行下面流程) ---自动模式---> IUpdateDownloader ---> (下载最新的应用apk) ---> 安装应用 ---非自动模式---> IUpdatePrompter ---> 给出版本更新的提示 ---> 用户点击更新 ---> IUpdateDownloader ---> (下载最新的应用apk) ---> 跳转到应用安装界面 ---> 用户点击(取消或忽略) ---> 结束 1、演示(请star支持)
Demo更新后台服务由于github最近访问比较慢,如果需要更好地体验XUpdate,你可以点击自己搭建一个简易的版本更新服务。 Demo下载蒲公英下载
Github下载2、快速集成指南
2.1、Android Studio导入方法,添加Gradle依赖1.先在项目根目录的 build.gradle 的 repositories 添加: allprojects { repositories { ... maven { url "https://jitpack.io" } }} 2.然后在dependencies添加: 以下是版本说明,选择一个即可。
dependencies { ... // androidx版本 implementation 'com.github.xuexiangjys:XUpdate:2.1.1'}
dependencies { ... // support版本 implementation 'com.github.xuexiangjys:XUpdate:1.1.6'} 2.2、初始化XUpdate在Application进行初始化配置: XUpdate.get() .debug(true) .isWifiOnly(true) //默认设置只在wifi下检查版本更新 .isGet(true) //默认设置使用get请求检查版本 .isAutoMode(false) //默认设置非自动模式,可根据具体使用配置 .param("versionCode", UpdateUtils.getVersionCode(this)) //设置默认公共请求参数 .param("appKey", getPackageName()) .setOnUpdateFailureListener(new OnUpdateFailureListener() { //设置版本更新出错的监听 @Override public void onFailure(UpdateError error) { if (error.getCode() != CHECK_NO_NEW_VERSION) { //对不同错误进行处理 ToastUtils.toast(error.toString()); } } }) .supportSilentInstall(true) //设置是否支持静默安装,默认是true .setIUpdateHttpService(new OKHttpUpdateHttpService()) //这个必须设置!实现网络请求功能。 .init(this); //这个必须初始化 【注意】:如果出现任何问题,可开启debug模式来追踪问题。如果你还需要将日志记录在磁盘上,可实现以下接口 XUpdate.get().setILogger(new ILogger() { @Override public void log(int priority, String tag, String message, Throwable t) { //实现日志记录功能 }}); 2.3、版本更新实体信息(1) UpdateEntity字段属性
(2) DownloadEntity字段属性
(3) PromptEntity字段属性
2.4、文件加密校验方式本框架默认使用的文件加密校验方法是MD5加密方式,当然如果你不想使用MD5加密,你也可以自定义文件加密器 /** * 默认的文件加密计算使用的是MD5加密 * * @author xuexiang * @since 2019-09-06 14:21 */public class DefaultFileEncryptor implements IFileEncryptor { /** * 加密文件 * * @param file * @return */ @Override public String encryptFile(File file) { return Md5Utils.getFileMD5(file); } /** * 检验文件是否有效(加密是否一致) * * @param encrypt 加密值, 如果encrypt为空,直接认为是有效的 * @param file 需要校验的文件 * @return 文件是否有效 */ @Override public boolean isFileValid(String encrypt, File file) { return TextUtils.isEmpty(encrypt) || encrypt.equalsIgnoreCase(encryptFile(file)); }} 最后再调用 3、版本更新3.1、默认版本更新直接调用如下代码即可完成版本更新操作: XUpdate.newBuild(getActivity()) .updateUrl(mUpdateUrl) .update(); 需要注意的是,使用默认版本更新,请求服务器返回的json格式应包括如下内容: { "Code": 0, "Msg": "", "UpdateStatus": 1, "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": ""} 字段说明:
3.2、自动版本更新自动版本更新:自动检查版本 + 自动下载apk + 自动安装apk(静默安装)。只需要设置 XUpdate.newBuild(getActivity()) .updateUrl(mUpdateUrl) .isAutoMode(true) //如果需要完全无人干预,自动更新,需要root权限【静默安装需要】 .update(); 3.3、支持后台更新开启支持后台更新后, 用户点击“后台更新”按钮后,就可以进入到后台更新,不用一直在更新界面等待. XUpdate.newBuild(getActivity()) .updateUrl(mUpdateUrl) .supportBackgroundUpdate(true) .update(); 3.4、强制版本更新就是用户不更新的话,程序将无法正常使用。只需要服务端返回 当然如果你自定义请求返回api的话,只需要设置 3.5、自定义版本更新提示弹窗的主题通过设置更新顶部图片、主题色、按钮文字颜色、宽高比率等来实现自定义主题样式.
XUpdate.newBuild(getActivity()) .updateUrl(mUpdateUrl) .promptThemeColor(ResUtils.getColor(R.color.update_theme_color)) .promptButtonTextColor(Color.WHITE) .promptTopResId(R.mipmap.bg_update_top) .promptWidthRatio(0.7F) .update(); 3.6、自定义版本更新解析器实现IUpdateParser接口即可实现解析器的自定义。 XUpdate.newBuild(getActivity()) .updateUrl(mUpdateUrl3) .updateParser(new CustomUpdateParser()) //设置自定义的版本更新解析器 .update();public class CustomUpdateParser implements IUpdateParser { @Override public UpdateEntity parseJson(String json) throws Exception { CustomResult result = JsonUtil.fromJson(json, CustomResult.class); if (result != null) { return new UpdateEntity() .setHasUpdate(result.hasUpdate) .setIsIgnorable(result.isIgnorable) .setVersionCode(result.versionCode) .setVersionName(result.versionName) .setUpdateContent(result.updateLog) .setDownloadUrl(result.apkUrl) .setSize(result.apkSize); } return null; }} 3.7、自定义版本更新检查器+版本更新解析器+版本更新提示器
XUpdate.newBuild(getActivity()) .updateUrl(mUpdateUrl3) .updateChecker(new DefaultUpdateChecker() { @Override public void onBeforeCheck() { super.onBeforeCheck(); CProgressDialogUtils.showProgressDialog(getActivity(), "查询中..."); } @Override public void onAfterCheck() { super.onAfterCheck(); CProgressDialogUtils.cancelProgressDialog(getActivity()); } }) .updateParser(new CustomUpdateParser()) .updatePrompter(new CustomUpdatePrompter(getActivity())) .update();public class CustomUpdatePrompter implements IUpdatePrompter { private Context mContext; public CustomUpdatePrompter(Context context) { mContext = context; } @Override public void showPrompt(@NonNull UpdateEntity updateEntity, @NonNull IUpdateProxy updateProxy, @NonNull PromptEntity promptEntity) { showUpdatePrompt(updateEntity, updateProxy); } /** * 显示自定义提示 * * @param updateEntity * @param updateProxy */ private void showUpdatePrompt(final @NonNull UpdateEntity updateEntity, final @NonNull IUpdateProxy updateProxy) { String updateInfo = UpdateUtils.getDisplayUpdateInfo(mContext, updateEntity); new AlertDialog.Builder(mContext) .setTitle(String.format("是否升级到%s版本?", updateEntity.getVersionName())) .setMessage(updateInfo) .setPositiveButton("升级", new DialogInterface.OnClickListener() { @Override public void onClick(DialogInterface dialog, int which) { updateProxy.startDownload(updateEntity, new OnFileDownloadListener() { @Override public void onStart() { HProgressDialogUtils.showHorizontalProgressDialog(mContext, "下载进度", false); } @Override public void onProgress(float progress, long total) { HProgressDialogUtils.setProgress(Math.round(progress * 100)); } @Override public boolean onCompleted(File file) { HProgressDialogUtils.cancel(); return true; } @Override public void onError(Throwable throwable) { HProgressDialogUtils.cancel(); } }); } }) .setNegativeButton("暂不升级", null) .setCancelable(false) .create() .show(); } 3.8、只使用XUpdate的下载器功能进行apk的下载XUpdate.newBuild(getActivity()) .apkCacheDir(PathUtils.getAppExtCachePath()) //设置下载缓存的根目录 .build() .download(mDownloadUrl, new OnFileDownloadListener() { //设置下载的地址和下载的监听 @Override public void onStart() { HProgressDialogUtils.showHorizontalProgressDialog(getContext(), "下载进度", false); } @Override public void onProgress(float progress, long total) { HProgressDialogUtils.setProgress(Math.round(progress * 100)); } @Override public boolean onCompleted(File file) { HProgressDialogUtils.cancel(); ToastUtils.toast("apk下载完毕,文件路径:" + file.getPath()); return false; } @Override public void onError(Throwable throwable) { HProgressDialogUtils.cancel(); } }); 3.9、只使用XUpdate的APK安装的功能_XUpdate.startInstallApk(getContext(), FileUtils.getFileByPath(PathUtils.getFilePathByUri(getContext(), data.getData()))); //填写文件所在的路径 如果你的apk安装与众不同,你可以实现自己的apk安装器。你只需要实现OnInstallListener接口,并通过 3.10、国际化配置由于作者水平有限, 目前只支持中文和英文两种语言的显示【默认语言是英语】。需要支持其他语言的,只需要在自己项目的 需要翻译的详细内容参见 xupdate_strings.xml 文件。 什么?你还不会Android的多语言配置?建议你看一下这篇文章:Android项目国际化多国语言适配 混淆配置-keep class com.xuexiang.xupdate.entity.** { *; }//注意,如果你使用的是自定义Api解析器解析,还需要给你自定义Api实体配上混淆,如下是本demo中配置的自定义Api实体混淆规则:-keep class com.xuexiang.xupdatedemo.entity.** { *; } 相关链接
特别感谢https://github.com/WVector/AppUpdate 如果觉得项目还不错,可以考虑打赏一波
感谢下面小伙伴的打赏:
公众号
联系方式 |
请发表评论