Android缓存（二）磁盘缓存DiskLruCache

DiskLruCache并不是Android系统内置的缓存类，但是它得到了google的官方推荐，要使用DiskLruCache，首先需要添加依赖：

compile 'com.jakewharton:disklrucache:2.0.2'

创建DiskLruCache

DiskLruCache提供了一个open方法，用于磁盘缓存的创建。

public static DiskLruCache open(File directory, int appVersion, int valueCount, long maxSize)

directory表示缓存路径，appVersion指应用版本，valueCount指单个节点对应的数据大小，设置为1就好。maxSize指缓存空间大小。

DiskLruCache会根据appVersion来识别当前应用的版本，如果有更新，会清除原来的数据并重建缓存，可以设置一个固定值比如1，这样在应用版本升级以后并不会清除原来的缓存。

appVersion应用版本号也可以通过PackageManager来获取，这样能保证DiskLruCache对应的总是新的版本：

 PackageInfo info = context.getPackageManager().getPackageInfo(context.getPackageName(), 0);  
        return info.versionCode;  

这里的获取的versionCode，是在Manifest文件中定义的：

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
          package="xxx.xxx.xxxx"
          android:versionCode="1">

添加缓存数据

DiskLruCache的写入通过Editor来完成。获取方法如下：

DiskLruCache.Editor editor = mDiskLruCache.edit(key)

如果key对应的缓存正在被操作（比如正在写入），会返回null。而这里的key就是缓存中数据存储的键值（比如url），它不允许特殊字符存在，通常我们要对它进行转码：

public String hashKeyForDisk(String key) {  
    String cacheKey;  
    try {  
        final MessageDigest mDigest = MessageDigest.getInstance("MD5");  
        mDigest.update(key.getBytes());  
        cacheKey = bytesToHexString(mDigest.digest());  
    } catch (NoSuchAlgorithmException e) {  
        cacheKey = String.valueOf(key.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();  
} 

获取到对应的editor之后，就可以向缓存写入数据了，写入数据使用的是输出流的方式，取得当前editor的outpStream，就可以写入数据了。

OutputStream outputStream = editor.newOutputStream(0);//获取输出流，参数0表示当前key对应的数据id，创建DiskLruCache时传入的第三个参数为1，所以传入0表示第一个

完整示例如下：
public boolean putDateToCache(DiskLruCache.Editor editor, InputStream inputStream) {

        BufferedInputStream in = null;
        BufferedOutputStream out = null;
        
        int b;
        try {
            OutputStream outputStream = editor.newOutputStream(0);
            in = new BufferedInputStream(inputStream, 4*1024);
            out = new BufferedOutputStream(outputStream, 4*1024);
            while ((b = in.read())!= -1){
                out.write(b);
            }
            editor.commit();
            return true;
        } catch (IOException e) {
            e.printStackTrace();
        }finally {
            try {
                if (out != null){
                    out.close();
                }
                if (in != null){
                    in.close();
                }
            } catch (IOException e) {
                e.printStackTrace();
            }

        }
       return false;
    }

缓存内容读取

读取缓存内容使用的是get方法，它返回一个Snapshot 对象，调用snapshot的getInputStream方法就可以读取到输入流了。

try {  
   
    DiskLruCache.Snapshot snapShot = mDiskLruCache.get(key);  
    if (snapShot != null) {  
        InputStream is = snapShot.getInputStream(0);  
        Bitmap bitmap = BitmapFactory.decodeStream(is);  
        mImage.setImageBitmap(bitmap);  
    }  
} catch (IOException e) {  
    e.printStackTrace();  
}  

移除缓存

通常情况下，DiskLruCache会根据设置的缓存大小自动管理数据，但是如果key对应的数据过期，可以通过remove方法手动移除数据。

try {  
    String key = hashKeyForDisk(imageUrl);    
    mDiskLruCache.remove(key);  
} catch (IOException e) {  
    e.printStackTrace();  
}  

其他API：

• size
  DiskLruCache的size方法返回缓存路径下所有数据的总量，单位是byte，
• flush
  flush用于将内存中的操作记录同步到日志文件（也就是journal文件）当中。DiskLruCache能够正常工作的前提就是要依赖于journal文件中的内容。并不是每次写入缓存都要调用一次flush()方法的，频繁地调用会额外增加同步journal文件的时间。可以将在写入工作完成以后一次性flush。
• close()
  这个方法用于将DiskLruCache关闭掉，是和open()方法对应的一个方法。关闭掉了之后就不能再调用DiskLruCache中任何操作缓存数据的方法，通常只应该在Activity的onDestroy()方法中去调用close()方法。
• delete()
  这个方法用于将所有的缓存数据全部删除，比如说网易新闻中的那个手动清理缓存功能，其实只需要调用一下DiskLruCache的delete()方法就可以实现了。