内存缓存

翻译：English

为了避免重复加载图片并提高图片的加载速度 Sketch 引入了内存缓存，内存缓存功能会将已加载的 Image 缓存在内存中，下次直接从内存中读取跳过加载过程。

内存缓存功能由 MemoryCacheInterceptor 负责核心逻辑，MemoryCache 负责存储管理

MemoryCache 的默认实现是 LruMemoryCache：

• 根据最少使用原则释放旧的 Bitmap
• 最大容量在 Android 上是最大可用内存的 25% 到 33%，在非 Android 上是最大可用内存的 15%

自定义

你可以在初始化 Sketch 时通过 Sketch.Builder 的 memoryCache() 方法自定义内存缓存的实现或配置，如下：

// 使用默认的 MemoryCache 实现并配置其参数
Sketch.Builder(context).apply {
    memoryCache(
        MemoryCache.Builder(context)
            .maxSizePercent(0.4f)
            .build()
    )
}.build()

// 使用你自己的 MemoryCache 实现
class MyMemoryCache : MemoryCache {
    // ...
}
Sketch.Builder(context).apply {
    memoryCache(MyDiskCache())
}.build()

缓存策略

缓存策略用于控制如何使用内存缓存，默认配置是 CachePolicy.ENABLED，你可以通过 ImageRequest 或 ImageOptions 的 memoryCachePolicy 属性配置它:

ImageRequest(context, "https://example.com/image.jpg") {
    // 禁用
    memoryCachePolicy(CachePolicy.DISABLED)
    // 只读
    memoryCachePolicy(CachePolicy.READ_ONLY)
    // 只写
    memoryCachePolicy(CachePolicy.WRITE_ONLY)
}

缓存 key

默认情况下 Sketch 会自动根据请求的配置生成内存缓存 key，但你还可以通过以下属性自定义内存缓存 key：

ImageRequest(context, "https://example.com/image.jpg") {
    // 使用自定义的内存缓存 key
    memoryCacheKey("https://example.com/image.jpg?width=100&height=100")

    // 修改自动生成的内存缓存 key
    memoryCacheKeyMapper(CacheKeyMapper { "${it}&width=100&height=100" })
}

ImageOptions {
    // 使用自定义的内存缓存 key
    memoryCacheKey("https://example.com/image.jpg?width=100&height=100")

    // 修改自动生成的内存缓存 key
    memoryCacheKeyMapper(CacheKeyMapper { "${it}&width=100&height=100" })
}

你还可以通过以下方式和获取最终的内存缓存 key：

// 在自定义的 Interceptor、Transformation、Fetcher、Decoder 组件中
// 可以通过 RequestContext 获取内存缓存 key
val requestContext: RequestContext = ...
requestContext.memoryCacheKey

// 从 ImageResult 中获取内存缓存 key
val imageSuccess = sketch.execute(request) as ImageResult.Success
imageSuccess.memoryCacheKey

读写缓存

你可以通过 sketch.memoryCache 属性获取内存缓存实例来访问内存缓存。

scope.launch {
    val memoryCache = sketch.memoryCache
    val memoryCacheKey = requestContext.memoryCacheKey
    memoryCache.withLock(memoryCacheKey) {
        // put
        val newBitmap: Bitmap = Bitmap.create(100, 100, Bitmap.Config.ARGB_8888)
        val newCacheValue = newBitmap.asImage().cacheValue()!!
        put(memoryCacheKey, newCacheValue)

        // exist
        val exist: Boolean = exist(memoryCacheKey)

        // get
        val cachedValue: MemoryCache.Value? = get(memoryCacheKey)
        val image: Image = cachedValue?.image

        // remove
        val clearedValue: MemoryCache.Value? = remove(memoryCacheKey)
    }

    // Clear all
    memoryCache.clear()

    // trim
    memoryCache.trim((memoryCache.maxSize * 0.5f).toLong())
}

更多可用方法请参考 MemoryCache

清除缓存

内存缓存会在以下几种情况下清除：

• 主动调用 MemoryCache 的 trim()、remove()、clear() 方法
• 达到最大容量时自动释放较旧的缓存
• 设备可用内存较低触发了 Application 的 onLowMemory() 方法
• 系统整理内存触发了 Application 的 onTrimMemory(int) 方法