• 自定义提示弹窗主题

• 使用系统弹窗提示

Demo 更新后台服务

由于 github 最近访问比较慢，如果需要更好地体验 XUpdate，你可以点击自己搭建一个简易的版本更新服务。

Demo 下载

---

2、快速集成指南

---

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

2.1、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’

}

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 字段属性

| 字段名 | 类型 | 默认值 | 备注 |

| — | — | — | — |

| 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 | 是否在通知栏上显示下载进度 |

2.4、文件加密校验方式

本框架默认使用的文件加密校验方法是 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方法设置即可生效。

---

3、版本更新

---

3.1、默认版本更新

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

XUpdate.newBuild(getActivity())

.updateUrl(mUpdateUrl)

.update();

需要注意的是，使用默认版本更新，请求服务器返回的 json 格式应包括如下内容：

{

“Code”: 0, //0 代表请求成功，非 0 代表失败

“Msg”: “”, //请求出错的信息

“UpdateStatus”: 1, //0 代表不更新，1 代表有版本更新，不需要强制升级，2

《Android学习笔记总结+最新移动架构视频+大厂安卓面试真题+项目实战源码讲义》

【docs.qq.com/doc/DSkNLaERkbnFoS0ZF】 完整内容开源分享

代表有版本更新，需要强制升级

“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 加密。

}

3.2、自动版本更新

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

XUpdate.newBuild(getActivity())

.updateUrl(mUpdateUrl)

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

.update();

3.3、强制版本更新

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

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

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

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

• themeColor: 设置主题颜色（升级/安装按钮的背景色）

• topResId: 弹窗的标题背景的资源图片

XUpdate.newBuild(getActivity())

.updateUrl(mUpdateUrl)

.themeColor(ResUtils.getColor(R.color.update_theme_color))

.topResId(R.mipmap.bg_update_top)

.update();

3.5、自定义版本更新解析器

实现 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.6、自定义版本更新检查器+版本更新解析器+版本更新提示器

• 实现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 one rror(Throwable throwable) {

HProgressDialogUtils.cancel();

}

});

}

})

.setNegativeButton(“暂不升级”, null)

.setCancelable(false)

.create()

.show();

}

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

XUpdate.newBuild(getActivity())

.apkCacheDir(PathUtils.getExtDownloadsPath()) //设置下载缓存的根目录

.build()

.download(mDownloadUrl, new OnFileDownloadListener() { //设置下载的地址和下载的监听

@Override