Android - OkHttp实现的断点续传

Posted 2022-03-28 沈页

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Android - OkHttp实现的断点续传相关的知识，希望对你有一定的参考价值。

由于阿里大佬的对象存储OSS服务安卓端没有断点续传的功能，看了一下ios端的实现方案，结合网上的资料整理和实现了安卓端的断点续传。

参考 developer.aliyun.com/article/630…

关键要点

在发起HTTP请求中加入Range请求头

Range: bytes=100- 从 101 bytes 之后开始传，一直传到最后。
Range: bytes=100-200 指定开始到结束这一段的长度，记住 Range 是从 0 计数的，所以这个是要求服务器从 101 字节开始传，一直到 201 字节结束。这个一般用来特别大的文件分片传输，比如视频。
Range: bytes=-100 如果范围没有指定开始位置，就是要服务器端传递倒数 100 字节的内容。而不是从 0 开始的 100 字节。
Range: bytes=0-100, 200-300 也可以同时指定多个范围的内容，这种情况不是很常见。

关键代码

下载前校验准备

/**
 * 获取下载内容的大小
 * @param downloadUrl 文件地址
 * @return 文件字节长度
 */
private fun getContentLength(downloadUrl: String): Long 
    val request = Request.Builder().url(downloadUrl).build()
    try 
        val response = client.newCall(request).execute()
        if (response != null && response.isSuccessful) 
            val contentLength = response.body()?.contentLength() ?: 0L
            response.body()?.close()
            return contentLength
        
     catch (e: IOException) 
        e.printStackTrace()
    
    return 0L


/**
 * 下载请求
 * @param fileName 文件名称
 * @param sourceFileName 文件名称
 * @param fileUrl 文件完整地址
 */
private fun downLoadFile(sourceFileName: String,fileName:String, fileUrl: String) 
    //已经下载的文件长度,初始化为0
    //(续载的关键点 = 每次下载的起始位置)
    var downloadLength = 0L
    //下载路径 + 文件名 在本地创建一个文件
    val file = File(downloadFileCacheDir + sourceFileName)
    if (file.exists()) 
        //如果文件存在，得到文件大小
        downloadLength = file.length()
    
    //得到下载内容的大小
    val contentLength = getContentLength(fileUrl)
    if (contentLength == 0L) 
        //从内存中移除下载任务
        ossFileMap.remove(fileName)
        downLoadTaskMap.remove(fileName)
        onListenerCallBackError(ErrorCode.ERROR_DATA_NULL, "文件错误，长度为0")
        return
     else if (contentLength == downloadLength) 
        //已下载字节和文件总字节相等，说明已经下载完成了
        ossFileMap.remove(fileName)
        downLoadTaskMap.remove(fileName)
        onListenerCallBackProcess(fileName, contentLength, contentLength)
        onListenerCallBackSuccess(fileName)
        return
    

    val request = Request.Builder()
            .url(fileUrl)
            .addHeader("RANGE", "bytes=$downloadLength-")//续传关键(请求头增加)
            .build()
    Logger.d("Down下载：Range = $downloadLength")
    val call = client.newCall(request)
    //加入传载队列
    downLoadTaskMap[fileName] = call
    saveFile(call,file, downloadLength, fileName, contentLength)

写入文件

/**
 * 写入文件到本地
 * @param call 请求回调
 * @param file 需要写入的本地文件
 * @param downloadLength 已下载文件长度
 * @param contentLength 文件总长度
 */
private fun saveFile(call: Call, file: File?, downloadLength: Long, fileName: String, contentLength: Long) 
    var inputStream: InputStream? = null
    var savedFile: RandomAccessFile? = null
    val response = call.execute()
    try 
        if (response != null) 
            inputStream = response.body()?.byteStream()
            savedFile = RandomAccessFile(file, "rw")
            //跳过已经下载的字节
            savedFile.seek(downloadLength)
            //每次缓存字节数
            val byteArray = ByteArray(1024)
            var total = 0
            var len: Int = -1
            while (inputStream?.read(byteArray)?.also  len = it  != -1) 
                //执行缓存前都需判断该任务是否被暂停
                if (call.isCanceled) 
                    Logger.d("Down:$fileName下载任务已取消")
                    return
                 else 
                    total += len
                    savedFile.write(byteArray, 0, len)
                    //本次下载总长
                    val currentSize = total + downloadLength
                    //回调进度
                    onListenerCallBackProcess(fileName, currentSize, contentLength)
                    //长度相等则返回成功
                    if (currentSize == contentLength) 
                        response.body()?.close()
                        Logger.d("Down:success")
                        //文件与本地路径字典记录到数据库
                        filesLocalService.saveDownPathData(DownLoadFilesValue().apply 
                            this.fileName = fileName
                            this.filePath = file?.path
                        )
                        ossFileMap.remove(fileName)
                        downLoadTaskMap.remove(fileName)
                        //删除本地传载列表
                        deleteFormLocal(fileName)
                        //成功回调
                        onListenerCallBackSuccess(fileName)
                    
                
            
            response.body()?.close()
        
     catch (e: Exception) 
        //发生异常时关闭该下载任务
        ossFileMap.remove(fileName)
        downLoadTaskMap.remove(fileName)
        //失败回调
        onListenerCallBackError(ErrorCode.ERROR_EXCEPTION, e.message)
     finally 
        try 
            inputStream?.close()
            savedFile?.close()
         catch (e: Exception) 
            e.printStackTrace();