【Retrofit第四篇】协程下载，是你好搭档 2021-05-16 21:57:52

我们看了三篇Retrofit了，可以应对大部分场景。

若是遇到上传下载，这就陷入了知识盲区了吧？上传和下载，在retrofit下，如果要监听过程，那并没有什么好用的方法，反而我们需要利用okhttp解决过程问题。

retrofit的上传和下载的解决方案，可以说是个神奇的东西，你每次百度搜如何上传或下载都能找到新的操作。

先说下载，我们的注解需要额外增加一个，叫@Streaming。由于需要获取字节流，因此返回值也要改成Response<ResponseBody>

你也可以为下载写一个适配器，但拦截stream是在创建的时候拦截，也就是build之前，而适配器是build之后才会执行，因此你想在适配器里拦截就算了。

我们的下载是需要监听过程的，监听请求过程是retrofit不具备的功能，但okhttp具备，因此，在这里我们需要调用okhttp的方法进行监听。

创建一个继承于ResponseBody的类，并实现以下方法

class DownloadFileRequestBody(
        private val responseBody: ResponseBody,
        private val downloadListener: DownloadListener?
) : ResponseBody() {

private var bufferedSource: BufferedSource? = null

init {
        downloadListener?.onStartDownload(contentLength())
    }

//contentType
    override fun contentType(): MediaType? {
        return responseBody.contentType()
    }

//内容总长度
    override fun contentLength(): Long {
        return responseBody.contentLength()
    }

override fun source(): BufferedSource? {
        if (bufferedSource == null) {
            bufferedSource = Okio.buffer(source(responseBody.source()))
        }
        return bufferedSource
    }

//监听请求过程(回调下载进度)
    private fun source(source: Source): Source {
        return object : ForwardingSource(source) {
            var totalBytesRead = 0L
            @Throws(IOException::class)
            override fun read(sink: Buffer, byteCount: Long): Long {
                val bytesRead = super.read(sink, byteCount)
                totalBytesRead += if (bytesRead != -1L) bytesRead else 0
                if (bytesRead != -1L) {
                    downloadListener?.onProgress(totalBytesRead)
                    if (totalBytesRead == contentLength())
                    {
                        downloadListener?.onComplete()
                    }
                }

return bytesRead
            }
        }
    }

//提供一个监听下载进度的接口
    interface DownloadListener {
        fun onStartDownload(length : Long)
        fun onProgress(progress : Long)
        fun onComplete()
    }
}

实现请求

class BaiduSearch(private val context: Context) {

fun search(keyword: String) {

val downloadListener = object : DownloadFileRequestBody.DownloadListener {
            override fun onStartDownload(length: Long) {
                Log.i("开始下载", "数据总长度：$length")
            }

override fun onProgress(progress: Long) {
                Log.i("正在下载", "正在下载，当前进度：$progress")
            }

override fun onComplete() {
                Log.i("下载完成","下载完成")
            }
        }

val client = OkHttpClient.Builder()
                //拦截请求过程，用于监听下载过程
                .addInterceptor {
                    val response = it.proceed(it.request())
                    response.newBuilder().body(
                            DownloadFileRequestBody(response.body()!!, downloadListener)
                    ).build()
                }
                .build()

val api = Retrofit.Builder()
                .baseUrl("http://192.168.0.103:8080/")
                //使用自己创建的okhttpclient
                .client(client)
                .addConverterFactory(DecompressConverterFactory())
                //协程请求
                .addCallAdapterFactory(CoroutineCallAdapterFactory())
                .build()
                .create(Api::class.java)

CoroutineScope(Dispatchers.IO).launch {
            //由于请求有可能失败，需要try catch
            try {
                val response = api.download("download.zip")
                val inputStream = response.body()!!.byteStream()
                val file = File(getDiskCachePath() + "/test.zip")
                writeFile(inputStream, file)
            }
            catch (e: Exception)
            {
                e.printStackTrace()
                Log.i("请求失败", "请求失败")
            }
        }

}

//获取合适的缓存目录
    private fun getDiskCachePath(): String {
        return if (Environment.MEDIA_MOUNTED == Environment.getExternalStorageState() || !Environment.isExternalStorageRemovable()) {
            context.externalCacheDir!!.path
        } else {
            context.cacheDir.path
        }
    }

//把输入流写入成文件
    private fun writeFile(inputString: InputStream, file: File) {
        if (!file.parentFile.isDirectory)
        {
            file.mkdirs()
        }
        if (file.exists()) {
            file.delete()
        }

var fos: FileOutputStream? = null
        try {
            fos = FileOutputStream(file)

val b = ByteArray(1024)

var len : Int
            do {
                len = inputString.read(b)
                if (len == -1) break
                fos.write(b, 0, len)
            } while (true)

} catch (e: Exception) {
            e.printStackTrace()
        }
        finally {
            fos?.close()
            inputString.close()
        }

}

interface Api {

@Streaming
        @GET
        suspend fun download(@Url url: String) : Response<ResponseBody>
    }
}

retrofit下载并没有什么特别的操作，我相信不管什么项目，下载都要得到一个下载过程，无非就是我们需要额外掌握okhttp是如何拦截请求的。

原创文章,转载请注明出处

【Retrofit第四篇】协程下载，是你好搭档 2021-05-16 21:57:52

警告