Spring Boot 实现文件断点下载，实战来了！

来源：juejin.cn/post/7026372482110079012
前言

互联网的连接速度慢且不稳定，有可能由于网络故障导致断开连接。
在客户端下载一个大对象时，因网络断开导致上传下载失败的概率就会变得不可忽视。

客户端在GET对象请求时通过设置Range头部来告诉接口服务需要从什么位置开始输出对象的数据。
判断是否支持断点下载，根据文档：14.35.1 Byte Rangeshttps://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

1. // 直接判断是否有 Accept-Ranges = bytes
2. boolean support = urlConnection.getHeaderField("Accept-Ranges").equals("bytes");
3. System.out.println("Partial content retrieval support = " + (support ? "Yes" : "No));

复制代码

例如：

1. donald@donald-pro:~$ curl -i --range 0-9 http://localhost:8080/file/chunk/download
2. HTTP/1.1 206
3. Accept-Ranges: bytes
4. Content-Disposition: inline;filename=pom.xml
5. Content-Range: bytes 0-9/13485
6. Content-Length: 10
7. Date: Mon, 01 Nov 2021 09:53:25 GMT

复制代码

直接判断头部 HEAD，例如：

HeadObject 接口用于获取某个文件（Object）的元信息。使用此接口不会返回文件内容。

1. HEAD /ObjectName HTTP/1.1
2. Host: BucketName.oss-cn-hangzhou.aliyuncs.com
3. Date: GMT Date
4. Authorization: SignatureValue

复制代码

需知，对应 HTTP 状态码：

• 206 Partial Content：HTTP Range 请求成功
  
• 416 Requested Range Not Satisfiable status：HTTP Range 请求超出界限
  
• 200 OK：不支持范围请求
  

小结如下：

• HTTP 范围请求：需要 HTTP/1.1 及之上支持，如果双端某一段低于此版本，则认为不支持。
  
• 通过响应头中的 Accept-Ranges 来确定是否支持范围请求。
  
• 通过在请求头中添加 Range 这个请求头，来指定请求的内容实体的字节范围。
  
• 在响应头中，通过 Content-Range 来标识当前返回的内容实体范围，并使用 Content-Length 来标识当前返回的内容实体范围长度。
  
• 在请求过程中，可以通过 If-Range 来区分资源文件是否变动，它的值来自 ETag 或者 Last-Modifled。如果资源文件有改动，会重新走下载流程。
  

生产实战

开发也得依靠依据，设定好边界，才能掌控全局。
有现成的文档，来看阿里云文档https://help.aliyun.com/document_detail/39571.html

• Range: bytes=0-499：表示第0~499字节范围的内容。
  
• Range: bytes=500-999：表示第500~999字节范围的内容。
  
• Range: bytes=-500：表示最后500字节的内容。
  
• Range: bytes=500-：表示从第500字节开始到文件结束部分的内容。
  
• Range: bytes=0-：表示第一个字节到最后一个字节，即完整的文件内容。
  

HTTP Range 是否合法对应处理：

• 如果 HTTP Range 请求合法，响应返回值为 206 并在响应头中包含 Content-Range
  
• 如果 HTTP Range 请求不合法，或者指定范围不在有效区间，会导致 Range 不生效，响应返回值为200，并传送整个 Object 内容。
  

如下为 HTTP Range 请求不合法的示例及错误说明: 假设 Object 资源大小为1000字节，Range 有效区间为0~999

• Range: byte=0-499：格式错误，byte 应为 bytes。
  
• Range: bytes=0-1000：末字节 1000 超出有效区间。
  
• Range: bytes=1000-2000：指定范围超出有效区间。
  
• Range: bytes=1000-：首字节超出有效区间。
  
• Range: bytes=-2000：指定范围超出有效区间。
  

举一些栗子：

1. # 正常范围下载
2. donald@donald-pro:~$ curl -i --range 0-9 http://localhost:8080/file/chunk/download
3. HTTP/1.1 206
4. Accept-Ranges: bytes
5. Content-Disposition: inline;filename=Screen_Recording_20211101-162729_Settings.mp4
6. Content-Range: bytes 0-9
7. Content-Type: application/force-download;charset=UTF-8
8. Content-Length: 16241985
9. Date: Wed, 03 Nov 2021 09:50:50 GMT

复制代码

服务端 - 业务开发

这里以 SpringBoot 为栗子，Spring Boot 基础就不介绍了，推荐看这个实战项目：

https://github.com/javastacks/spring-boot-best-practice

• 对外支持 range 下载
  
• 底层存储：使用 ceph
  
• Controller 如下：
  

1. @Slf4j
2. @RestController
3. public class Controller {
4.     @Autowired
5.     private FileService fileService;
7.     /**
8.      * 下载文件
9.      *
10.      * 对外提供
11.      *
12.      * @param fileId 文件Id
13.      * @param token token
14.      * @param accountId 帐号Id
15.      * @param response 响应
16.      */
17.     @GetMapping("/oceanfile/download")
18.     public void downloadOceanfile(@RequestParam String fileId,
19.                                   @RequestHeader(value = "Range") String range,
20.                                   HttpServletResponse response) {
22.         this.fileService.downloadFile(fileId, response, range);
23.     }
24. }

复制代码

• Service 如下：
  

1. @Slf4j
2. @Service
3. public class FileService {
4.     @Autowired
5.     private CephUtils cephUtils;
7.     /**
8.      * 直接下载文件
9.      *
10.      * Tips： 支持断点下载
11.      * @param fileId 文件Id
12.      * @param response 返回
13.      * @param range 范围
14.      */
15.     public void downloadFile(String fileId, HttpServletResponse response, String range) {
16.         // 根据 fileId 获取文件信息
17.         FileInfo fileInfo = getFileInfo(fileId);
19.         String bucketName = fileInfo.getBucketName();
20.         String relativePath = fileInfo.getRelativePath();
22.         // 处理 range，范围信息
23.         RangeDTO rangeInfo = executeRangeInfo(range, fileInfo.getFileSize());
25.         // rangeInfo = null，直接下载整个文件
26.         if (Objects.isNull(rangeInfo)) {
28.             cephUtils.downloadFile(response, bucketName, relativePath);
29.             return;
30.         }
31.         // 下载部分文件
32.         cephUtils.downloadFileWithRange(response, bucketName, relativePath, rangeInfo);
33.     }
35.     private RangeDTO executeRangeInfo(String range, Long fileSize) {
37.         if (StringUtils.isEmpty(range) || !range.contains("bytes=") || !range.contains("-")) {
39.             return null;
40.         }
42.         long startByte = 0;
43.         long endByte = fileSize - 1;
45.         range = range.substring(range.lastIndexOf("=") + 1).trim();
46.         String[] ranges = range.split("-");
48.         if (ranges.length <= 0 || ranges.length > 2) {
50.             return null;
51.         }
53.         try {
54.             if (ranges.length == 1) {
55.                 if (range.startsWith("-")) {
57.                     //1. 如：bytes=-1024  从开始字节到第1024个字节的数据
58.                     endByte = Long.parseLong(ranges[0]);
59.                 } else if (range.endsWith("-")) {
61.                     //2. 如：bytes=1024-  第1024个字节到最后字节的数据
62.                     startByte = Long.parseLong(ranges[0]);
63.                 }
64.             } else {
65.                 //3. 如：bytes=1024-2048  第1024个字节到2048个字节的数据
66.                 startByte = Long.parseLong(ranges[0]);
67.                 endByte = Long.parseLong(ranges[1]);
68.             }
69.         } catch (NumberFormatException e) {
70.             startByte = 0;
71.             endByte = fileSize - 1;
72.         }
74.         if (startByte >= fileSize) {
76.             log.error("range error, startByte >= fileSize. " +
77.                     "startByte: {}, fileSize: {}", startByte, fileSize);
78.             return null;
79.         }
81.         return new RangeDTO(startByte, endByte);
82.     }
83. }

复制代码

以上内容，大家可以收藏起来，如果以后遇到这样的场景，分分钟搞定！
近期热文推荐：
1.1,000+ 道 Java面试题及答案整理(2022最新版)
2.劲爆！Java 协程要来了。。。
3.Spring Boot 2.x 教程，太全了！
4.别再写满屏的爆爆爆炸类了，试试装饰器模式，这才是优雅的方式！！
5.《Java开发手册（嵩山版）》最新发布，速速下载！
觉得不错，别忘了随手点赞+转发哦！

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