一个轻量级、高可用性的Android版本更新框架。赶紧点击使用说明文档，体验一下吧！
在提issue前，请先阅读【提问的智慧】，并严格按照issue模板进行填写，节约大家的时间。
在使用前，请一定要仔细阅读使用说明文档,重要的事情说三遍！！！
在使用前，请一定要仔细阅读使用说明文档,重要的事情说三遍！！！
在使用前，请一定要仔细阅读使用说明文档,重要的事情说三遍！！！
为了方便大家快速集成X系列框架库，我提供了一个空壳模版供大家参考使用: https://github.com/xuexiangjys/TemplateAppProject
-
支持post和get两种版本检查方式，支持自定义网络请求。
-
支持设置只在wifi下进行版本更新。
-
支持静默下载（后台更新）、自动版本更新。
-
提供界面友好的版本更新提示弹窗，可自定义其主题样式。
-
支持自定义版本更新检查器、版本更新解析器、版本更新提示器、版本更新下载器、版本更新安装、出错处理。
-
支持MD5文件校验、版本忽略、版本强制更新等功能。
-
支持自定义文件校验方法【默认是MD5校验】。
-
支持自定义请求API接口。
-
兼容Android6.0、7.0、8.0和9.0。
-
支持中文和英文两种语言显示（国际化）。
-
支持Flutter插件使用：flutter_xupdate。
-
支持React-Native插件使用：react-native-xupdate。
本框架借鉴了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） ---> 跳转到应用安装界面
---> 用户点击（取消或忽略） ---> 结束
- 默认版本更新
- 强制版本更新
- 自定义提示弹窗主题
- 使用系统弹窗提示
由于github最近访问比较慢，如果需要更好地体验XUpdate，你可以点击自己搭建一个简易的版本更新服务。
蒲公英下载的密码: xuexiangjys
目前支持主流开发工具AndroidStudio的使用，直接配置build.gradle，增加依赖即可.
1.先在项目根目录的 build.gradle 的 repositories 添加:
allprojects {
repositories {
...
maven { url "https://jitpack.io" }
}
}
2.然后在dependencies添加:
dependencies {
...
implementation 'com.github.xuexiangjys:XUpdate:1.1.4'
}
在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字段属性
| 字段名 | 类型 | 默认值 | 备注 |
|---|---|---|---|
| mHasUpdate | boolean | false | 是否有新版本 |
| mIsForce | boolean | false | 是否强制安装：不安装无法使用app |
| mIsIgnorable | boolean | false | 是否可忽略该版本 |
| mVersionCode | int | 0 | 最新版本code |
| mVersionName | String | unknown_version | 最新版本名称 |
| mUpdateContent | String | "" | 更新内容 |
| mDownloadEntity | DownloadEntity | ／ | 下载信息实体 |
| mIsSilent | boolean | false | 是否静默下载：有新版本时不提示直接下载 |
| mIsAutoInstall | boolean | true | 是否下载完成后自动安装 |
(2) DownloadEntity字段属性
| 字段名 | 类型 | 默认值 | 备注 |
|---|---|---|---|
| mDownloadUrl | String | "" | 下载地址 |
| mCacheDir | String | "" | 文件下载的目录 |
| mMd5 | String | "" | 下载文件的加密校验值(默认使用md5加密)，用于校验，防止下载的apk文件被替换（最新演示demo中有计算校验值的工具） |
| mSize | long | 0 | 下载文件的大小【单位：KB】 |
| mIsShowNotification | boolean | false | 是否在通知栏上显示下载进度 |
本框架默认使用的文件加密校验方法是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即可。
可设置弹窗的标题背景和按钮颜色。
- promptThemeColor: 设置主题颜色（升级/安装按钮的背景色）
- promptTopResId: 弹窗的标题背景的资源图片
- promptWidthRatio: 弹窗宽度占屏幕宽度的比例，默认是-1，不做约束
- promptHeightRatio: 弹窗高度占屏幕高度的比例，默认是-1，不做约束
XUpdate.newBuild(getActivity())
.updateUrl(mUpdateUrl)
.themeColor(ResUtils.getColor(R.color.update_theme_color))
.topResId(R.mipmap.bg_update_top)
.promptWidthRatio(0.7F)
.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.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.startInstallApk(getContext(), FileUtils.getFileByPath(PathUtils.getFilePathByUri(getContext(), data.getData()))); //填写文件所在的路径
如果你的apk安装与众不同，你可以实现自己的apk安装器。你只需要实现OnInstallListener接口，并通过XUpdate.setOnInstallListener进行设置即可生效。
-keep class com.xuexiang.xupdate.entity.** { *; }
//注意，如果你使用的是自定义Api解析器解析，还需要给你自定义Api实体配上混淆，如下是本demo中配置的自定义Api实体混淆规则：
-keep class com.xuexiang.xupdatedemo.entity.** { *; }
https://github.com/WVector/AppUpdate
你的打赏是我维护的动力，我将会列出所有打赏人员的清单在下方作为凭证，打赏前请留下打赏项目的备注！
感谢下面小伙伴的打赏：
| 姓名 | 金额 | 方式 |
|---|---|---|
| *天 | 100￥ | 微信 |
