XUpdate

XUpdate是一个轻量级、高可用性的Android版本更新框架。

本框架充分解耦版本更新的各个环节，将版本更新中的各部分环节抽离出来，这样可最大化地提高框架的可用性和灵活性。同时，为了方便使用，又提供了一套比较通用的默认实现方式，并对Android6.0、7.0、8.0、9.0进行了兼容性适配，最大程度上帮助大家快速实现版本更新功能。

特征

• 支持post和get两种版本检查方式，支持自定义网络请求。
• 支持设置只在wifi下进行版本更新。
• 支持静默下载（后台更新）、自动版本更新。
• 提供界面友好的版本更新提示弹窗，可自定义其主题样式。
• 支持自定义版本更新检查器、版本更新解析器、版本更新提示器、版本更新下载器、版本更新安装、出错处理。
• 支持MD5文件校验、版本忽略、版本强制更新等功能。
• 支持自定义文件校验方法【默认是MD5校验】。
• 支持自定义请求API接口。
• 兼容Android6.0、7.0、8.0和9.0。
• 支持中文和英文两种语言显示（国际化）

组成结构

本框架借鉴了AppUpdate中的部分思想和UI界面，将版本更新中的各部分环节抽离出来，形成了如下几个部分：

• 版本更新检查器IUpdateChecker：检查是否有最新版本。
• 版本更新解析器IUpdateParser：解析服务端返回的数据结果。
• 版本更新提示器IUpdatePrompter：展示最新的版本信息。
• 版本更新下载器IUpdateDownloader：下载最新的版本APK安装包。
• 网络请求服务接口IUpdateHttpService：定义了进行网络请求的相关接口。

除此之外，还有两个监听器：

• 版本更新失败的监听器OnUpdateFailureListener。
• 版本更新apk安装的监听器OnInstallListener。

更新调度核心：

• 版本更新业务代理IUpdateProxy：负责版本更新的流程控制，调用update开始进行版本更新流程。

更新流程

调用update之后的流程：

IUpdateProxy/XUpdate --- (update) ---> IUpdateChecker --->（请求服务器，获取最新版本信息）---> IUpdateParser ---> (解析服务器返回的数据，并构建UpdateEntity版本更新实体）---> IUpdateProxy ---> (如无最新版本，直接结束，否则进行下面流程）
 ---自动模式---> IUpdateDownloader ---> （下载最新的应用apk） ---> 安装应用
 ---非自动模式---> IUpdatePrompter ---> 给出版本更新的提示
 ---> 用户点击更新 ---> IUpdateDownloader ---> （下载最新的应用apk） ---> 跳转到应用安装界面
 ---> 用户点击（取消或忽略） ---> 结束

快速集成指南

目前支持主流开发工具AndroidStudio的使用，直接配置build.gradle，增加依赖即可.

Android Studio导入方法，添加Gradle依赖

1.先在项目根目录的 build.gradle 的 repositories 添加:

allprojects {
 repositories {
 ...
 maven { url "https://jitpack.io" }
 }
}

2.然后在dependencies添加:

dependencies {
 ...
 implementation 'com.github.xuexiangjys:XUpdate:1.1.1'
}

初始化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) {
 //实现日志记录功能
 }
});

版本更新实体信息

(1) UpdateEntity字段属性

(2) DownloadEntity字段属性

文件加密校验方式

本框架默认使用的文件加密校验方法是MD5加密方式，当然如果你不想使用MD5加密，你也可以自定义文件加密器IFileEncryptor,以下是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));
 }
}

最后再调用XUpdate.get().setIFileEncryptor方法设置即可生效。

默认版本更新

直接调用如下代码即可完成版本更新操作：

XUpdate.newBuild(getActivity())
 .updateUrl(mUpdateUrl)
 .update();

需要注意的是，使用默认版本更新，请求服务器返回的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是否完整，每次都会重新下载。框架默认使用的是md5加密。
}

自动版本更新

自动版本更新：自动检查版本 + 自动下载apk + 自动安装apk（静默安装）。 只需要设置isAutoMode(true),不过如果设备没有root权限的话，是无法做到完全的自动更新（因为静默安装需要root权限）。

XUpdate.newBuild(getActivity())
 .updateUrl(mUpdateUrl)
 .isAutoMode(true) //如果需要完全无人干预，自动更新，需要root权限【静默安装需要】
 .update();

强制版本更新

就是用户不更新的话，程序将无法正常使用。只需要服务端返回UpdateStatus字段为2即可。

当然如果你自定义请求返回api的话，只需要设置UpdateEntity的mIsForce字段为true即可。

自定义版本更新提示弹窗的主题

可设置弹窗的标题背景和按钮颜色。

• themeColor: 设置主题颜色（升级/安装按钮的背景色）
• topResId: 弹窗的标题背景的资源图片

XUpdate.newBuild(getActivity())
 .updateUrl(mUpdateUrl)
 .themeColor(ResUtils.getColor(R.color.update_theme_color))
 .topResId(R.mipmap.bg_update_top)
 .update();

自定义版本更新解析器

实现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;
 }
}

自定义版本更新检查器+版本更新解析器+版本更新提示器

• 实现IUpdateChecker接口即可实现检查器的自定义。
• 实现IUpdateParser接口即可实现解析器的自定义。
• 实现IUpdatePrompter接口即可实现提示器的自定义。

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();
 }

只使用XUpdate的下载器功能进行apk的下载

XUpdate.newBuild(getActivity())
 .apkCacheDir(PathUtils.getExtDownloadsPath()) //设置下载缓存的根目录
 .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();
 }
 });

只使用XUpdate的APK安装的功能

_XUpdate.startInstallApk(getContext(), FileUtils.getFileByPath(PathUtils.getFilePathByUri(getContext(), data.getData()))); //填写文件所在的路径

如果你的apk安装与众不同，你可以实现自己的apk安装器。你只需要实现OnInstallListener接口，并通过XUpdate.setOnInstallListener进行设置即可生效。

混淆配置

-keep class com.xuexiang.xupdate.entity.** { *; }

更多使用方法可以查看官方文档

演示

开源地址：

https://github.com/xuexiangjys/XUpdate

更多更优质的资讯，请关注我，你的支持会鼓励我不断分享更多更好的优质文章。