一行代码搞定：OkHttp、Retrofit、Glide 下载上传进度监听，你确定不了解一下？

2023-11-10 05:09:43

一行代码实现 OkHttp、Retrofit、Glide 下载上传进度监听

前言

在 Android 开发中，处理网络请求是必不可少的任务。OkHttp、Retrofit 和 Glide 是三大热门框架，分别用于执行 HTTP 请求、构建 RESTful API 客户端以及加载和缓存图像。但是，这些框架默认不提供进度监听功能，这在下载或上传大文件时会带来不便。

为了解决这个问题，本文将介绍一种简单易用的方法，使用一行代码在 OkHttp、Retrofit 和 Glide 中添加进度监听功能。这种方法不仅可以让你实时跟踪网络请求的进度，还能在用户界面中显示进度条或其他可视化元素，提升用户体验。

实施

1. 添加依赖项

在你的项目中添加以下依赖项：

dependencies {
    implementation 'com.github.ybq:Android-SpinKit:1.4.0'
    implementation 'com.github.bumptech.glide:glide:4.12.0'
    implementation 'com.squareup.okhttp3:okhttp:4.9.3'
    implementation 'com.squareup.retrofit2:retrofit:2.9.0'
    implementation 'com.squareup.retrofit2:converter-gson:2.9.0'
}

2. 创建进度监听器

创建一个进度监听器类，它实现 OkHttp 的 ProgressListener 接口：

class ProgressListener(private val callback: (Long, Long) -> Unit) : ProgressListener {
    override fun update(bytesRead: Long, contentLength: Long, done: Boolean) {
        callback(bytesRead, contentLength)
    }
}

3. 在 OkHttp 中添加进度监听

在创建 OkHttpClient 对象时，添加进度监听器：

val okHttpClient = OkHttpClient.Builder()
    .addNetworkInterceptor { chain ->
        val originalRequest = chain.request()
        val request = originalRequest.newBuilder()
            .addHeader("Content-Type", "application/json")
            .addHeader("Accept", "application/json")
            .build()
        chain.proceed(request)
    }
    .addInterceptor(ProgressInterceptor(object : ProgressListener {
        override fun update(bytesRead: Long, contentLength: Long, done: Boolean) {
            // 进度更新回调
        }
    }))
    .build()

4. 在 Retrofit 中添加进度监听

在创建 Retrofit 对象时，添加进度监听器：

val retrofit = Retrofit.Builder()
    .baseUrl("https://example.com/")
    .addConverterFactory(GsonConverterFactory.create())
    .client(okHttpClient)
    .build()

5. 在 Glide 中添加进度监听

在加载图像时，添加进度监听器：

Glide.with(this)
    .load("https://example.com/image.jpg")
    .listener(object : RequestListener<Drawable> {
        override fun onLoadFailed(e: GlideException?, model: Any?, target: Target<Drawable>?, isFirstResource: Boolean): Boolean {
            return false
        }

        override fun onResourceReady(resource: Drawable?, model: Any?, target: Target<Drawable>?, dataSource: DataSource?, isFirstResource: Boolean): Boolean {
            // 进度更新回调
            return false
        }
    })
    .into(imageView)

示例

以下是一个示例代码，展示如何使用一行代码实现进度监听：

ProgressInterceptor(object : ProgressListener {
    override fun update(bytesRead: Long, contentLength: Long, done: Boolean) {
        // 进度更新回调
    }
}).interceptor(ProgressInterceptor(object : ProgressListener {
    override fun update(bytesRead: Long, contentLength: Long, done: Boolean) {
        // 进度更新回调
    }
}))