DiskLruCache详解

上一节，我们了解了LruCache的使用，我们知道LruCache是从内存中去获取缓存信息。但内存大小是有限的，因此无法存取大量的缓存。从而，引入了DiskLruCache，磁盘缓存，将信息缓存到手机中。

LruCache和DiskLruCache的区别：

• 共同点：两者都是缓存信息，并且都是采用LRU算法。

• 不同点：LruCache读写速度快，但存储大小有限。DiskLruCache读写速度慢，但存储空间大。

DiskLruCache的创建：

DiskLruCache并不能通过构造方法来创建，它提供了open方法用于创建自身：

/**
* 用于创建DiskLruCache
* 参数一：表示磁盘在文件系统中存储的路径
* 参数二：表示应用的版本号，一般设为1，当版本号发生改变时，会将之前的缓存信息清空
* 参数三：表示单个节点所对应的数据的个数，一般设为1
* 参数四：表示缓存的总大小，当缓存大小超过这个设定值后，DiskLruCache会清除一些缓存，从而保证不会超过这个设定值
*/
public static DiskLruCache open(File directory, int appVersion, int valueCount, long maxSize);

具体实现如下：

//定义DiskLruCache
private DiskLruCache mDiskLruCache;
//设定DiskLruCache的大小,这里设置为50MB
private static final long DISK_CACHE_SIZE = 1024 * 1024 * 50;
//创建缓存文件夹
File diskCacheDir = getDiskCacheDir(mContext, "bitmap");
//若缓存文件夹不存在，则创建文件夹
if (!diskCacheDir.exists()){
    diskCacheDir.mkdirs();
}
//创建DiskLruCache
mDiskLruCache = DiskLruCache.open(diskCacheDir, 1, 1, DISK_CACHE_SIZE);

public File getDiskCacheDir(Context Context, String uniqueName){
    //检查手机是否支持外部存储
    boolean externalStorageAvailable = Environment.getExternalStorageState()
                .equals(Environment.MEDIA_MOUNTED);
    final String cachePath;
    //若存在外部存储，则获取到其对应的文件
    if (externalStorageAvailable) {
        cachePath = context.getExternalCacheDir().getPath();
    } 
    //否则获取内部存储缓存文件夹
    else {
        cachePath = context.getCacheDir().getPath();
    }
    //返回缓存文件夹
    return new File(cachePath + File.separator + uniqueName);
}

DiskLruCache的缓存添加：

DiskLruCache的缓存添加的操作是通过Editor完成的，Editor表示一个缓存对象的编辑对象。

我们以图片缓存为例，首先需要获取图片url所对应的key，然后根据key就可以通过edit()来获取Editor对象。如果这个对象正在被编辑，那么edit()会返回null，即DiskLruCache不允许同时编辑一个缓存对象。

因为url中可能含有特殊字符，这样url在Android中直接使用，一般采用url的md5值作为key。

private String hashKeyFromUrl(String url){
    String cacheKey;
    try{
        final MessageDigest mDigest = MessageDigest.getInstance("MD5");
        mDigest.update(url.getBytes());
        cacheKey = bytesToHexString(mDigest.digest());
    } catch(NoSuchAlgorithmException e){
        cacheKey = String.valueOf(url.hashCode());
    }
    return cacheKey;
}

private String bytesToHexString(byte[] bytes){
    StringBuilder sb = new StringBuilder();
    for (int i = 0; i < bytes.length ; i ++ ) {
        String hex = Integer.toHexString(0xFF & bytes[i]);
        if (hex.length() == 1){
            sb.append('0');
        }
        sb.append(hex);
    }
    return sb.toString();
}

将图片的url转成key后，就可以获取Editor对象。对于这个key来说，如果当前不存在其他的Editor对象，那么editor就会返回一个新的Editor对象，通常它可以得到一个文件输出流。

private final int DISK_CACHE_INDEX = 0;
String key = hashKeyFromUrl(url);
DiskLruCache.Editor editor = mDiskLruCache.edit(key);
if (editor != null) {
    OutputStream os = editor.newOutputStream(DISK_CACHE_INDEX);
}

注意：上面设置DISK_CACHE_INDEX为0，因为前面在DiskLruCache的open方法中设置了一个节点只能有一个数据。

存在输出流后，当网络下载图片时，图片就可以通过这个文件输出流写入到系统文件中。

/**
* 实现根据传入的urlString从网络中下载图片数据，然后写入输出流os中
*/
public boolean downloadUrlToStream(String urlString, OutputStream os){
    //定义连接和输入输出流
    HttpURLConnection urlConnection = null;
    BufferedOutputStream out = null;
    BufferedInputStream in = null;
    try{
        final URL url = new URL(urlString);
        //获取到连接和输入输出流
        urlConnection = (HttpURLConnection) url.openConnection();
        in = new BufferedInputStream(urlConnection.getInputStream(),
            IO_BUFFER_SIZE)；
        out = new BufferedOutputStream(os, IO_BUFFER_SIZE);
        //进行将网络数据写入os中
        int b = -1;
        while ((b = in.read()) != -1){
            out.write(b);
        }
        return true;
    } catch (IOException e){
        Log.d(TAG, "downloadBitmap failed." + e);
    } finally {
        //最后关闭连接和流
        if (urlConnection != null) {
            urlConnection.disconnect();
        }
        MyUtils.close(out);
        MyUtils.close(in);
    }
    return false;
}

经过上面的步骤，并没有真正地将图片写入文件系统中，还必须通过Editor的commit()来提交写入操作，如果图片下载过程中出现异常，那么还可以通过Editor的abort()来回退整个操作。

OutputStream os = editor.newOutputStream(DISK_CACHE_INDEX);
//若写入成功，则提交操作
if (downloadUrlToStream(url, os)) {
    editor.commit();
} 
//否则终止操作
else {
    editor.abort();
}
//最后刷新缓存区，将缓存区中的文件写入到系统中
mDiskLruCache.flush();

DiskLruCache的缓存查找

• 将url转换为key

• 通过DiskLruCache的get方法得到一个Snapshot对象
• 通过Snapshot对象获取到缓存的文件输入流
• 通过输入流，获取到Bitmap对象

为了避免加载图片过程中导致的OOM问题，一般不建议直接加载原始图片，而是通过BitmapFactory.Options对象来加载一张缩放后的图片，但是这种方法对FileInputStream的缩放存在问题，因为FileInputStream是一种有序的文件流，而两次decodeStream调用影响了文件流的位置属性，导致了第二次decodeStream时得到的是null。为了解决该问题，可以通过文件流来得到它所对应的文件描述符，然后再通过BitmapFactory.decodeFileDescriptor方法来加载一张缩放后的图片。

//定义bitmap对象
Bitmap bitmap = null;
//将url转换为key
String key = hashKeyFromUrl(url);
//根据key获取到SnapShot对象
DiskLruCache.Snapshot snapShot = mDiskLruCache.get(key);
//若Snapshot对象不为空，说明存在该缓存
if (snapShot != null){
    //获取到输入流
    FileInputStream fis = (FileInputStream) snapShot.getInputStream(DISK_CACHE_INDEX);
    //根据输入流获取到文件描述符
    FileDescriptor fileDescriptor = fis.getFD();
    //调用压缩图片的方法，获取到bitmap对象
    bitmap = mImageResizer.decodeSampleBitmapFromFileDescriptor(fileDescriptor,
                reqWidth, reqHeight);
    //然后将bitmap对象加入到内存缓存中
    if (bitmap != null){
        addBitmapToMemoryCache(key, bitmap);
    }
}