Okhttp 下载支持GZIP的文件不能获取进度的问题

情境是这样:

    val url = "某个文件的下载地址"
    val request = Request.Builder().get().url(url).build()
    val okhttp = OkHttpClient()
    val response = okhttp.newCall(request).execute()
    println("content-length:${response.body?.contentLength()}")

打印的结果是"content-length:-1"
但是抓包发现response.header中content-length是有值的
那么为什么会出现这种情况呢?
分为以下两种情况?

  1. 在没有设置header "Accept-Encoding:gzip"的情况,okhttp 会自动加上,这时候得到的reponse.body.contentLength() 是-1
    response.body.byteStream() 得到的是okhttp 自动帮我们解压后的流

  2. 在设置了"Accept-Encoding:gzip"的情况,okhttp不会再自动添加"Accept-Encoding"header了,这时候得到的reponse.body.contentLength()是gzip 压缩后的文件大小。
    response.body.byteStream() 是需要使用GZipInputStream解压缩的

那么为什么会这样呢?
是因为okhttp的原则是系统优化网络,所以会默认添加"Accept-Encoding:gzip",但是这个时候,response.header中的"content-length"返回的是压缩后的文件大小,而response.body().byteStream() 是okhttp 帮我们gzip解压之后流的,这个流的长度和"content-length"返回的长度是对不上的,因为一个是压缩前的文件大小,一个是压缩后的文件大小,而压缩前的文件大小之后读取完毕之后才能知道,所以okhttp 中reponse.body.contentLength() 得到是-1,是在告诉我们它也不知道文件到底多大。

怎么解决呢?有两种方法

  1. 设置 header 中的Accept-Encoding="",这样即可得到正常的长度,但是因为不启用gzip所以下载速度会变慢
  2. 第二种,主动设置"Accept-Encoding:gzip",并自己去处理gzip解压的问题
internal typealias DownloadProgress = (Int) -> Unit

private const val LOG_TAG = "PdfDownloader"

internal class PdfDownloader(
    private val pdfDesc: PdfDesc,
    private val okHttpClient: OkHttpClient,
    private val downloadProgress: DownloadProgress
) {
    private var progress: Int = 0

    @WorkerThread
    @Throws(IOException::class)
    fun download(targetFile: File) {
        val request = Request.Builder()
            .get()
            .addHeader("Accept-Encoding", "gzip")添加了就需要自己处理gzip了
            .url(pdfDesc.uri.toString())
            .build()
        val response = okHttpClient.newCall(request).execute()
        if (!response.isSuccessful) {
            throw IOException("request fail,response code:${response.code}")
        }
        val body = response.body ?: throw IOException("empty body")
        targetFile.parentFile?.mkdirs()
        if (response.headers("content-encoding").contains("gzip")) {
            // 服务器支持gzip,先下载到临时文件中,再解压
            val tempFile = File(targetFile.parent, "${targetFile.name}.gzip").also {
                it.delete()
                it.deleteOnExit()
            }
            // 下载文件
            using {
                val netIS = body.byteStream().autoClose()
                val tempOs = tempFile.outputStream().buffered().autoClose()
                netIS.copyTo(body.contentLength(), tempOs)
            }
            // gzip 解压
            using {
                val gzipIS = GZIPInputStream(tempFile.inputStream()).buffered().autoClose()
                val targetOS = targetFile.outputStream().buffered().autoClose()
                gzipIS.copyTo(targetOS)
            }
            tempFile.delete()
        } else {
            // 服务器不支持gzip,直接下载文件
            using {
                val netIS = body.byteStream().autoClose()
                val tempOs = targetFile.outputStream().buffered().autoClose()
                netIS.copyTo(body.contentLength(), tempOs)
            }
        }

    }

    private fun InputStream.copyTo(totalLength: Long, out: OutputStream): Long {
        var bytesCopied: Long = 0
        val buffer = ByteArray(DEFAULT_BUFFER_SIZE)
        var bytes = read(buffer)
        while (bytes >= 0) {
            out.write(buffer, 0, bytes)
            bytesCopied += bytes
            if (totalLength > 0) {
                val progress = (bytesCopied * 100 / totalLength).toInt()
                if (progress != [email protected]) {
                    [email protected] = progress
                    Timber.tag(LOG_TAG).d("download progress:${progress}")
                    downloadProgress(progress)
                }
            }
            bytes = read(buffer)
        }
        return bytesCopied
    }
}

/*
* 以下代码用来优雅的关闭多个流
*/
internal fun  using(block: ResourceHolder.() -> R): R {
    return ResourceHolder().use { it.block() }
}

internal class ResourceHolder : Closeable {

    private val resources = arrayListOf()

    fun  T.autoClose(): T {
        resources.add(this)
        return this
    }

    override fun close() {
        resources.reversed().forEach { it.close() }
    }
}

希望遇到类似问题能帮到你,有问题,请向我提问。

你可能感兴趣的:(Okhttp 下载支持GZIP的文件不能获取进度的问题)