前言
斷點續傳是一個很傳統的話題;現在但凡包含下載功能的軟體,大部分都會有斷點續傳的功能;因此對於斷點續傳的實現,已經 有很多成熟的解決方案;對於Android開發來說更是這樣,github上有大量基於Java語言的斷點續傳框架;有很多庫結合Android Application 生命週期及Sqlite的實現,已經接近完美,使用起來幾行程式碼,兩三個回撥方法就可以很方便的實現檔案斷點下載的功能。
因此,這裡僅就斷點下載最基礎的知識做一個簡單的總結。
基本原理
斷點續傳,顧名思義就是下載檔案時不必每次都重新開始,可以從之前已經下載好的地方接著下載,這樣既可以省流量還能省時間。那麼怎麼樣才能做到呢?這就要靠RandomAccessFile 這個類了。
/**
* Allows reading from and writing to a file in a random-access manner. This is
* different from the uni-directional sequential access that a
* {@link FileInputStream} or {@link FileOutputStream} provides. If the file is
* opened in read/write mode, write operations are available as well. The
* position of the next read or write operation can be moved forwards and
* backwards after every operation.
*/
public class RandomAccessFile implements DataInput, DataOutput, Closeable {
.......
}複製程式碼
這是RandomAccessFile 這個類的定義。
那麼怎麼使用這個類呢?下面來看一個簡單的demo
public class RandomIoDemo {
private static int len;
public static void main(String[] args) throws Exception {
// 在磁碟中預先建立一個檔案,分配預定的空間
RandomAccessFile raf = new RandomAccessFile("result.txt", "rwd");
raf.setLength(1024); // 預分配 1kb 的檔案空間
raf.close();
// 所要寫入的檔案內容
String s1 = "第一個字串的內容";
String s2 = "第二個字串的內容";
String s3 = "第三個字串的內容";
String s4 = "第四個字串的內容";
String s5 = "第五個字串的內容";
len = s1.getBytes().length;
// 利用多執行緒同時寫入一個檔案
new FileWriteThread(0, s1.getBytes()).start();
new FileWriteThread(len, s2.getBytes()).start();
new FileWriteThread(len * 2, s3.getBytes()).start();
new FileWriteThread(len * 3, s4.getBytes()).start();
new FileWriteThread(len * 4, s5.getBytes()).start();
}
// 利用執行緒在檔案的指定位置寫入指定資料
private static class FileWriteThread extends Thread {
private int skip;
private byte[] content;
/**
*
* @param skip 寫入檔案需要跳過的位元組數
* @param content 寫入到檔案的內容
*/
private FileWriteThread(int skip, byte[] content) {
this.skip = skip;
this.content = content;
}
public void run() {
try {
FileChannel channel = new RandomAccessFile("result.txt", "rwd").getChannel();
MappedByteBuffer buffer = channel.map(FileChannel.MapMode.READ_WRITE, skip, len);
buffer.put(content);
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}
}複製程式碼
這個一個簡單的Java 實現,功能很簡單,就是把s1~s5,這幾個字串的內容寫入到result.txt 這個文字檔案中去;為了方便起見這幾個s1~s5這幾個字串的大小都是相同的;你可能會說這樣一個功能很簡單呀,用StringBuffer就可以實現,是可以;但是如果s1~s5 這幾個字串的長度很長,或者說要寫入到最終檔案的內容不是字串,而是音訊、圖片流之類的,那麼使用RandomAccessFile就可以展現出他的優勢了。一句話概括來說,RandomAccessFile 可以實現檔案從特定的位置進行讀寫。
基於OKHttp的斷點下載簡單實現
好了,RandomAccessFile只是提供了一種檔案型別,方便我們進行斷點續傳,那麼如果要實現斷點下載的功能,我們需要思考以下兩個問題。
首先,所有伺服器上的檔案都支援斷點下載嗎?怎麼判斷一個檔案是否支援斷點下載?。
其次,如果一個檔案支援斷點下載,那麼怎麼告知伺服器端,我要從哪個位元組開始下載?
好了,這兩個疑問可以通過下面的程式碼得到答案:
public class DownloadHelper {
public static OkHttpClient mClient = new OkHttpClient();
private static Call mCall;
public static void startDownload(int startPoint, int endPoint, Handler mHandler) {
Request request = new Request.Builder()
.url(Constants.PACKAGE_URL)
.header("RANGE", "bytes=" + startPoint + "-" + endPoint)
.build();
mCall = mClient.newCall(request);
mCall.enqueue(new OkHttpCallback(startPoint, mHandler));
}
public static void startDownload(int startPoint, Handler mHandler) {
Request request = new Request.Builder()
.url(Constants.PACKAGE_URL)
.header("RANGE", "bytes=" + startPoint + "-")
.build();
mCall = mClient.newCall(request);
mCall.enqueue(new OkHttpCallback(startPoint, mHandler));
}
public static void cancelDownload() {
if (mCall != null) {
mCall.cancel();
}
}
}複製程式碼
可以看到,通過設定Request物件的header方法的RANGE就可以告知伺服器端開始下載的節點;我們再看OkHttpCallback的實現
public class OkHttpCallback implements Callback {
private Handler mHandler;
private int startPoint;
public OkHttpCallback(int startPoint, Handler mHandler) {
this.startPoint = startPoint;
this.mHandler = mHandler;
}
@Override
public void onFailure(Call call, IOException e) {
mHandler.sendEmptyMessage(100);
}
@Override
public void onResponse(Call call, Response response) {
if (response.code() != HttpURLConnection.HTTP_PARTIAL) {
//返回code非206 ,不支援斷點續傳
mHandler.sendEmptyMessage(400);
return;
}
FileChannel fileChannel = null;
ResponseBody body = response.body();
int total = (int) body.contentLength();
int currentLength = 0;
InputStream inputStream = body.byteStream();
try {
RandomAccessFile randomAccessFile = new RandomAccessFile(Constants.FILE_PATH, "rws");
fileChannel = randomAccessFile.getChannel();
Log.e(TAG, "onResponse: startPoint=" + startPoint + " ,total=" + total);
MappedByteBuffer mappedByteBuffer = fileChannel.map(FileChannel.MapMode.READ_WRITE, startPoint, total);
int len;
byte[] buffer = new byte[1024];
while ((len = inputStream.read(buffer)) != -1) {
currentLength = currentLength + len;
mappedByteBuffer.put(buffer, 0, len);
Message msg = Message.obtain();
msg.arg1 = total;
msg.arg2 = currentLength;
msg.what = 300;
mHandler.sendMessage(msg);
}
} catch (IOException e) {
e.printStackTrace();
} finally {
try {
inputStream.close();
if (fileChannel != null) {
fileChannel.close();
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
}複製程式碼
在onResponse 回撥方法中我們可以看到,當我們在之前的head中新增了RANGE欄位,但是如果返回的http code不是206是,我們就可以確定所請求的檔案是不支援斷點下載的。
現在就可以非常方便的實現一個簡單的斷點續傳功能了。
class MyHandler extends Handler {
@Override
public void handleMessage(Message msg) {
super.handleMessage(msg);
switch (msg.what) {
case 400:
Toast.makeText(mContext, "不支援斷點續傳", Toast.LENGTH_SHORT).show();
break;
case 100:
Toast.makeText(mContext, "fail", Toast.LENGTH_SHORT).show();
break;
case 300:
int total = msg.arg1;
int current = msg.arg2;
if (!isPause && !isStop) {
totalValue = current + breakPointValue;
int percent = (int) (totalValue * 100f / (total + breakPointValue));
if (percent < 100) {
mProgressBar.setProgress(percent);
progressValue.setText(String.valueOf(percent));
} else {
Intent intent = new Intent(Intent.ACTION_VIEW);
intent.setDataAndType(Uri.parse("file://" + Constants.FILE_PATH),
"application/vnd.android.package-archive");
mContext.startActivity(intent);
resetStatus();
}
}
break;
default:
break;
}
}
}
isPause=true;
pause.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
if (isPause) {
pause.setImageResource(R.drawable.ic_pause_circle_outline_black_24dp);
DownloadHelper.startDownload(breakPointValue, mMyHandler);
} else {
pause.setImageResource(R.drawable.ic_play_circle_outline_black_24dp);
DownloadHelper.cancelDownload();
breakPointValue = totalValue;
}
isPause = !isPause;
}
});複製程式碼
breakPointValue 這個變數記錄了每次暫停下載時,斷點位置已完成的下載量,第一次開始下載時他的初始值為0,因此便開始從頭下載這個檔案,並通過Handler依次累加已經完成的下載量totalValue, 同時更新下載進度;當暫停時,停止下載任務;breakPointValue的值就是此刻的總下載量,再次點選繼續下載,此時breakPointValue就會從上次斷掉的位置開始新一次的下載任務;依次類推直到下載完成。這樣,就簡單的完成了一個檔案的斷點下載任務。
這個實現很簡單,這裡再總結一下需要注意的地方:
使用APK 型別的檔案,作為斷點下載的測試非常有針對性,如果斷點續傳的過程中資料錯誤或丟失,將導致最終下載的完成的APK 檔案破損,無法安裝。
在Http的ResponseBody中,contentLength 的值不是一成不變的,他每次返回的值,並不是當前所請求檔案實際的大小,而是此次請求能夠傳輸的大小,也就是從檔案總大小-RANGE 所包含的大小。因此,需要每次把上一次暫停時breakPointValue的值作為下一次累加值的基數。
好了,這就是關於斷點下載的簡單總結。另附Github 原始碼地址,有需要的可以檢視。