Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jenly1314/appupdater
🚀 AppUpdater一个专注于App更新，一键傻瓜式集成App版本升级的轻量开源库。(集成步骤超简单)
https://github.com/jenly1314/appupdater
android apk app-dialog app-update app-updater appupdate appupdater dialog dialogfragment download update update-checker updater version version-update
Last synced: 6 days ago
JSON representation
🚀 AppUpdater一个专注于App更新，一键傻瓜式集成App版本升级的轻量开源库。(集成步骤超简单)
- Host: GitHub
- URL: https://github.com/jenly1314/appupdater
- Owner: jenly1314
- License: mit
- Created: 2018-06-29T09:58:03.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-20T16:12:57.000Z (3 months ago)
- Last Synced: 2024-11-06T22:17:29.435Z (13 days ago)
- Topics: android, apk, app-dialog, app-update, app-updater, appupdate, appupdater, dialog, dialogfragment, download, update, update-checker, updater, version, version-update
- Language: Java
- Homepage: https://jenly1314.github.io/AppUpdater/
- Size: 49.2 MB
- Stars: 884
- Watchers: 19
- Forks: 128
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# AppUpdater
[](https://raw.githubusercontent.com/jenly1314/AppUpdater/master/app/release/app-release.apk)
[](https://repo1.maven.org/maven2/com/github/jenly1314/AppUpdater)
[](https://jitpack.io/#jenly1314/AppUpdater)
[](https://circleci.com/gh/jenly1314/AppUpdater)
[](https://android-arsenal.com/api?level=15)
[](https://opensource.org/licenses/mit-license.php)
AppUpdater for Android 是一个专注于App更新，一键傻瓜式集成App版本升级的轻量开源库。
> 无需担心各种细节的处理和适配问题；包括但不仅限于：通知栏适配、重复下载、文件访问授权、App安装等问题；这些 **AppUpdater** 都已帮您处理好。
* **AppUpdater** 核心库主要包括 **app-updater** 和 **app-dialog** 。
> **app-updater** 主要负责后台下载更新App，无需担心下载时各种配置相关的细节，一键傻瓜式升级。
> **app-dialog** 主要是提供常用的Dialog和DialogFragment，简化弹框提示的实现，布局样式可随意定制。
* 下载更新和弹框提示之所以分开是因为这本来就是两个功能。二者完全独立，可以在解耦同时减少侵入性。
> 如果你只需要单纯的 App下载更新功能，仅依赖 **app-updater** 即可；
> 如果你在需要App下载更新功能的同时，还需要有对话框来进行交互； 那么 **app-updater** + **app-dialog** 二者配合使用，谁用谁知道。
## 功能介绍
- ✅ 专注于App更新一键傻瓜式升级
- ✅ 够轻量，体积小
- ✅ 支持监听下载和自定义下载流程
- ✅ 支持下载失败时，可重新下载
- ✅ 支持文件MD5校验，避免重复下载
- ✅ 支持通知栏提示内容和流程全部可配置
- ✅ 支持取消下载
- ✅ 支持使用HttpsURLConnection或OkHttpClient进行下载
- ✅ 支持Android 10(Q)
- ✅ 支持Android 11(R)
- ✅ 支持Android 12(S)
## Gif 展示
> 你也可以直接下载 [演示App](https://raw.githubusercontent.com/jenly1314/AppUpdater/master/app/release/app-release.apk) 体验效果
## 引入
### Gradle:
1. 在Project的 **build.gradle** 里面添加远程仓库
```gradle
allprojects {
repositories {
//...
mavenCentral()
}
}
```
2. 在Module的 **build.gradle** 里面添加引入依赖项
```gradle
//----------AndroidX 版本
//app-updater
implementation 'com.github.jenly1314.AppUpdater:app-updater:1.2.0'
//app-dialog
implementation 'com.github.jenly1314.AppUpdater:app-dialog:1.2.0'
```
## 示例
```Java
//一句代码，傻瓜式更新
new AppUpdater(context,url).start();
```
```Java
//简单弹框升级
AppDialogConfig config = new AppDialogConfig(context);
config.setTitle("简单弹框升级")
.setConfirm("升级") //旧版本使用setOk
.setContent("1、新增某某功能、\n2、修改某某问题、\n3、优化某某BUG、")
.setOnClickConfirm(new View.OnClickListener() { // 旧版本使用setOnClickOk
@Override
public void onClick(View v) {
new AppUpdater.Builder(context)
.setUrl(mUrl)
.build()
.start();
AppDialog.INSTANCE.dismissDialog();
}
});
AppDialog.INSTANCE.showDialog(context,config);
```
```Java
//简单DialogFragment升级
AppDialogConfig config = new AppDialogConfig(context);
config.setTitle("简单DialogFragment升级")
.setConfirm("升级")
.setContent("1、新增某某功能、\n2、修改某某问题、\n3、优化某某BUG、")
.setOnClickConfirm(new View.OnClickListener() {
@Override
public void onClick(View v) {
AppUpdater appUpdater = new AppUpdater.Builder(context)
.setUrl(mUrl)
.build();
appUpdater.setHttpManager(OkHttpManager.getInstance()) // 使用OkHttp的实现进行下载
.setUpdateCallback(new UpdateCallback() { // 更新回调
@Override
public void onDownloading(boolean isDownloading) {
// 下载中：isDownloading为true时，表示已经在下载，即之前已经启动了下载；为false时，表示当前未开始下载，即将开始下载
}
@Override
public void onStart(String url) {
// 开始下载
}
@Override
public void onProgress(long progress, long total, boolean isChanged) {
// 下载进度更新：建议在isChanged为true时，才去更新界面的进度；因为实际的进度变化频率很高
}
@Override
public void onFinish(File file) {
// 下载完成
}
@Override
public void onError(Exception e) {
// 下载失败
}
@Override
public void onCancel() {
// 取消下载
}
}).start();
AppDialog.INSTANCE.dismissDialogFragment(getSupportFragmentManager());
}
});
AppDialog.INSTANCE.showDialogFragment(getSupportFragmentManager(), config);
```
更多使用详情，请查看[app](app)中的源码使用示例或直接查看[API帮助文档](https://jenly1314.github.io/AppUpdater/api/)
## 补充说明
### app-updater
* 不设置 **HttpManager** 时，默认使用 **HttpsURLConnection** 实现的 **HttpManager** 进行下载，如果想要使用 **OkHttpClient** 实现下载，需依赖 **okhttp** 库；（内部默认提供 **HttpManager** 和 **OkHttpManager** 两种实现）
* 支持下载APK时，优先取本地缓存策略，避免多次重复下载相同的APK文件；（校验方式支持 **文件MD5** 或 **VersionCode** 比对）
* 如需自定义更新App时通知栏中的相关文案信息；你只需在 **string.xml** 定义相同的名字进行覆盖即可（ **app-updater** 中的资源定义都是以 **app_updater** 开头）。
* 不设置 **Notification** 时，默认使用 **NotificationImpl** 实现的，如果当前的通知栏的布局不满足你的需求，可通过参考 **NotificationImpl** 去自定义实现一个 **INotification** ；
* **AppUpdater** 中的日志统一使用 **LogUtils** 进行管理，通过 **LogUtils.setShowLog** 可以全局设置是否显示日志；需要定位 **AppUpdater** 内部日志信息时，只需过滤以 **AppUpdater** 开头的 **Log Tag** 即可。
* **AppUpdater** 的更多配置说明请查看 **AppUpdater.Builder** 或 **UpdateConfig**；方法上基本都有详细的说明。
### app-dialog
* **AppDialogConfig** 主要提供一些对话框配置，内部提供了一套默认的配置，你也可以通过 **AppDialogConfig** 对外暴露的方法，自定义对话框配置；**AppDialog** 主要负责对话框的显示与消失；通过 **AppDialog** 和 **AppDialogConfig**，你可以很容易的实现一个自定义对话框；
* **AppDialog** 足够通用，其内部实现了一套最常见对话框，并给予一系列的默认配置，让使用者可以尽可能的通过少的配置就能实现功能；**AppDialog** 也足够抽象，对话框布局样式是可随意定制；
* 基于以上几点，这里列个特别的场景说明：如需你想不通过自定义布局的方式定义对话框布局，同时默认的对话框的文字或按钮颜色不太符合你的需求场景，只想修改 **AppDialog** 内置默认对话框提示文字的颜色（包括按钮文字），你可以通过在 **colors.xml** 定义相同的名字进行覆盖即可（ **app-dialog** 中的资源定义都是以 **app_dialog** 开头）。
## 混淆
**app-updater** [Proguard rules](app-updater/proguard-rules.pro)
**app-dialog** [Proguard rules](app-dialog/proguard-rules.pro)
## 相关推荐
- [RetrofitHelper](https://github.com/jenly1314/RetrofitHelper) 是一个支持配置多个BaseUrl，支持动态改变BaseUrl，动态配置超时时长的Retrofit帮助类。
- [BaseUrlManager](https://github.com/jenly1314/BaseUrlManager) BaseUrl管理器，主要打测试包时，一个App可动态切换到不同的开发环境或测试环境。
- [MVVMFrame](https://github.com/jenly1314/MVVMFrame) 一个基于Google官方推出的JetPack构建的MVVM快速开发框架。
- [LogX](https://github.com/jenly1314/LogX) 一个小而美的日志记录框架；好用不解释。
## 版本日志
#### v1.2.0：2023-7-9
* 更新Gradle至v7.3.3
* 优化lint检测
#### [查看更多版本日志](CHANGELOG.md)
## 赞赏
如果您喜欢AppUpdater，或感觉AppUpdater帮助到了您，可以点右上角“Star”支持一下，您的支持就是我的动力，谢谢 :smiley:
您也可以扫描下面的二维码，请作者喝杯咖啡 :coffee:
## 关于我
| 我的博客 | GitHub | Gitee | CSDN | 博客园 |
|:------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------|:------------------------------------------------------------------------------|
| Jenly's Blog | jenly1314 | jenly1314 | jenly121 | jenly |
## 联系我
| 微信公众号 | Gmail邮箱 | QQ邮箱 | QQ群 | QQ群 |
|:--------------------------------------------------------|:---------------------------------------------------------------------------------|:----------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------|
| [Jenly666](http://weixin.qq.com/r/wzpWTuPEQL4-ract92-R) | jenly1314 | jenly1314 | 20867961 | 64020761 |
