安卓 - 源码 - LruCache

LruCache是android提供的一个缓存工具类。
在很多教程上,说到对Bitmap的缓存处理,都会使用这个类。
你也可以在很多框架里发现使用这个类的地方,例如Universal-Image-Loader,xUtils。


先来看看LruCache的说明,我翻译一下:

/**
 * 一个使用强引用保存有限数量资源的缓存。
 * 每当缓存中的元素被访问,这个元素将会移动到缓存队列的头部。
 * 当缓存已满时继续存入元素,缓存队列底部的元素将会被移除,并可被GC回收。
 *
 * 如果缓存中的资源需要显式释放,可以重写entryRemoved方法。
 * 
 * 如果一个Key对应的缓存丢失后,需要定义key的返回值,可以重写create方法。
 * 简化调用代码,即使缓存丢失,(get方法)也能返回一个值(而不是返回null)。
 * 
 * 默认的 cache-size 等于 元素数目。
 * 重写 sizeOf 可以自定义元素的大小的计算方法。(举例了一个4M大小的Bitmap缓存)
 * 
 * 这个类是线程安全的。(举例了put方法的同步实现作为示例)
 * 
 * 不允许使用null作为Key或Value。
 * 当 get,put,remove 的返回值是null时,说明缓存中key不存在
 * 
 * 这个类是安卓3.1之后出现的类,可以使用v4包适配更低版本。
 */

类说明已经十分明确了,看完类说明,基本就可以明白这个类的特征和使用方式。

Lru的实现:
Lru是Least Recently Used的缩写,意思为最近最少使用,是该类的核心算法。
但是这个Lru算法呢,是内部维护的LinkedHashMap实现的,要了解Lru,还是需要了解LinkedHashMap源码。
提供一个参考 LinkedHashMap ,当然最好还是自己看一次源码。

上述几个需要重写的方法:

/*
 * 当产生不被维护的元素时,如put替换了的旧元素,需要被显式回收时
 * 可以通过重写该方法进行回收的相关处理、
 * evicted参数:
 *  true 为因释放空间而产生(即trimToSize方法)
 *  false为因操作产生(get,put,remove)
 */
protected void entryRemoved(boolean evicted, K key, V oldValue, V newValue)

/*
 * 计算元素的大小,默认返回1
 * 即每一个元素的大小都为1,Cache的大小即为维护的元素的数量
 * 应和设置的 Cache最大值 配合使用,如设置最大值是一块内存大小
 * sizeOf就应该返回每一个元素占用内存的大小
 */
protected int sizeOf(K key, V value)

/*
 * 在get方法中,无法从map中取出元素时
 * 会尝试通过create方法,为这个key创建一个对应的value
 * 当创建的value不为空时,value将会添加到map,并作为get的返回
 * 默认返回null
 */
protected V create(K key)

既然维护了LinkedHashMap,肯定就会有对其get,put,remove等方法的封装。
但是在这之前,需要看一下其中的关键方法(取关键部分):

/*
 * 维护Cache大小在设置的最大值以下的核心方法
 * 对比Cache大小和设置的最大值,当Cache大小超过最大值时
 * 通过LinkedHashMap的eldest()方法获取最近最少使用的元素
 * 对LinkedHashMap内的元素进行循环移除,直到Cache大小小于最大值
 */
public void trimToSize(int maxSize) {
    while (true) {
        if (size <= maxSize) {
            break;
        }

        /*
         * 关于这里需要阅读LinkedHashMap的源码
         * 当eldest()返回空时,相当于map中为空
         * 清空Cache的evictAll()方法,就是调用trimToSize(-1)
         * 循环从这里跳出
         */
        Map.Entry toEvict = map.eldest();
        if (toEvict == null) {
            break;
        }

        key = toEvict.getKey();
        map.remove(key);
    }
}

接下来就是操作封装(取关键部分):

/*
 * 1:获取元素,元素不存在时尝试创建新元素并纠错
 * 2:维护Cache的当前大小 size
 * 3:使用trimToSize对Cache进行维护
 */
public final V get(K key) {
    V mapValue;
    // 尝试返回mapValue
    mapValue = map.get(key);
    if (mapValue != null) {
        return mapValue;
    }

    // 尝试创建createdValue
    V createdValue = create(key);
    if (createdValue == null) {
        return null;
    }

    // 将createdValue 添加到Map
    mapValue = map.put(key, createdValue);
    if (mapValue != null) {
        // 纠错步骤
        // put过程中检查到原有mapValue,则丢弃createdValue
        map.put(key, mapValue);
    } else {
        // 计算createdValue大小并添加到cache当前大小
        size += safeSizeOf(key, createdValue);
    }

    if (mapValue != null) {
        // 纠错步骤
        // createdValue被丢弃时,进行显式回收
        entryRemoved(false, key, createdValue, mapValue);
        return mapValue;
    } else {
        // 当createdValue生效时,维护Cache大小
        trimToSize(maxSize);
        return createdValue;
    }
}
/*
 * 1:维护Cache的当前大小 size
 * 2:使用trimToSize对Cache进行维护
 */
public final V put(K key, V value) {
    V previous;
    size += safeSizeOf(key, value);
    previous = map.put(key, value);
    if (previous != null) {
        size -= safeSizeOf(key, previous);
    }
    if (previous != null) {
        entryRemoved(false, key, previous, value);
    }
    trimToSize(maxSize);
    return previous;
}
/*
 * 1:维护Cache的当前大小 size
 * 2:使用trimToSize对Cache进行维护
 */
public final V remove(K key) {
    V previous;
    previous = map.remove(key);
    if (previous != null) {
        size -= safeSizeOf(key, previous);
    }
    if (previous != null) {
        entryRemoved(false, key, previous, null);
    }
    return previous;
}

可以看到,这三个关键方法其实都挺简单的,主要都是维护操作:
1.对cache-size进行维护
2.使用trimToSize对cache的大小进行维护

其他方法:

void resize(int maxSize) // 调整缓存大小
void evictAll()          // 清空缓存

int size()           // 获取当前大小
int maxSize()        // 获取定义的最大值
int hitCount()       // get方法直接从map中成功取值的次数
int missCount()      // get方法从map中取值失败的次数
int createCount()    // get方法调用create创建新元素的次数
int putCount()       // put方法调用的次数
int evictionCount()  // 因释放空间而被移除的元素的数量

Map snapshot() // 返回一个使用插入排序的副本

以上就是LruCache的源码分析,该类比较简单,可以自行阅读源码。
深入理解还是建议阅读LinkedHashMap,或更深入到Java Collection Framework。

如对你有帮助,欢迎点赞喜欢支持

你可能感兴趣的:(安卓 - 源码 - LruCache)