AndroidApp内部更新Library

AutoUpdateProject

最新版本及说明请关注GitHub&＃xff0c;欢迎Star。
有什么意见与建议欢迎交流&＃xff01;

github地址&＃xff1a;https://github.com/MZCretin/AutoUpdateProject

公告&＃xff1a;移除了之前所有版本的文档说明&＃xff0c;从现在起&＃xff0c;版本的更新迭代从1.1.2开始进行&＃xff0c;之前的老版本使用没有影响&＃xff0c;只是不再提供集成说明。

特点概述

一、可从后台主动控制本地app强制更新&＃xff0c;主要适用场合是某个版本有bug&＃xff0c;会严重影响用户的使用&＃xff0c;此时用这种模式&＃xff0c;只要用户打开app&＃xff0c;提醒强制更新&＃xff0c;否则不能进入app&＃xff1b;
二、根据后台返回受影响的版本号&＃xff0c;可控制多个版本同时被强制更新&＃xff1b;
三、后台返回最新安装包大小&＃xff0c;本地判断安装包是否下载&＃xff0c;防止多次下载&＃xff1b;
四、内部处理&＃xff0c;忽略此版本更新提示
五、library采用无第三方工具类&＃xff0c;下载使用HttpURLConnextion&＃xff0c;本地存储使用SharedPrefference&＃xff0c;以免使用此library带来第三方插件冲突
六、library适配Android 7.0
七、library默认请求方式为POST请求&＃xff0c;对于GET请求无法正常请求&＃xff0c;提供配置请求方式
八、library添加了对log日志的开关&＃xff0c;在调试阶段可打开调试log输出&＃xff0c;提交生产环境的时候可以主动的关闭
九、library支持判断网络环境&＃xff0c;移动数据下智能提示&＃xff0c;防止流量外漏。
十、考虑到减少与后台人员的配合的高度耦合&＃xff0c;增加了自定义model的入口&＃xff0c;具体使用请关注使用方式。
十一、提供两种模式的版本更新&＃xff0c;一种是对话框显示下载进度&＃xff0c;一种是通知栏显示后台默默下载形式

使用方式&＃xff1a;

第一步、在项目目录下的build.gradle文件下的repositories节点下添加如下代码

allprojects { repositories { ... maven { url &＃39;https://jitpack.io&＃39; } } }

第二步、 在项目app目录下的build.gradle文件下的dependencies节点下添加 { compile &＃39;com.github.MZCretin:AutoUpdateProject:v1.0&＃39; }

第三步、 在BaseApplication或者是MainActivity的onCreate()方法中进行初始化&＃xff08;我们推荐在BaseApplication进行初始化&＃xff0c;另外不要忘记在AndroidManifest.xml中注册BaseApplication&＃xff09;&＃xff0c;你有两种初始化的方式&＃xff0c;一种是自定义一些参数&＃xff0c;另外一种是直接使用默认参数。如下所示&＃xff1a;

//第一种形式 自定义参数
CretinAutoUpdateUtils.Builder builder &＃61; new CretinAutoUpdateUtils.Builder() //设置更新api .setBaseUrl("http://120.24.5.102/weixin/app/getversion") //设置是否显示忽略此版本 .setIgnoreThisVersion(true) //设置下载显示形式 对话框或者通知栏显示 二选一 .setShowType(CretinAutoUpdateUtils.Builder.TYPE_DIALOG) //设置下载时展示的图标 .setIconRes(R.mipmap.ic_launcher) //设置下载时展示的应用吗 .setAppName("测试应用") //设置请求方式.setRequestMethod(CretinAutoUpdateUtils.Builder.METHOD_GET)//设置自定义的Model类.setTransition(new UpdateModel())//设置是否打印log日志.showLog(true).build();
CretinAutoUpdateUtils.init(builder); //第二种模式 使用默认值
CretinAutoUpdateUtils.init("http://120.24.5.102/weixin/app/getversion");

第四步、在AndroidManifest.xml的application节点下添加如下代码&＃xff1a;

第五步、适配Android7.0

在app module 的 res下建立一个xml文件夹&＃xff0c;新建一个install_file.xml&＃xff0c;在该文件内填写以下内容&＃xff1a;

在AndroidManifest.xml文件的application标签内填下以下内容

第六步、必须返回字段的说明

此library的使用需要与后台联动配合&＃xff0c;下面是后台需要返回给我们使用的字段说明&＃xff1a;

/*** Created by cretin on 2017/3/8.*/public class UpdateEntity {public int versionCode &＃61; 0;//是否强制更新 0 不强制更新 1 hasAffectCodes拥有字段强制更新 2 所有版本强制更新public int isForceUpdate &＃61; 0;//上一个版本版本号public int preBaselineCode &＃61; 0;//版本号 描述作用public String versionName &＃61; "";//新安装包的下载地址public String downurl &＃61; "";//更新日志public String updateLog &＃61; "";//安装包大小 单位字节public String size &＃61; "";//受影响的版本号 如果开启强制更新 那么这个字段包含的所有版本都会被强制更新 格式 2|3|4public String hasAffectCodes &＃61; "";
}


所以需要后台返回给我们这些字段&＃xff0c;这些字段都是必须的&＃xff0c;相关说明请看注释&＃xff0c;下面是一个参考

{"versionCode": "18", "isForceUpdate": "1", "preBaselineCode": "0", "versionName": "2.1.1", "downurl": "http://120.24.5.102/Webconfig/frj01_211_jiagu_sign.apk", "hasAffectCodes": "11|12|13|14|15|16|17", "updateLog": "1、修复bug2、完善部分功能点3、系统升级&＃xff0c;强制更新", "size": 10291218
}

情况一&＃xff1a;使用默认的model类

sdk默认的model类为UpdateEntity.java&＃xff0c;具体如下&＃xff0c;你需要保证你们后台返回的json数据可以解析成如下的model类&＃xff0c;否则会报无法解析的错误。

/*** Created by cretin on 2017/3/8.*/public class UpdateEntity implements LibraryUpdateEntity{public int versionCode &＃61; 0;//是否强制更新 0 不强制更新 1 hasAffectCodes拥有字段强制更新 2 所有版本强制更新public int isForceUpdate &＃61; 0;//上一个版本版本号public int preBaselineCode &＃61; 0;//版本号 描述作用public String versionName &＃61; "";//新安装包的下载地址public String downurl &＃61; "";//更新日志public String updateLog &＃61; "";//安装包大小 单位字节public String size &＃61; "";//受影响的版本号 如果开启强制更新 那么这个字段包含的所有版本都会被强制更新 格式 2|3|4public String hasAffectCodes &＃61; "";public int getVersionCode() {return versionCode;}public void setVersionCode(int versionCode) {this.versionCode &＃61; versionCode;}public int getIsForceUpdate() {return isForceUpdate;}public void setIsForceUpdate(int isForceUpdate) {this.isForceUpdate &＃61; isForceUpdate;}public int getPreBaselineCode() {return preBaselineCode;}public void setPreBaselineCode(int preBaselineCode) {this.preBaselineCode &＃61; preBaselineCode;}public String getVersionName() {return versionName;}public void setVersionName(String versionName) {this.versionName &＃61; versionName;}public String getDownurl() {return downurl;}public void setDownurl(String downurl) {this.downurl &＃61; downurl;}public String getUpdateLog() {return updateLog;}public void setUpdateLog(String updateLog) {this.updateLog &＃61; updateLog;}public String getSize() {return size;}public void setSize(String size) {this.size &＃61; size;}public String getHasAffectCodes() {return hasAffectCodes;}public void setHasAffectCodes(String hasAffectCodes) {this.hasAffectCodes &＃61; hasAffectCodes;}&＃64;Overridepublic int getVersionCodes() {return getVersionCode();}&＃64;Overridepublic int getIsForceUpdates() {return getIsForceUpdate();}&＃64;Overridepublic int getPreBaselineCodes() {return getPreBaselineCode();}&＃64;Overridepublic String getVersionNames() {return getVersionName();}&＃64;Overridepublic String getDownurls() {return getDownurl();}&＃64;Overridepublic String getUpdateLogs() {return getUpdateLog();}&＃64;Overridepublic String getApkSizes() {return getSize();}&＃64;Overridepublic String getHasAffectCodess() {return getHasAffectCodes();}
}

情况二&＃xff1a;使用自定义的model类

首先&＃xff0c;在初始化sdk的时候采用自定义参数的方式&＃xff0c;使用 new CretinAutoUpdateUtils.Builder().setTransition(new UpdateModel())方式传入你自定义的model类&＃xff0c;请注意&＃xff0c;自定义的UpdateModel类必须实现sdk的LibraryUpdateEntity接口&＃xff0c;并实现该接口所必须实现的方法&＃xff0c;在这些方法中返回给sdk必须的字段&＃xff0c;这样sdk才能成功的获取相对应的信息。下面是一个具体的实现&＃xff1a;

import com.cretin.www.cretinautoupdatelibrary.model.LibraryUpdateEntity;/*** Created by cretin on 2017/4/21.*/public class UpdateModel implements LibraryUpdateEntity{/*** id : test* page : 1* rows : 10* isForceUpdate : 0* preBaselineCode : 0* versionName : V1.0.1* versionCode : 3* downurl : http://120.24.5.102/Webconfig/frj01_211_jiagu_sign.apk* updateLog : 1、修复bug* size : 10291218* hasAffectCodes : 1|2* createTime : 1489651956000* iosVersion : 1*/private String id;private int page;private int rows;private int isForceUpdate;private int preBaselineCode;private String versionName;private int versionCode;private String downurl;private String updateLog;private String size;private String hasAffectCodes;private long createTime;private int iosVersion;public String getId() {return id;}public void setId(String id) {this.id &＃61; id;}public int getPage() {return page;}public void setPage(int page) {this.page &＃61; page;}public int getRows() {return rows;}public void setRows(int rows) {this.rows &＃61; rows;}public int getIsForceUpdate() {return isForceUpdate;}public void setIsForceUpdate(int isForceUpdate) {this.isForceUpdate &＃61; isForceUpdate;}public int getPreBaselineCode() {return preBaselineCode;}public void setPreBaselineCode(int preBaselineCode) {this.preBaselineCode &＃61; preBaselineCode;}public String getVersionName() {return versionName;}public void setVersionName(String versionName) {this.versionName &＃61; versionName;}public int getVersionCode() {return versionCode;}public void setVersionCode(int versionCode) {this.versionCode &＃61; versionCode;}public String getDownurl() {return downurl;}public void setDownurl(String downurl) {this.downurl &＃61; downurl;}public String getUpdateLog() {return updateLog;}public void setUpdateLog(String updateLog) {this.updateLog &＃61; updateLog;}public String getSize() {return size;}public void setSize(String size) {this.size &＃61; size;}public String getHasAffectCodes() {return hasAffectCodes;}public void setHasAffectCodes(String hasAffectCodes) {this.hasAffectCodes &＃61; hasAffectCodes;}public long getCreateTime() {return createTime;}public void setCreateTime(long createTime) {this.createTime &＃61; createTime;}public int getIosVersion() {return iosVersion;}public void setIosVersion(int iosVersion) {this.iosVersion &＃61; iosVersion;}&＃64;Overridepublic int getVersionCodes() {return getVersionCode();}&＃64;Overridepublic int getIsForceUpdates() {return getIsForceUpdate();}&＃64;Overridepublic int getPreBaselineCodes() {return getPreBaselineCode();}&＃64;Overridepublic String getVersionNames() {return getVersionName();}&＃64;Overridepublic String getDownurls() {return getDownurl();}&＃64;Overridepublic String getUpdateLogs() {return getUpdateLog();}&＃64;Overridepublic String getApkSizes() {return getSize();}&＃64;Overridepublic String getHasAffectCodess() {return getHasAffectCodes();}
}

下面图片中是必须实现的方法&＃xff0c;sdk会根据这些方法返回的数据进行操作&＃xff0c;请务必重写&＃xff01;

第七步、开始使用吧

CretinAutoUpdateUtils.getInstance(MainActivity.this).check();