lasereset / appupdate

A simple lightweight and customizable Android version update library 一个简单、轻量、可随意定制的Android版本更新库

English Doc

AppUpdate正在征集框架使用者信息，希望得到大家的支持

扫码加入QQ群

目录

• 效果图
• 功能介绍
• Demo下载体验
• DownloadManager
• UpdateConfiguration
• 使用步骤
• 使用技巧
• 版本更新记录
• 哪些App正在使用

效果图

　 　 　

功能介绍

• 支持AndroidX
• 支持后台下载
• 支持自定义下载过程
• 支持 设备 >= Android M 动态权限的申请
• 支持通知栏进度条展示(或者自定义显示进度)
• 支持Android N
• 支持Android O
• 支持Android P
• 支持中/英文双语
• 支持自定内置对话框的样式
• 支持取消下载(如果发送了通知栏消息，则会移除)
• 支持下载完成 打开新版本后删除旧安装包文件
• 使用HttpURLConnection下载，未集成其他第三方框架

Demo下载体验

点击下载Demo进行体验

DownloadManager：配置文档

初始化使用DownloadManager.getInstance(this)

属性	描述	默认值	是否必须设置
context	上下文	null	true
apkUrl	apk的下载地址	null	true
apkName	apk下载好的名字	null	true
downloadPath	apk下载的位置	getExternalCacheDir()	false
showNewerToast	是否提示用户 "当前已是最新版本"	false	false
smallIcon	通知栏的图标(资源id)	-1	true
configuration	这个库的额外配置	null	false
apkVersionCode	更新apk的versionCode (如果设置了那么库中将会进行版本判断 下面的属性也就需要设置了)	1	false
apkVersionName	更新apk的versionName	null	false
apkDescription	更新描述	null	false
apkSize	新版本的安装包大小（单位M）	null	false
authorities	兼容Android N uri授权	应用包名	false

UpdateConfiguration：配置文档

属性	描述	默认值
notifyId	通知栏消息id	1011
notificationChannel	适配Android O的渠道通知	详情查阅源码
httpManager	设置自己的下载过程	null
enableLog	是否需要日志输出	true
onDownloadListener	下载过程的回调	null
jumpInstallPage	下载完成是否自动弹出安装页面	true
showNotification	是否显示通知栏进度（后台下载提示）	true
forcedUpgrade	是否强制升级	false
showBgdToast	是否提示 "正在后台下载新版本…"	true
onButtonClickListener	按钮点击事件回调	null
dialogImage	对话框背景图片资源(图片规范参考demo)	-1
dialogButtonColor	对话框按钮的颜色	-1
dialogButtonTextColor	对话框按钮的文字颜色	-1

使用步骤

第一步： app/build.gradle进行依赖

implementation 'com.azhon:appupdate:2.4.0'

• 如果你使用的是AndroidX，请依赖appupdateX

implementation 'com.azhon:appupdateX:2.4.0'

第二步：创建DownloadManager，更多用法请查看这里示例代码

DownloadManager manager = DownloadManager.getInstance(this);
manager.setApkName("appupdate.apk")
        .setApkUrl("https://raw.githubusercontent.com/azhon/AppUpdate/master/apk/appupdate.apk")
        .setSmallIcon(R.mipmap.ic_launcher)
        //可设置，可不设置
        .setConfiguration(configuration)
        .download();

第三步：兼容Android N 及以上版本，在你应用的Manifest.xml添加如下代码

provider中设置的authorities值必须与DownloadManager中设置的authorities一致（不设置则为应用包名）

android:authorities="${applicationId}"

<provider
    android:name="android.support.v4.content.FileProvider"
    android:authorities="${applicationId}"
    android:exported="false"
    android:grantUriPermissions="true">
    <meta-data
        android:name="android.support.FILE_PROVIDER_PATHS"
        android:resource="@xml/file_paths_public" />
</provider>

• 如果你引入的是appupdateX版本

  <provider
      android:name="androidx.core.content.FileProvider"
      android:authorities="${applicationId}"
      android:exported="false"
      android:grantUriPermissions="true">
      <meta-data
          android:name="android.support.FILE_PROVIDER_PATHS"
          android:resource="@xml/file_paths_public" />
  </provider>

第四步：资源文件res/xml/file_paths_public.xml内容

<?xml version="1.0" encoding="utf-8"?>
<paths>
    <external-path
        name="app_update_external"
        path="/" />
    <external-cache-path
        name="app_update_cache"
        path="/" />
</paths>

第五步：混淆打包，只需保持Activity、Service不混淆

-keep public class * extends android.app.Activity
-keep public class * extends android.app.Service

使用技巧

• 框架内部支持中/英文（其他语言只需要在对应的string.xml中取相同的名字即可）
• 查看版本库中的Log只需要过滤AppUpdate开头的Tag
• 如果没有设置downloadPath则默认为getExternalCacheDir()目录同时不会申请[存储]权限！
• 下载完成 打开新版本后删除旧安装包文件，实现思路请移步此处

//旧版本apk的文件保存地址
boolean b = ApkUtil.deleteOldApk(this, getExternalCacheDir().getPath() + "/appupdate.apk");

• 温馨提示：升级对话框中的内容是可以上下滑动的哦！
• 如果需要实现自己一套下载过程，只需要继承BaseHttpDownloadManager 并使用listener更新进度

public class MyDownload extends BaseHttpDownloadManager {}

版本更新记录

• v2.4.0

  • 优化下载监听回调执行在主线程中
  • 解决强制更新状态下去安装，用户取消安装Dialog无法继续安装bug

• 更多更新记录点此查看

哪些App正在使用

易果无忧	慧健康	慧健康医生版