Java 断点下载(下载续传)服务端及客户端（Android）代码 ...

原文: Java 断点下载(下载续传)服务端及客户端（Android）代码 - Stars-One的杂货小窝

最近在研究断点下载(下载续传)的功能,此功能需要服务端和客户端进行对接编写,本篇也是记录一下关于贴上关于实现服务端(Spring Boot)与客户端(Android)是如何实现下载续传功能
断点下载功能(下载续传)解释:

客户端由于突然性网络中断等原因,导致的下载失败,这个时候重新下载,可以继续从上次的地方进行下载,而不是重新下载

原理

首先，我们先说明了断点续传的功能,实际上的原理比较简单

客户端和服务端规定好一个规则,客户端传递一个参数,告知服务端需要数据从何处开始传输,服务端接收到参数进行处理,之后文件读写流从指定位置开始传输给客户端

实际上,上述的参数,在http协议中已经有规范,参数名为Range
而对于服务端来说，只要处理好Range请求头参数，即可实现下载续传的功能
我们来看下Range请求头数据格式如下：
格式如下：

1. Range:bytes=300-800
2. //客户端需要文件300-800字节范围的数据（即500B数据）
4. Range:bytes=300-
5. //客户端需要文件300字节之后的数据

复制代码

我们根据上面的格式，服务端对Range字段进行处理(String字符串数据处理),在流中返回指定的数据大小即可
那么，如何让流返回指定的数据大小或从指定位置开始传输数据呢?
这里,Java提供了RandomAccessFile类,通过seekTo()方法,可以让我们将流设置从指定位置开始读取或写入数据
这里读取和写入数据,我是采用的Java7之后新增的NIO的Channel进行流的写入（当然，用传统的文件IO流(BIO)也可以）
这里,我所说的客户端是指的Android客户端,由于App开发也是基于Java,所以也是可以使用RandomAccessFile这个类
对于客户端来说，有以下逻辑：

先读取本地已下载文件的大小，然后请求下载数据将文件大小的数据作为请求头的数值传到服务端，之后也是利用RandomAccessFile移动到文件的指定位置开始写入数据即可

扩展-大文件快速下载思路

利用上面的思路，我们还可以可以得到一个大文件快速下载的思路：
如，一份文件，大小为2000B（这个大小可以通过网络请求，从返回数据的请求头content-length获取获取）
客户端拿回到文件的总大小,根据调优算法,将平分成合适的N份，通过线程池，来下载这个N个单文件
在下载完毕之后，将N个文件按照顺序合并成单个文件即可
代码

上面说明了具体的思路,那么下面就是贴出服务端和客户端的代码示例
服务端

服务端是采用的spring boot进行编写

1. /**
2. * 断点下载文件
3. *
4. * @return
5. */
6. @GetMapping("download")
7. public void download( HttpServletRequest request, HttpServletResponse response) throws IOException {
8.     //todo 这里文件按照你的需求调整
9.     File file = new File("D:\\temp\\测试文件.zip");
10.     if (!file.exists()) {
11.         response.setStatus(HttpStatus.NOT_FOUND.value());
12.         return;
13.     }
14.     long fromPos = 0;
15.     long downloadSize = file.length();
17.     if (request.getHeader("Range") != null) {
18.         response.setStatus(HttpServletResponse.SC_PARTIAL_CONTENT);
19.         String[] ary = request.getHeader("Range").replaceAll("bytes=", "").split("-");
20.         fromPos = Long.parseLong(ary[0]);
21.         downloadSize = (ary.length < 2 ? downloadSize : Long.parseLong(ary[1])) - fromPos;
22.     }
23.     //注意下面设置的相关请求头
24.     response.setContentType(MediaType.APPLICATION_OCTET_STREAM_VALUE);
25.     //相当于设置请求头content-length
26.     response.setContentLengthLong(downloadSize);
28.     //使用URLEncoder处理中文名(否则会出现乱码)
29.     response.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(file.getName(), "UTF-8"));
30.     response.setHeader("Accept-Ranges", "bytes");
31.     response.setHeader("Content-Range", String.format("bytes %s-%s/%s", fromPos, (fromPos + downloadSize), downloadSize));
33.     RandomAccessFile randomAccessFile = new RandomAccessFile(file, "rw");
34.     randomAccessFile.seek(fromPos);
36.     FileChannel inChannel = randomAccessFile.getChannel();
37.     WritableByteChannel outChannel = Channels.newChannel(response.getOutputStream());
39.     try {
40.         while (downloadSize > 0) {
41.             long count = inChannel.transferTo(fromPos, downloadSize, outChannel);
42.             if (count > 0) {
43.                 fromPos += count;
44.                 downloadSize -= count;
45.             }
46.         }
47.         inChannel.close();
48.         outChannel.close();
49.         randomAccessFile.close();
50.     } catch (IOException e) {
51.         e.printStackTrace();
52.     }
53. }

复制代码

客户端

Android客户端,是基于Okhttp的网络框架写的，需要先引用依赖

1. implementation 'com.squareup.okhttp3:okhttp:3.9.0'

复制代码

下面给出的是封装好的方法（含进度，下载失败和成功回调）：

1. package com.tyky.update.utils;
3. import com.blankj.utilcode.util.ThreadUtils;
5. import java.io.File;
6. import java.io.IOException;
7. import java.io.InputStream;
8. import java.io.RandomAccessFile;
9. import java.math.BigDecimal;
10. import java.nio.ByteBuffer;
11. import java.nio.channels.Channels;
12. import java.nio.channels.FileChannel;
13. import java.nio.channels.ReadableByteChannel;
15. import okhttp3.Call;
16. import okhttp3.OkHttpClient;
17. import okhttp3.Request;
18. import okhttp3.Response;
20. public class FileDownloadUtil {
22.     public static void download(String url, File file, OnDownloadListener listener) {
24.         //http://10.232.107.44:9060/swan-business/file/download
25.         // 利用通道完成文件的复制(非直接缓冲区)
26.         ThreadUtils.getIoPool().submit(new Runnable() {
27.             @Override
28.             public void run() {
29.                 try {
31.                     //续传开始的进度
32.                     long startSize = 0;
33.                     if (file.exists()) {
34.                         startSize = file.length();
35.                     }
36.                     OkHttpClient okHttpClient = new OkHttpClient.Builder().build();
37.                     Request request = new Request.Builder().url(url)
38.                             .addHeader("Range", "bytes=" + startSize)
39.                             .get().build();
40.                     Call call = okHttpClient.newCall(request);
41.                     Response resp = call.execute();
43.                     double length = Long.parseLong(resp.header("Content-Length")) * 1.0;
44.                     InputStream fis = resp.body().byteStream();
45.                     ReadableByteChannel fisChannel = Channels.newChannel(fis);
47.                     RandomAccessFile randomAccessFile = new RandomAccessFile(file, "rw");
48.                     //从上次未完成的位置开始下载
49.                     randomAccessFile.seek(startSize);
50.                     FileChannel foschannel = randomAccessFile.getChannel();
52.                     // 通道没有办法传输数据，必须依赖缓冲区
53.                     // 分配指定大小的缓冲区
54.                     ByteBuffer byteBuffer = ByteBuffer.allocate(1024);
56.                     // 将通道中的数据存入缓冲区中
57.                     while (fisChannel.read(byteBuffer) != -1) {  // fisChannel 中的数据读到 byteBuffer 缓冲区中
58.                         byteBuffer.flip();  // 切换成读数据模式
59.                         // 将缓冲区中的数据写入通道
60.                         foschannel.write(byteBuffer);
62.                         final double progress = (foschannel.size() / length);
63.                         BigDecimal two = new BigDecimal(progress);
64.                         double result = two.setScale(2,BigDecimal.ROUND_HALF_UP).doubleValue();
65.                         //计算进度，回调
66.                         if (listener != null) {
67.                             listener.onProgress(result);
68.                         }
69.                         byteBuffer.clear();  // 清空缓冲区
70.                     }
71.                     foschannel.close();
72.                     fisChannel.close();
73.                     randomAccessFile.close();
75.                     if (listener != null) {
76.                         listener.onSuccess(file);
77.                     }
78.                 } catch (IOException e) {
79.                     if (listener != null) {
80.                         listener.onError(e);
81.                     }
83.                 }
84.             }
85.         });
88.     }
90.     public interface OnDownloadListener {
91.         void onProgress(double progress);
93.         void onError(Exception e);
95.         void onSuccess(File outputFile);
96.     }
97. }

复制代码

使用：

1. FileDownloadUtil.download(downloadUrl, file, new FileDownloadUtil.OnDownloadListener() {
2.     @Override
3.     public void onProgress(double progress) {
4.         KLog.d("下载进度: " + progress);
5.     }
7.     @Override
8.     public void onError(Exception e) {
9.         KLog.e("下载错误: " + e.getMessage());
10.     }
12.     @Override
13.     public void onSuccess(File outputFile) {
14.         KLog.d("下载成功");
15.     }
16. });

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！