前言
在现代 Android 应用开发中,图片加载是一个常见且关键的功能需求。Glide 作为最流行的图片加载库之一,提供了简单易用的 API 和出色的性能表现。而将 Glide 与 OkHttp 结合使用,可以充分发挥两者的优势,实现更高效、更可控的网络图片加载。本文将详细介绍如何将这两者结合使用,并展示一些高级应用场景。
一、为什么需要结合使用 OkHttp 和 Glide?
1. Glide 的默认网络实现
Glide 默认使用 HttpUrlConnection 作为网络层实现,存在以下局限性:
-
缺乏连接池管理,性能不如 OkHttp
-
不支持 HTTP/2
-
难以添加统一的请求头和拦截器
-
缓存控制不够灵活
2. OkHttp 的优势
通过集成 OkHttp 作为 Glide 的网络层,可以带来以下好处:
-
性能提升:利用 OkHttp 的连接池和 HTTP/2 支持
-
统一网络配置:与应用的其它网络请求共享相同的 OkHttpClient 实例
-
高级功能:支持拦截器、缓存控制、HTTPS 配置等
-
调试方便:可以使用 OkHttp 的日志拦截器
二、基本集成与配置
1. 添加依赖
首先在 build.gradle 中添加必要的依赖:
implementation 'com.github.bumptech.glide:glide:4.13.2'
implementation 'com.squareup.okhttp3:okhttp:4.9.3'
kapt 'com.github.bumptech.glide:compiler:4.13.2' // 注解处理器
2. 创建自定义 GlideModule
我们需要创建一个自定义的 AppGlideModule
来配置 Glide 使用 OkHttp:
@GlideModule
class OkHttpGlideModule : AppGlideModule() {
override fun registerComponents(context: Context, glide: Glide, registry: Registry) {
val okHttpClient = OkHttpClient.Builder()
.connectTimeout(30, TimeUnit.SECONDS)
.readTimeout(30, TimeUnit.SECONDS)
.writeTimeout(30, TimeUnit.SECONDS)
.build()
registry.replace(
GlideUrl::class.java,
InputStream::class.java,
OkHttpUrlLoader.Factory(okHttpClient)
)
}
// 禁用清单解析以提升初始化速度
override fun isManifestParsingEnabled(): Boolean = false
}
3. 基本使用
配置完成后,Glide 的使用方式与平常无异:
Glide.with(context)
.load("https://example.com/image.jpg")
.into(imageView)
三、高级配置与功能
1. 共享应用的单例 OkHttpClient
通常应用中已经有一个配置好的 OkHttpClient 单例,我们可以直接使用它:
@GlideModule
class OkHttpGlideModule : AppGlideModule() {
override fun registerComponents(context: Context, glide: Glide, registry: Registry) {
registry.replace(
GlideUrl::class.java,
InputStream::class.java,
OkHttpUrlLoader.Factory(NetworkClient.okHttpClient))
}
}
object NetworkClient {
val okHttpClient: OkHttpClient by lazy {
OkHttpClient.Builder()
.connectTimeout(30, TimeUnit.SECONDS)
.readTimeout(30, TimeUnit.SECONDS)
.writeTimeout(30, TimeUnit.SECONDS)
.addInterceptor { chain ->
val request = chain.request().newBuilder()
.header("User-Agent", "MyApp/1.0")
.build()
chain.proceed(request)
}
.build()
}
}
2. 添加统一的请求头
通过 OkHttp 拦截器可以轻松为所有图片请求添加统一请求头:
val okHttpClient = OkHttpClient.Builder()
.addInterceptor { chain ->
val request = chain.request().newBuilder()
.header("Authorization", "Bearer token")
.header("Accept", "image/webp") // 优先加载 webp 格式
.build()
chain.proceed(request)
}
.build()
3. 图片加载进度监听
结合 OkHttp 拦截器可以实现图片加载进度监听:
首先定义进度监听接口:
interface ProgressListener {
fun onProgress(progress: Int) // 0-100
}
然后创建进度拦截器:
class ProgressInterceptor : Interceptor {
private val listeners = mutableMapOf<String, ProgressListener>()
fun addListener(url: String, listener: ProgressListener) {
listeners[url] = listener
}
fun removeListener(url: String) {
listeners.remove(url)
}
override fun intercept(chain: Interceptor.Chain): Response {
val request = chain.request()
val response = chain.proceed(request)
val url = request.url.toString()
val listener = listeners[url] ?: return response
return response.newBuilder()
.body(ProgressResponseBody(response.body, listener))
.build()
}
}
class ProgressResponseBody(
private val responseBody: ResponseBody?,
private val listener: ProgressListener
) : ResponseBody() {
// 实现必要的 ResponseBody 方法
// 在 source() 方法中包装 Source 以监听读取进度
}
使用示例:
// 配置 OkHttpClient 时添加拦截器
val progressInterceptor = ProgressInterceptor()
val okHttpClient = OkHttpClient.Builder()
.addInterceptor(progressInterceptor)
.build()
// 加载图片时添加监听
progressInterceptor.addListener(imageUrl, object : ProgressListener {
override fun onProgress(progress: Int) {
// 更新进度条
}
})
Glide.with(context)
.load(imageUrl)
.into(object : CustomTarget<Drawable>() {
override fun onResourceReady(resource: Drawable, transition: Transition<in Drawable>?) {
// 加载完成
progressInterceptor.removeListener(imageUrl)
}
override fun onLoadCleared(placeholder: Drawable?) {
progressInterceptor.removeListener(imageUrl)
}
})
4. 自定义缓存策略
通过 OkHttp 可以精细控制图片缓存:
val cacheSize = 100 * 1024 * 1024 // 100 MB
val cache = Cache(File(context.cacheDir, "glide_cache"), cacheSize.toLong())
val okHttpClient = OkHttpClient.Builder()
.cache(cache)
.addNetworkInterceptor { chain ->
val response = chain.proceed(chain.request())
val cacheControl = CacheControl.Builder()
.maxAge(7, TimeUnit.DAYS) // 缓存7天
.build()
response.newBuilder()
.header("Cache-Control", cacheControl.toString())
.build()
}
.build()
5. HTTPS 配置
如果需要自定义 HTTPS 配置,可以通过 OkHttp 实现:
val trustManager = ... // 自定义 TrustManager
val sslSocketFactory = SSLContext.getInstance("TLS").apply {
init(null, arrayOf(trustManager), null)
}.socketFactory
val okHttpClient = OkHttpClient.Builder()
.sslSocketFactory(sslSocketFactory, trustManager)
.hostnameVerifier { hostname, session ->
// 自定义主机名验证逻辑
true
}
.build()
四、最佳实践
-
共享 OkHttpClient 实例:确保应用中所有网络请求使用相同的 OkHttpClient 实例
-
合理配置缓存大小:根据应用需求设置适当的缓存大小
-
图片格式优化:通过请求头优先加载 WebP 等现代图片格式
-
资源释放:在适当的生命周期回调中清理 Glide 请求
-
错误处理:为 Glide 添加错误监听和占位图
-
渐进式加载:对 JPEG 图片启用渐进式加载提升用户体验
五、完整示例代码
// 自定义 GlideModule
@GlideModule
class AppGlideModule : AppGlideModule() {
override fun registerComponents(context: Context, glide: Glide, registry: Registry) {
registry.replace(
GlideUrl::class.java,
InputStream::class.java,
OkHttpUrlLoader.Factory(NetworkClient.okHttpClient))
}
override fun applyOptions(context: Context, builder: GlideBuilder) {
// 可在此配置内存缓存、Bitmap 池等
builder.setDefaultRequestOptions(
RequestOptions()
.format(DecodeFormat.PREFER_RGB_565) // 使用更少内存的格式
}
override fun isManifestParsingEnabled(): Boolean = false
}
// 网络客户端单例
object NetworkClient {
private const val CACHE_SIZE = 100 * 1024 * 1024L // 100MB
val okHttpClient: OkHttpClient by lazy {
OkHttpClient.Builder()
.connectTimeout(30, TimeUnit.SECONDS)
.readTimeout(30, TimeUnit.SECONDS)
.writeTimeout(30, TimeUnit.SECONDS)
.cache(Cache(File(App.context.cacheDir, "glide_cache"), CACHE_SIZE))
.addInterceptor { chain ->
val request = chain.request().newBuilder()
.header("User-Agent", "MyApp/1.0")
.header("Accept", "image/webp, image/*;q=0.8")
.build()
chain.proceed(request)
}
.addNetworkInterceptor { chain ->
val response = chain.proceed(chain.request())
val cacheControl = CacheControl.Builder()
.maxAge(7, TimeUnit.DAYS)
.build()
response.newBuilder()
.header("Cache-Control", cacheControl.toString())
.build()
}
.build()
}
}
// 使用示例
fun loadImage(context: Context, url: String, imageView: ImageView) {
Glide.with(context)
.load(url)
.apply(RequestOptions()
.placeholder(R.drawable.placeholder)
.error(R.drawable.error)
.diskCacheStrategy(DiskCacheStrategy.ALL)
.priority(Priority.HIGH))
.transition(DrawableTransitionOptions.withCrossFade())
.into(imageView)
}
六、常见问题解决方案
1. 图片加载失败
-
检查 URL:确保 URL 正确且可访问
-
查看日志:启用 OkHttp 日志拦截器查看详细错误
-
SSL 问题:如果是 HTTPS 图片,可能需要配置 SSL
2. 内存占用过高
-
使用 RGB_565:配置 Glide 使用更节省内存的格式
-
限制尺寸 :使用
override()
方法限制图片加载尺寸 -
清理缓存 :在适当的时候调用
Glide.get(context).clearMemory()
3. 缓存不生效
-
检查缓存配置:确保 OkHttp 缓存配置正确
-
检查响应头:服务器响应应包含正确的缓存控制头
-
清除缓存:测试时可以临时清除缓存验证
七、总结
将 OkHttp 与 Glide 结合使用,可以充分发挥两者的优势,为 Android 应用提供高效、灵活的图片加载解决方案。通过 OkHttp 的强大网络功能,我们可以实现统一的网络配置、精细的缓存控制、进度监听等高级功能,同时保持 Glide 简洁易用的 API。
在实际项目中,建议根据具体需求选择合适的配置方案,并遵循最佳实践以获得最佳性能和用户体验。这种组合特别适合需要统一网络管理和高级图片加载功能的复杂应用场景。