斷點續傳下載原理實現

需求背景

• 動態創建的文件下載的時候希望瀏覽器顯示下載進度
• 動態創建的文件希望能夠分段下載

HTTP斷點續傳報文

要實現HTTP斷點續傳必須要簡單瞭解以下幾個報文。

• Accept-Ranges 告訴客戶端(瀏覽器..)伺服器端支持斷點續傳 伺服器端返回
• Range 客戶端告訴伺服器端從指定的的位置/範圍(這裡值位元組數)下載資源 客戶端發出
• Content-Range 伺服器端告訴客戶端響應的數據信息，在整個返回體中本部分的位元組位置 伺服器端返回
• ETag 資源標識 非必須 伺服器端返回
• Last-Modified 資源最後一次更新的時間 非必須 伺服器端返回

Range 的範圍格式

1. 表示0-499個位元組範圍：Range: bytes=0-499
2. 表示最後500個位元組範圍：Range: bytes=-500
3. 表示500位元組開始到結束範圍：Range: bytes=500-
4. 表示第一個和最後一個位元組：Range: bytes=0-0,-1
5. 表示同時指定幾個範圍：Range: bytes=500-600,601-999

Content-Range 的數據格式

Content-Range: bytes 0-499/22036 ：表示返回0-499位元組範圍數據 資源一共22036個位元組

原理

1. 客戶端發起請求 設置Range指定開始位元組數或結束位元組數 如果是從0開始也可以不用設置。
2. 伺服器端檢查到客戶端Range頭 解析開始位元組數以及結束位元組數 並返回報文頭 Accept-Ranges表示支持斷點續傳，Content-Range記錄該次向客戶端寫入流的位置信息，然後再寫入流到客戶端。
3. 服務端可以使用ETag Last-Modified 標記一下資源是否被修改。作一些驗證工作，如果驗證不通過則返回錯誤，非必須項。

java實現

 OutputStream os=null;
    InputStream inputStream =null;
    File zipFile=null;
    try{
        long zipStart=System.currentTimeMillis();
        zipFile=createFile();//動態根據業務創建文件
        if(logger.isInfoEnabled()){
            logger.info(String.format("壓縮ZIP 花費時間 %s(s) ",
        (System.currentTimeMillis()-zipStart)/1000));
        }
        if (zipFile.exists()) {
            long downloadStart=System.currentTimeMillis();
            inputStream= new BufferedInputStream(new FileInputStream(zipFile));
            response.reset();
            os=new BufferedOutputStream(response.getOutputStream());
            String userAgent = request.getHeader("USER-AGENT");
            String fileName=zipFile.getName();
            if (null != userAgent && -1 != userAgent.indexOf("MSIE")) {
                fileName = URLEncoder.encode(fileName, "UTF8");
            } else if (null != userAgent && -1 != userAgent.indexOf("Mozilla")) {
                fileName = new String(fileName.getBytes("utf-8"), "ISO-8859-1");
            }
            response.setHeader("Accept-Ranges", "bytes");
            response.setHeader("Content-Disposition", 
        "attachment;filename="+ fileName);
            response.setContentType(MediaType.APPLICATION_OCTET_STREAM_VALUE);
            long pos = 0, fileSize=zipFile.length(),
    last=fileSize-1;
            response.setHeader("ETag",zipFile.getName().
         concat(Objects.toString(fileSize))
                    .concat("_").concat(Objects.toString(zipFile.lastModified())));
            response.setDateHeader("Last-Modified",zipFile.lastModified());
            response.setDateHeader("Expires",
            System.currentTimeMillis()+1000*60*60*24);
            if (null != request.getHeader("Range")) {
                response.setStatus(HttpServletResponse.SC_PARTIAL_CONTENT);
                try {
                    // 暫時只處理這2種range格式 1、RANGE: bytes=111- 2、Range: bytes=0-499
                    String numRang = request.getHeader("Range")
            .replaceAll("bytes=", "");
                    String[] strRange = numRang.split("-");
                    if (strRange.length == 2) {
                        pos = Long.parseLong(strRange[0].trim());
                        last = Long.parseLong(strRange[1].trim());
                    } else {
                        pos = Long.parseLong(numRang.replaceAll("-", "").trim());
                    }
                } catch (NumberFormatException e) {
                    logger.error(request.getHeader("Range") + " error");
                    pos = 0;
                }
            }
            long rangLength = last - pos + 1;
            String contentRange = new StringBuffer("bytes ").
            append(String.valueOf(pos)).
            append("-").append(last).append("/").
            append(String.valueOf(fileSize)).toString();
            response.setHeader("Content-Range", contentRange);
            response.addHeader("Content-Length",Objects.toString(rangLength));
            if(pos>0){
                inputStream.skip(pos);
            }
            byte[] buffer = new byte[1024*512];//每次以512KB 0.5MB的流量下載
            int length = 0,sendTotal=0;
            while (sendTotal < rangLength && length!=-1) {
                length = inputStream.read(buffer, 0,
        ((rangLength - sendTotal) <= buffer.length ?
                        ((int) (rangLength - sendTotal)) : buffer.length));
                sendTotal = sendTotal + length;
                os.write(buffer, 0, length);
            }
            if(os!=null){
                os.flush();
            }
            if(logger.isInfoEnabled()){
                logger.info(String.format("下載 花費時間 %s(s) ",
        (System.currentTimeMillis()-downloadStart)/1000));
            }
        }
    }catch (Exception e){
        if(StringUtils.endsWithIgnoreCase(e.getMessage(),"Broken pipe")){
            logger.error("用戶取消下載");
        }
        logger.error(e.getMessage(),e);
    }finally {
        if(os!=null){
            try{
                os.close();
            }catch (Exception e){}
        }
        if(inputStream!=null){
            try{
                IOUtils.closeQuietly(inputStream);
            }catch (Exception e){}
        }
    }
}

比如google瀏覽器下載的時候就能看到下載進度以及暫停下載和恢復下載操作，也可以設置Range測試分段下載。