README.md · Yimi178/XUpdate

# XUpdate

[![](https://jitpack.io/v/xuexiangjys/XUpdate.svg)](https://jitpack.io/#xuexiangjys/XUpdate)
[![api](https://img.shields.io/badge/API-14+-brightgreen.svg)](https://android-arsenal.com/api?level=14)
[![I](https://img.shields.io/github/issues/xuexiangjys/XUpdate.svg)](https://github.com/xuexiangjys/XUpdate/issues)
[![Star](https://img.shields.io/github/stars/xuexiangjys/XUpdate.svg)](https://github.com/xuexiangjys/XUpdate)

## [English](./README.md) | [Chinese](./README_ZH.md) ｜ [Video tutorial](https://space.bilibili.com/483850585/channel/detail?cid=164280)

A lightweight, high availability Android version update framework. Click [instruction document](https://github.com/xuexiangjys/XUpdate/wiki) to experience it！

Please read [【wisdom of asking questions】](https://xuexiangjys.blog.csdn.net/article/details/83344235) before raising the issue and strictly follow the [issue template](https://github.com/xuexiangjys/XUpdate/issues/new/choose) fill in and save everyone's time.

Please read the [instruction document](https://github.com/xuexiangjys/XUpdate/wiki) carefully before use, important things are to be repeated for three time!!！

## About me

| WeChat public number   | juejin     |  zhihu    |  CSDN   |   jianshu   |   segmentfault  |   bilibili  |   toutiao
|---------|---------|--------- |---------|---------|---------|---------|---------|
| [我的Android开源之旅](https://ss.im5i.com/2021/06/14/6tqAU.png)  |  [Click me](https://juejin.im/user/598feef55188257d592e56ed/posts)    |   [Click me](https://www.zhihu.com/people/xuexiangjys/posts)       |   [Click me](https://xuexiangjys.blog.csdn.net/)  |   [Click me](https://www.jianshu.com/u/6bf605575337)  |   [Click me](https://segmentfault.com/u/xuexiangjys)  |   [Click me](https://space.bilibili.com/483850585)  |   [Click me](https://img.rruu.net/image/5ff34ff7b02dd)

## Simplify use

If you want to use xupdate faster, reduce the difficulty of integration, support breakpoint continuation download and other expansion functions, you can try to use [XUpdateAPI](https://github.com/xuexiangjys/XUpdateAPI).

## Rapid integration of X-Library

In order to facilitate the rapid integration of X-Library, I provide a template project for your reference: [https://github.com/xuexiangjys/TemplateAppProject](https://github.com/xuexiangjys/TemplateAppProject)

---

## Features

* It supports `Post` or `Get` request to check version, and supports user-defined network requests.

* Only version update under WiFi is supported。

* Support silent download (background update) and automatic version update.

* The user-friendly version update prompt pop-up window is provided to customize the theme style.

* It supports user-defined version update checker, parser, prompter, downloader, install listener and error listener.

* Support MD5 file verification, version ignore, version forced update and other functions.

* It supports the user-defined file verification method【MD5 verification by default】.

* Support custom request API interface.

* Compatible with Android 6.0 ~ 11.0.

* Support Chinese and English language (internationalization).

* Support the use of the flutter plugin：[flutter_xupdate](https://github.com/xuexiangjys/flutter_xupdate)。

* Support the use of react native plugin：[react-native-xupdate](https://github.com/xuexiangjys/react-native-xupdate)。

## Stargazers over time

[![Stargazers over time](https://starchart.cc/xuexiangjys/XUpdate.svg)](https://starchart.cc/xuexiangjys/XUpdate)

## Composition structure

This framework refers to [AppUpdate](https://github.com/WVector/AppUpdate) some ideas and UI, the various parts of the version update are separated to form the following parts:

* `IUpdateChecker`: Check for the latest version.

* `IUpdateParser`: Parsing the data results returned by the server.

* `IUpdatePrompter`: Display the latest version information.

* `IUpdateDownloader`: Download the latest version of APK installation package.

* `IUpdateHttpService`: The interface for network request.

In addition, there are two listeners:

* `OnUpdateFailureListener`: Listening error

* `OnInstallListener`: Callback of application installation

Update core manager:

* `IUpdateProxy`: Responsible for the process control of version update, calling update to start the version update process.

## Update process

Process after calling `update`:

```
IUpdateProxy/XUpdate --- (update) ---> IUpdateChecker --->（Request the server to get the latest version information）---> IUpdateParser ---> (Parse the data returned by the server, and build the UpdateEntity）---> IUpdateProxy ---> (If there is no latest version, end it directly, otherwise proceed to the following process）

---Automatic mode---> IUpdateDownloader ---> （Download the latest app apk） ---> Install application

---Non automatic mode---> IUpdatePrompter ---> Prompt for version update

---> click Update ---> IUpdateDownloader ---> （Download the latest app apk） ---> Jump to application installation UI

---> Click cancel or ignore ---> End
```

[Click to view the framework UML design diagram](https://github.com/xuexiangjys/XUpdate/blob/master/img/xupdate_uml.png)

---

## 1、Demonstration

* Default version update

![xupdate_default.png](https://ss.im5i.com/2021/06/14/6TPSz.png)

* Background update

![xupdate_background.png](https://ss.im5i.com/2021/06/14/6TgXW.png)

* Force version update

![xupdate_force.png](https://ss.im5i.com/2021/06/14/6Tlw8.png)

* Ignored version update

![xupdate_ignore.png](https://ss.im5i.com/2021/06/14/6TVu5.png)

* Custom pop up theme

![xupdate_custom.png](https://ss.im5i.com/2021/06/14/6TGDG.png)

* Use the system pop-up prompt

![xupdate_system.png](https://ss.im5i.com/2021/06/14/6Td86.png)

### Demo update background service

Because GitHub is slow to visit recently, if you need to experience xupdate better, you can [Click to build a simple version update service](https://github.com/xuexiangjys/XUpdateService).

### Demo Download

#### Pgyer Download

> Pgyer Download password: xuexiangjys

[![downloads](https://img.shields.io/badge/downloads-2.1M-blue.svg)](https://www.pgyer.com/xupdate)

[![xupdate_download_pugongying.png](https://ss.im5i.com/2021/06/14/6jaJj.png)](https://www.pgyer.com/xupdate)

#### GitHub Download

[![downloads](https://img.shields.io/badge/downloads-2.1M-blue.svg)](https://github.com/xuexiangjys/XUpdate/blob/master/apk/xupdate_demo_1.0.apk?raw=true)

[![xupdate_download.png](https://ss.im5i.com/2021/06/14/6jDhD.png)](https://github.com/xuexiangjys/XUpdate/blob/master/apk/xupdate_demo_1.0.apk?raw=true)

---

## 2、Quick integration guide

> At present, it supports the use of the mainstream development tool AndroidStudio and add dependency by configures `build.gradle` directly.

### 2.1、Add gradle dependency

1.In the project root directory `build.gradle`:

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

2.Then, in the dependencies of the project:

The following is the version description. Choose one.

* androidx project: above 2.0.0

```
dependencies {
  ...
  // androidx project
  implementation 'com.github.xuexiangjys:XUpdate:2.1.0'
}
```

* support project: below 1.1.6

```
dependencies {
  ...
  // support project
  implementation 'com.github.xuexiangjys:XUpdate:1.1.6'
}
```

### 2.2、Initialization

Initialize settings at the top of the application:

```
XUpdate.get()
    .debug(true)
    .isWifiOnly(true)                                               // By default, only version updates are checked under WiFi
    .isGet(true)                                                    // The default setting uses Get request to check versions
    .isAutoMode(false)                                              // The default setting is non automatic mode
    .param("versionCode", UpdateUtils.getVersionCode(this))         // Set default public request parameters
    .param("appKey", getPackageName())
    .setOnUpdateFailureListener(new OnUpdateFailureListener() {     // Set listening for version update errors
        @Override
        public void onFailure(UpdateError error) {
            if (error.getCode() != CHECK_NO_NEW_VERSION) {          // Handling different errors
                ToastUtils.toast(error.toString());
            }
        }
    })
    .supportSilentInstall(true)                                     // Set whether silent installation is supported. The default is true
    .setIUpdateHttpService(new OKHttpUpdateHttpService())           // This must be set! Realize the network request function.
    .init(this);                                                    // This must be initialized
```

【note】: if there is any problem, you can open debug mode to track the problem. If you also need to log on disk, you can implement the following interface.

```
XUpdate.get().setILogger(new ILogger() {
    @Override
    public void log(int priority, String tag, String message, Throwable t) {
        // Realize the function of logging
    }
});
```

### 2.3、Version update entity information

(1) UpdateEntity

(2) DownloadEntity

(3) PromptEntity

### 2.4、File encryption verification method

The default file encryption verification method used in this framework is MD5 encryption. Of course, if you don't want to use MD5 encryption, you can also customize the File Encryptor `IFileEncryptor`. The following is the implementation of MD5 File Encryptor for reference:

```
/**
 * The default file encryption calculation uses MD5 encryption
 *
 * @author xuexiang
 * @since 2019-09-06 14:21
 */
public class DefaultFileEncryptor implements IFileEncryptor {
    /**
     * Encrypted files
     *
     * @param file
     * @return
     */
    @Override
    public String encryptFile(File file) {
        return Md5Utils.getFileMD5(file);
    }

/**
     * Verify that the file is valid (whether the encryption is consistent)
     *
     * @param encrypt The encrypted value, is considered to be valid if encrypt is empty.
     * @param file    File to be verified
     * @return Whether the document is valid
     */
    @Override
    public boolean isFileValid(String encrypt, File file) {
        return TextUtils.isEmpty(encrypt) || encrypt.equalsIgnoreCase(encryptFile(file));
    }
}

```

Finally, call the `XUpdate.get().setIFileEncryptor` method, settings will take effect.

---

## 3、Version update

### 3.1、Default version update

You can directly call the following code to complete the version update operation:

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

It should be noted that with the default version update, the JSON format returned by the request server should include the following contents:

```
{
  "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": ""
}
```

Field description:

* Code: 0 means the request is successful, non-0 means failure.
* Msg: Request error information.
* UpdateStatus: 0 means no update, 1 means version update, no forced upgrade is required, and 2 represents version update and forced upgrade is required.
* VersionCode: Version number, self incrementing. Used to compare whether the version is the latest version.
* VersionName: Display name of version.
* ModifyContent: Content of version update.
* DownloadUrl: Download address of application APK file.
* ApkSize: The file size of the application APK file, in KB.
* ApkMd5: Apply the MD5 value of the APK file. If not, the APK cannot be guaranteed to be complete and will be downloaded again every time. The framework uses MD5 encryption by default.

### 3.2、Automatic version update

Automatic version update: auto check version + auto download APK + auto install APK (silent install).

You only need to set `isAutoMode(true)`. However, if the device does not have root permission, it will not be able to complete automatic update (because the silent installation requires root permission).

```
XUpdate.newBuild(getActivity())
        .updateUrl(mUpdateUrl)
        .isAutoMode(true) // If you need to be completely unattended and update automatically, you need root permission【required for silent installation】
        .update();
```

### 3.3、Support background update

After enabling the background update, users can enter the background update after clicking the "background update" button.

```
XUpdate.newBuild(getActivity())
        .updateUrl(mUpdateUrl)
        .supportBackgroundUpdate(true)
        .update();
```

### 3.4、Force version update

If the user does not update, the program will not work normally. The server only needs to return the `UpdateStatus` field to 2.

Of course, if you customize the request return API, you only need to set the `mIsForce` field of `UpdateEntity` to true.

### 3.5、Custom version update prompt pop-up theme

By setting the update top picture, theme color, button text color, width to height ratio, etc

* promptThemeColor: Set theme color
* promptButtonTextColor: Set the text color of the button
* promptTopResId: Set top background image Resource ID
* promptWidthRatio: Set the ratio of the width of the version update prompt to the screen. The default value is -1(No constraint is required).
* promptHeightRatio: Set the ratio of the height of the version update prompt to the screen. The default value is -1(No constraint is required).

```
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、Custom version update parser

The implementation of `IUpdateParser` interface can realize the user-defined parser.

```
XUpdate.newBuild(getActivity())
        .updateUrl(mUpdateUrl3)
        .updateParser(new CustomUpdateParser()) // Set up a custom version update parser
        .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、Custom version update checker + version update parser + version update prompter

* By implementing the `IUpdateChecker` interface, the checker can be customized.

* By implementing the `IUpdateParser` interface, the parser can be customized.

* By implementing the `IUpdatePrompter` interface, the prompter can be customized.

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

/**
     * Show custom version update prompter
     *
     * @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、Only use the downloader function to download APK

```
XUpdate.newBuild(getActivity())
        .apkCacheDir(PathUtils.getAppExtCachePath())  // Set the root directory of the download cache
        .build()
        .download(mDownloadUrl, new OnFileDownloadListener() {   // Set the download address and download listener
            @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、Only use the APK installed features of XUpdate

```
_XUpdate.startInstallApk(getContext(), FileUtils.getFileByPath(PathUtils.getFilePathByUri(getContext(), data.getData()))); // Set the path where the file is located
```

If your APK installation is different, you can implement your own APK installer. You only need to implement the `OnInstallListener` interface and use the `XUpdate.setOnInstallListener` set it to take effect.

### 3.10、International

Due to the limited level of the author, only Chinese and English are supported【the default language is English】. If you need to support other languages, you only need to create a new corresponding language file under the `res` of your own project to translate in multiple languages.

Please refer to ***[xupdate_strings.xml](https://github.com/xuexiangjys/XUpdate/blob/master/xupdate-lib/src/main/res/values-zh-rCN/xupdate_strings.xml)***。

What? You don't know Android's multilingual configuration yet? I suggest you take a look at this article：[Android项目国际化多国语言适配](https://blog.csdn.net/qq_29769851/article/details/90606437)

## Proguard

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

// Note: if you use a custom API parser for parsing, you need to add confusion to your custom API entities. Here are the custom API entity obfuscation rules configured in this demo:
-keep class com.xuexiang.xupdatedemo.entity.** { *; }

```

## Related links

* [XUpdate Document](https://github.com/xuexiangjys/XUpdate/wiki)
* [XUpdate Easy Use](https://github.com/xuexiangjys/XUpdateAPI)
* [XUpdate Management Service](https://github.com/xuexiangjys/XUpdateService)
* [XUpdate Background Management System](https://github.com/xuexiangjys/xupdate-management)
* [XUpdate Flutter Plugin](https://github.com/xuexiangjys/flutter_xupdate)
* [XUpdate React-Native Plugin](https://github.com/xuexiangjys/react-native-xupdate)
* [Flutter Version update pop up components](https://github.com/xuexiangjys/flutter_update_dialog)

---

## Thanks

https://github.com/WVector/AppUpdate

## Sponsor

> Your support is the driving force of my maintenance. I will list the list of all the reward personnel at the bottom as the voucher. Please leave the notes of the support items before rewarding!

![pay.png](https://ss.im5i.com/2021/06/14/6twG6.png)

Thank you for your sponsorship：

Name | Money | Platform
:-|:-|:-
*天 | 100￥ | WeChat
*航 | 10￥ | Alipay
X*? | 18.88￥ | WeChat
*网 | 1￥ | WeChat
Joe | 88.88￥ | WeChat

## WeChat Subscription

> More information, please scan my personal WeChat Subscription:【我的Android开源之旅】

![](https://ss.im5i.com/2021/06/14/65yoL.jpg)

## Contact

[![](https://img.shields.io/badge/QQGroup-720212425-blue.svg)](http://shang.qq.com/wpa/qunwpa?idkey=37ea606864cafa3c8a5d6b07f04fd672936a50fd6e535c13702baf705d57e6e8)

![xupdate_qq.jpg](https://ss.im5i.com/2021/06/14/6TQuQ.jpg)

Yimi178/XUpdate

简介

发行版

贡献者

近期动态

Yimi178/XUpdate .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

Yimi178/XUpdate