DiskLruCache
- DiskLruCache的创建
- DiskLruCache缓存
- DiskLruCache的读取
- DiskLruCache删除
如何添加使用
compile 'com.jakewharton:disklrucache:2.0.2'
1.创建
- directory表示磁盘缓存的存储路径
缓存目录没有具体限制，可以根据需求自己的定义。一般来说，可以选择SD卡上的/sdcard/Android/data/<application package>/cache目录，这个目录是Android系统指定的应用程序缓存目录，当应用卸载时，缓存也会被系统清除；当然还可以选择sd卡上的其他目录，也可以选择data下的当前应用目录。当然，一个严禁的程序还要考虑SD卡是否存在等。 - appVersion表示应用的版本号
当appVersion改变时，之前的缓存都会被清除，所以如非必要，我们为其指定一个1，不再改变即可 - valueCount表示单个节点对应的数据个数，也就是同一个key可以对应多少个缓存文件，一般来说我们都选取1.
- maxSize缓存的总大小。
创建代码如下
cacheFile = new File(this.getCacheDir().getPath(),cacheFileName);
if(!cacheFile.exists()){
cacheFile.mkdirs();
}
try {
diskLruCache = DiskLruCache.open(cacheFile,1,1,MAXCACHESIZE);
} catch (IOException e) {
e.printStackTrace();
}
2.缓存
代码如下
editor = diskLruCache.edit(KEY);
BufferedOutputStream out = null;
BufferedInputStream in = null;
Message message = new Message();
Request request = new Request.Builder().url(url).build();
Response response;
try {
response = client.newCall(request).execute();
out =new BufferedOutputStream(outStream) ;
in = new BufferedInputStream(response.body().byteStream());
int b ;
while((b=in.read())!=-1){
out.write(b);
}
editor.commit();
message.what = SUCCESS;
handler.sendMessage(message);
} catch (IOException e) {
e.printStackTrace();
message.what = FAILER;
handler.sendMessage(message);
}finally {
try{
if(in!=null){
in.close();
}
if(out!=null){
out.close();
}
} catch (IOException e) {
try {
editor.abort();
} catch (IOException e1) {
e1.printStackTrace();
}
}
}
}
}).start();
3.读取
首先需要将URL转换成Key，然后通过DiskLruCache的get方法得到一个Snapshot对象，在通过Snapshot对象得到缓存文件的输入流，再把输入流转换成Bitamp对象。
代码如下
private Bitmap getBitmap(){
try {
DiskLruCache.Snapshot snapshot = diskLruCache.get(KEY);
if(snapshot!=null){
Bitmap bitmap = BitmapFactory.decodeStream(snapshot.getInputStream(0));
return bitmap;
}
} catch (IOException e) {
e.printStackTrace();
}
return null;
}
4. 删除
diskLruCache.remove(key);
5.其他几个重要方法
- diskLruCache.delete() 删除所有的缓存数据
- diskLruCache. size() 返回当前缓存路径下所有缓存数据的大小，以byte为单位
- editor.abort() 图片下载发生异常时，可以通过这个方法回退整个操作
- editor.commit() 提交写入操作，这个放在在写入缓存数据时是一定要调用的
5 .diskLruCache.flush() 这个方法用于将内存中的操作记录同步到日志文件（也就是journal文件，系统LRU算法依赖于这个文件，因为这个文件中保存着对数据的操作记录）当中；但其实并不是每次写入缓存都要调用一次flush()方法的，频繁地调用并不会带来任何好处，只会额外增加同步journal文件的时间。比较标准的做法就是在Activity的onPause()方法中去调用一次flush()方法就可以了。 - diskLruCache.close() 这个方法用于将DiskLruCache关闭掉，是和open()方法对应的一个方法。关闭掉了之后就不能再调用DiskLruCache中任何操作缓存数据的方法，通常只应该在Activity的onDestroy()方法中去调用close()方法。
6. journal文件
当执行完写入操作后，我们看看对应的目录下(/sdcard/Android/data/<application package>/cache)有什么文件？
打开cache目录后，发现里边只有一个bitmapsCache的文件夹；这个文件是哪里来的呢？这个其实就是上文在创建DiskLruCache实例时传入的url中拼接的（看 getDiskCacheDir 方法），为什么要指定这么一个目录呢？其实就是类似于分类的概念，比如你可以把缓存的Bitmap放到一个文件夹下，把file或者其他格式的数据放到另外一个文件夹下。
打开bitmapsCache文件夹，它的子目录又有哪些呢？首先有一个文件，这个文件的文件名很长而且没有任何规则，完全看不懂是什么意思；另外下边还有一个journal文件。其实文件名很长的文件就是一张缓存的图片，每个文件都对应着一张图片，如果我们缓存了很多图片的话，就会有一堆这样的文件；而journal文件是DiskLruCache的一个日志文件，就像我上面说的：这个文件中保存着对数据的操作记录。如下图：
打开journal这个文件，发现它长成这样 长得也很整齐：首先有一行字符串“libcore.io.DiskLruCache”表示我们使用的是DiskLruCache技术；然后又有三行，且每行都只有一个“1”，其中第一行的“1”表示DiskLruCache的版本号，这个值是恒为1的，第2行的“1”表示应用程序的版本号，我们在open()方法里传入的版本号是什么这里就会显示什么，第三个“1”表示的是valueCount，表示单个节点对应的数据个数，这个值也是在open()方法中传入的，通常情况下都为1。接下来就是一个空行，标志着开始记录数据的操作记录。
接下来，会有DIRTY开头的一行数据，DIRTY后边跟着的是文件的key，DIRTY表示开始向缓存中写入数据，但写入结果是什么还未知。然后调用commit()方法表示写入缓存成功，这时会向journal中写入一条CLEAN记录，表示数据写入成功；如果数据写入失败，会调用abort()方法回退整个操作，这时会向journal中写入一条REMOVE记录。当调用get()方法去读取一条缓存数据时，就会向journal文件中写入一条READ记录；另外，某些行后面还有一个数字（20090、6602），这个数字就是缓存图片的大小，以byte为单位。
7. hashKeyForDisk()方法代码，用于生成MD5编码
private String hashKeyFroDisk(String key) {
String cacheKey;
try {
MessageDigest digest = MessageDigest.getInstance("MD5");
digest.update(key.getBytes());
cacheKey = bytesToHexString(digest.digest());
} catch (NoSuchAlgorithmException e) {
e.printStackTrace();
cacheKey = String.valueOf(key.hashCode());
}
return cacheKey;
}
