okhttp3下载文件检测进度与断点续传
之前有用过retrofit来做下载的功能,虽然retrofit基于okhttp,但是这还是有点不同。
我是在做更新功能的时候用到这个,具体的操作可能不会说太多,因为网上能找到很多基本的操作,我就说下一些流程和BUG,不管是okhttp还是retrofit都适用。
一.下载文件
1.下载操作
下载文件其实我感觉并不像上传那么复杂,就按照拉取文本文件一样弄就行。
这是我普通的用okhttp的get请求
Request request = new Request.Builder()
.url(murl)
.build();
Call call = okHttpClient.newCall(request);
call.enqueue(callback);
下载文件的操作其实差不多
public Call download(String url, final DownloadListener downloadListener, final long startsPoint, Callback callback){
Request request = new Request.Builder()
.url(url)
.header("RANGE", "bytes=" + startsPoint + "-")//断点续传
.build();
// 重写ResponseBody监听请求
Interceptor interceptor = new Interceptor() {
@Override
public Response intercept(Chain chain) throws IOException {
Response originalResponse = chain.proceed(chain.request());
return originalResponse.newBuilder()
.body(new DownloadResponseBody(originalResponse, startsPoint, downloadListener))
.build();
}
};
OkHttpClient.Builder dlOkhttp = new OkHttpClient.Builder()
.addNetworkInterceptor(interceptor);
// 绕开证书
try {
setSSL(dlOkhttp);
} catch (Exception e) {
e.printStackTrace();
}
// 发起请求
Call call = dlOkhttp.build().newCall(request);
call.enqueue(callback);
return call;
}
注释讲得也比较请求,要重写ResponseBody是因为要监听下载进度,网上有很多人的写法是在onResponse的回调中读写字节到本地时监听进度,我建议是重写ResponseBody来监听下载进度,因为好像写在onResponse会有什么问题我忘记了,就算没问题,自定义ResponseBody也会显得更灵活。
2.自定义的ResponseBody
public class DownloadResponseBody extends ResponseBody{
private Response originalResponse;
private DownloadListener downloadListener;
private long oldPoint = 0;
public DownloadResponseBody(Response originalResponse, long startsPoint, DownloadListener downloadListener){
this.originalResponse = originalResponse;
this.downloadListener = downloadListener;
this.oldPoint = startsPoint;
}
@Override
public MediaType contentType() {
return originalResponse.body().contentType();
}
@Override
public long contentLength() {
return originalResponse.body().contentLength();
}
@Override
public BufferedSource source() {
return Okio.buffer(new ForwardingSource(originalResponse.body().source()) {
private long bytesReaded = 0;
@Override
public long read(Buffer sink, long byteCount) throws IOException {
long bytesRead = super.read(sink, byteCount);
bytesReaded += bytesRead == -1 ? 0 : bytesRead;
if (downloadListener != null) {
downloadListener.loading((int) ((bytesReaded+oldPoint)/(1024)));
}
return bytesRead;
}
});
}
}
主要就是要重写这个source方法来实现监听,代码也不难,其实不用多说什么。
3.定义请求中的回调
最好是用一个接口来定义在下载过程中的行为,接口的好处不用多说
public interface DownloadListener {
/**
* 开始下载
*/
void start(long max);
/**
* 正在下载
*/
void loading(int progress);
/**
* 下载完成
*/
void complete(String path);
/**
* 请求失败
*/
void fail(int code, String message);
/**
* 下载过程中失败
*/
void loadfail(String message);
}
我这里定义了两种失败,主要是这边要根据请求网络的失败和读写过程的失败写不同的逻辑,如果没有特定的需求,这里只定义一个失败的回调也是可以的。
二.下载的文件保存到本地
okhttp中是写在onResponse方法中进行io操作,retrofit可以写在onNext中
@Override
public void onResponse(Call call, Response response) throws IOException {
long length = response.body().contentLength();
if (length == 0){
// 说明文件已经下载完,直接跳转安装就好
downloadListener.complete(String.valueOf(getFile().getAbsoluteFile()));
return;
}
downloadListener.start(length+startsPoint);
// 保存文件到本地
InputStream is = null;
RandomAccessFile randomAccessFile = null;
BufferedInputStream bis = null;
byte[] buff = new byte[2048];
int len = 0;
try {
is = response.body().byteStream();
bis =new BufferedInputStream(is);
File file = getFile();
// 随机访问文件,可以指定断点续传的起始位置
randomAccessFile = new RandomAccessFile(file, "rwd");
randomAccessFile.seek (startsPoint);
while ((len = bis.read(buff)) != -1) {
randomAccessFile.write(buff, 0, len);
}
// 下载完成
downloadListener.complete(String.valueOf(file.getAbsoluteFile()));
} catch (Exception e) {
e.printStackTrace();
downloadListener.loadfail(e.getMessage());
} finally {
try {
if (is != null) {
is.close();
}
if (bis != null){
bis.close();
}
if (randomAccessFile != null) {
randomAccessFile.close();
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
});
private File getFile() {
String root = Environment.getExternalStorageDirectory().getPath();
File file = new File(root,"updateDemo.apk");
return file;
}
private long getFileStart(){
String root = Environment.getExternalStorageDirectory().getPath();
File file = new File(root,"updateDemo.apk");
return file.length();
}
因为我们之前在请求时写了
这里先获取报文的长度,如果长度为0,说明在我门本地已经下载好文件了,这里就不用下载了,直接跳转到安装。这个主要是对断点续传的一个判断,你想想,如果我都已经下载完文件了,那我有什么必要再去开启io流。
这里还要注意一下,获取文件长度用file.length()而不用fis.available()是因为网上有个朋友测试过用fis.available()如果数据过大的话会出问题。
downloadListener.start(length+startsPoint);是我在开始读写前要先给ProgressBar设最大值。
读写时用到RandomAccessFile,这个主要是能随时读写,做的就是断点续传的操作。其实断点续传主要就三句代码
.header("RANGE", "bytes=" + startsPoint + "-")
randomAccessFile = new RandomAccessFile(file, "rwd");
randomAccessFile.seek (startsPoint);
后面就没有什么了,就是普通的io操作。
三.安装应用
下载完成后跳转到安装页面,需要做一个7.0的判断
private void installApk(String path){
try {
Intent intent = new Intent(Intent.ACTION_VIEW);
File file = new File(path);
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
intent.setFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
String authority = "com.example.kylin.mindabs" + ".fileProvider";
Uri fileUri = FileProvider.getUriForFile(getActivity().getApplicationContext(), authority, file);
intent.setDataAndType(fileUri, "application/vnd.android.package-archive");
} else {
intent.setDataAndType(Uri.fromFile(file),"application/vnd.android.package-archive");
intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
}
this.startActivityForResult(intent, 0);
}catch (Exception e){
// todo 安装失败的操作
}
}
配置在清单中
<provider
tools:replace="android:authorities"
android:name="android.support.v4.content.FileProvider"
android:authorities="com.example.kylin.mindabs.fileProvider"
android:grantUriPermissions="true"
android:exported="false">
<meta-data
tools:replace="android:resource"
android:name="android.support.FILE_PROVIDER_PATHS"
android:resource="@xml/file_paths" />
</provider>
定义一个xml文件
<paths>
<external-path path="Android/data/com.example.kylin.mindabs/" name="files_root" />
<external-path path="." name="external_storage_root" />
</paths>
还有就是很多人网上写的跳转是用startActivity,我建议用startActivityForResult,这样可以拿到安装页面解析时的回到,方便之后做解析失败之类的。
@Override
public void onActivityResult(int requestCode, int resultCode, Intent data) {
super.onActivityResult(requestCode, resultCode, data);
if(requestCode == 0) {
......
}
}
我这里之前调试的时候打印成功和失败的回调
(1)成功
看到resultCode为0,data为空。注意,就算你不安装应用点取消,只要是能识别这个包出来,都是算解析成功,那么什么时候是失败的呢,比如安装包损坏这些才会回调失败的情况。
(2)失败
我自己模拟了一个失败的情况,这种情况它会直接提示你安装包解析失败。
四.开发中遇到的问题
1.断点续传的细节
在使用
.header("RANGE", "bytes=" + startsPoint + "-")
之后,其实就是从文件的startsPoint 字节开始去下载,startsPoint 是我获取的当前本地文件的大小,这本来是没啥问题的,但是在apk已经下载完成的情况下startsPoint 就是整个文件的长度,按理说这里这样操作应该会让response.body().contentLength()等于0,而实际上我在调试的时候没有崩溃,但是response.body().contentLength()莫名其妙的等于229,我认真看日记才发现请求时报416错误,就是越界了。为了解决这个文件,我在拿到断点的时候会做一个-1的操作
final long startsPoint = getFileStart() > 0 ? getFileStart()-1 : getFileStart();
2.流程问题
其实更新的知识点就那两三个,但是对于流程来说需要严谨些,说得直白些,尽量有条能走通的路,所以我的代码里大量加了try-catch
3.请求放在service
请求为什么要放在service中呢,其实是一个生命周期的问题,如果请求是在activity中发起的,关闭activity之后其实activity还不会结束,他会被请求影响生命周期,所以需要再service中请求。而如果你不是在activity中请求的话,比如你在弹框中请求,只要在弹框消失的时候取消请求就行,这种情况放不放在service里面做请求我觉得就无所谓了。