OKHTTP断点续传
文章目录
- OKHTTP断点续传
-
- HTTP断点续传知识点
-
- Range
- [Content Range](#Content Range)
- Etag&If-Range(文件唯一标志)
- OKHTTP断点下载
- [OKHTTP 简单短断点下载代码示例](#OKHTTP 简单短断点下载代码示例)
Android 断点续传一直是面试的高频问点,这里从HTTP断点续传知识和Android续传思路结合一起,总结出关于Android断点续传做法。
HTTP断点续传知识点
HTTP1.1 协议中默认支持获取文件的部分内容,主要是通过头部两个参数:Range和Content Range 来实现的,客户端发送请求是对应是Range ,服务器响应时是对应Content-Range。
Range
是客户端想要获取文件的部分内容的关键字段,Range 参数中指定获取内容的起始字节的位置和终止字节的位置。他的一般格式为:
<font style="color:rgb(51, 51, 51);background-color:rgb(248, 248, 248);">Range:(unit=first byte </font>**<font style="color:rgb(51, 51, 51);">pos</font>**<font style="color:rgb(51, 51, 51);background-color:rgb(248, 248, 248);">)-[</font>**<font style="color:rgb(51, 51, 51);">last</font>**<font style="color:rgb(51, 51, 51);background-color:rgb(248, 248, 248);"> byte </font>**<font style="color:rgb(51, 51, 51);">pos</font>**<font style="color:rgb(51, 51, 51);background-color:rgb(248, 248, 248);">]</font>
例如:
java
Range: bytes=0-499 表示第 0-499 字节范围的内容 、
Range: bytes=-500 表示最后 500 字节的内容
Range: bytes=500- 表示从第 500 字节开始到文件结束部分的内容
Range: bytes=0-0,-1 表示第一个和最后一个字节
Range: bytes=500-600,601-999 同时指定几个范围
Content Range
在接受到客户端的Range请求后,服务器会在响应的头部添加Content 参数,返回可以接受的文件字节范围和文件的总大小,他们格式如下:
<font style="color:rgb(51, 51, 51);background-color:rgb(248, 248, 248);">Content-Range: bytes (unit first byte </font>**<font style="color:rgb(51, 51, 51);">pos</font>**<font style="color:rgb(51, 51, 51);background-color:rgb(248, 248, 248);">) - [</font>**<font style="color:rgb(51, 51, 51);">last</font>**<font style="color:rgb(51, 51, 51);background-color:rgb(248, 248, 248);"> byte </font>**<font style="color:rgb(51, 51, 51);">pos</font>**<font style="color:rgb(51, 51, 51);background-color:rgb(248, 248, 248);">]/[entity legth]</font>
例如:
<font style="color:navy;">Content-Range</font><font style="color:rgb(51, 51, 51);background-color:rgb(248, 248, 248);">: bytes </font><font style="color:teal;">0</font><font style="color:rgb(51, 51, 51);background-color:rgb(248, 248, 248);">-</font><font style="color:teal;">499</font><font style="color:rgb(51, 51, 51);background-color:rgb(248, 248, 248);">/</font><font style="color:teal;">22400</font>_<font style="color:rgb(153, 153, 136);">// 0-499 是指当前发送的数据的范围,而 22400 则是文件的总大小。</font>_
不使用文件断点续传响应体内容:<font style="color:rgb(51, 51, 51);background-color:rgb(248, 248, 248);">HTTP/</font><font style="color:teal;">1.1200Ok</font>
使用文件断点续传响应体的内容:<font style="color:rgb(51, 51, 51);background-color:rgb(248, 248, 248);">HTTP/</font><font style="color:teal;">1.1206</font><font style="color:rgb(51, 51, 51);background-color:rgb(248, 248, 248);"> Partial </font><font style="color:navy;">Content</font>
服务器文件发生变化,会导致续传的请求是肯定是失败的,为了处理这种服务器文件资源发生改变的问题,在RFC2616中定义了Last-Modified和Etag来判断文件资源是否发生改变。
Etag&If-Range(文件唯一标志)
- Etag:作为文件唯一的标志,这个标志可以是文件的hash值或者是一个版本
- If-Range:用于判断实体是否发生改变,如果未改变,服务器发送客户端丢失的部分,否则发送整个实体,一般格式为:
If-Range: Etag | HTTP-Date
If-Range可以使用Etag或者Last-Modified返回的值,当没有ETag却有Last-Modified时,可以把Last-Modified作为If-Range的值 - 验证过程:
- step1:客户端发起续传请求,头部包含Range和If-Range参数
- step2:服务器中收到客户端的请求之后,将客户端与服务器的Etag进行对比
- 相等:请求文件资源没有发生变化,应答报文是206
- 不相等:请求文件资源发生变化,应答报文为200
OKHTTP断点下载
- step 1:判断检查本地是否有下载文件,若存在,则获取已下载的文件大小 downloadLength,若不存在,那么本地已下载文件的长度为 0
- step 2:获取将要下载的文件总大小(HTTP 响应头部的 content-Length)
- step 3:比对已下载文件大小和将要下载的文件总大小(contentLength),判断要下载的长度
- step 4:再即将发起下载请求的 HTTP 头部中添加即将下载的文件大小范围(Range: bytes = downloadLength - contentLength)
OKHTTP 简单短断点下载代码示例
java
/**
* String 在执行AsyncTask时需要传入的参数,可用于在后台任务中使用。
* Integer 后台任务执行时,如果需要在界面上显示当前的进度,则使用这里指定的泛型作为进度单位。
* Integer 当任务执行完毕后,如果需要对结果进行返回,则使用这里指定的泛型作为返回值类型。
*/
public class DownloadTask extends AsyncTask<String, Integer, Integer> {
public static final int TYPE_SUCCESS = 0;
public static final int TYPE_FAILED = 1;
public static final int TYPE_PAUSED = 2;
public static final int TYPE_CANCELED = 3;
private DownloadListener listener;
private boolean isCanceled = false;
private boolean isPaused = false;
private int lastProgress;
public DownloadTask(DownloadListener listener) {
this.listener = listener;
}
/**
* 这个方法中的所有代码都会在子线程中运行,我们应该在这里处理所有的耗时任务。
*
* @param params
* @return
*/
@Override
protected Integer doInBackground(String... params) {
InputStream is = null;
RandomAccessFile savedFile = null;
File file = null;
long downloadLength = 0; //记录已经下载的文件长度
//文件下载地址
String downloadUrl = params[0];
//下载文件的名称
String fileName = downloadUrl.substring(downloadUrl.lastIndexOf("/"));
//下载文件存放的目录
String directory = Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOWNLOADS).getPath();
//创建一个文件
file = new File(directory + fileName);
if (file.exists()) {
//如果文件存在的话,得到文件的大小
downloadLength = file.length();
}
//得到下载内容的大小
long contentLength = getContentLength(downloadUrl);
if (contentLength == 0) {
return TYPE_FAILED;
} else if (contentLength == downloadLength) {
//已下载字节和文件总字节相等,说明已经下载完成了
return TYPE_SUCCESS;
}
OkHttpClient client = new OkHttpClient();
/**
* HTTP请求是有一个Header的,里面有个Range属性是定义下载区域的,它接收的值是一个区间范围,
* 比如:Range:bytes=0-10000。这样我们就可以按照一定的规则,将一个大文件拆分为若干很小的部分,
* 然后分批次的下载,每个小块下载完成之后,再合并到文件中;这样即使下载中断了,重新下载时,
* 也可以通过文件的字节长度来判断下载的起始点,然后重启断点续传的过程,直到最后完成下载过程。
*/
Request request = new Request.Builder()
.addHeader("RANGE", "bytes=" + downloadLength + "-" + contentLength) //断点续传要用到的,指示下载的区间
.url(downloadUrl)
.build();
try {
Response response = client.newCall(request).execute();
if (response != null) {
is = response.body().byteStream();
savedFile = new RandomAccessFile(file, "rw");
savedFile.seek(downloadLength);//跳过已经下载的字节
byte[] b = new byte[1024];
int total = 0;
int len;
while ((len = is.read(b)) != -1) {
if (isCanceled) {
return TYPE_CANCELED;
} else if (isPaused) {
return TYPE_PAUSED;
} else {
total += len;
savedFile.write(b, 0, len);
//计算已经下载的百分比
int progress = (int) ((total + downloadLength) * 100 / contentLength);
//注意:在doInBackground()中是不可以进行UI操作的,如果需要更新UI,比如说反馈当前任务的执行进度,
//可以调用publishProgress()方法完成。
publishProgress(progress);
}
}
response.body().close();
return TYPE_SUCCESS;
}
} catch (IOException e) {
e.printStackTrace();
} finally {
try {
if (is != null) {
is.close();
}
if (savedFile != null) {
savedFile.close();
}
if (isCanceled && file != null) {
file.delete();
}
} catch (Exception e) {
e.printStackTrace();
}
}
return TYPE_FAILED;
}
/**
* 当在后台任务中调用了publishProgress(Progress...)方法之后,onProgressUpdate()方法
* 就会很快被调用,该方法中携带的参数就是在后台任务中传递过来的。在这个方法中可以对UI进行操作,利用参数中的数值就可以
* 对界面进行相应的更新。
*
* @param values
*/
@Override
protected void onProgressUpdate(Integer... values) {
int progress = values[0];
if (progress > lastProgress) {
listener.onProgress(progress);
lastProgress = progress;
}
}
/**
* 当后台任务执行完毕并通过Return语句进行返回时,这个方法就很快被调用。返回的数据会作为参数
* 传递到此方法中,可以利用返回的数据来进行一些UI操作。
*
* @param status
*/
@Override
protected void onPostExecute(Integer status) {
switch (status) {
case TYPE_SUCCESS:
listener.onSuccess();
break;
case TYPE_FAILED:
listener.onFailed();
break;
case TYPE_PAUSED:
listener.onPaused();
break;
case TYPE_CANCELED:
listener.onCanceled();
break;
default:
break;
}
}
public void pauseDownload() {
isPaused = true;
}
public void cancelDownload() {
isCanceled = true;
}
/**
* 得到下载内容的完整大小
*
* @param downloadUrl
* @return
*/
private long getContentLength(String downloadUrl) {
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder().url(downloadUrl).build();
try {
Response response = client.newCall(request).execute();
if (response != null && response.isSuccessful()) {
long contentLength = response.body().contentLength();
response.body().close();
return contentLength;
}
} catch (IOException e) {
e.printStackTrace();
}
return 0;
}
}
java
public class DownloadListener {
/**
* 通知当前的下载进度
* @param progress
*/
void onProgress(int progress);
/**
* 通知下载成功
*/
void onSuccess();
/**
* 通知下载失败
*/
void onFailed();
/**
* 通知下载暂停
*/
void onPaused();
/**
* 通知下载取消事件
*/
void onCanceled();
}