Android缓存之DiskLruCache磁盘缓存的使用

DiskLruCache和LruCache不同的是,LruCache是内存缓存,而DiskLruCache是指磁盘缓存,顾名思义就是把文件缓存到磁盘,也也就是手机的内存卡中。接下来先简单介绍DiskLruCache的使用方法。

下载源码

DiskLruCache并没有在 SDK中存在,但又是谷歌提倡的。所以我们要先把DiskLruCache的源码下载下来。
我们可以通过下面这个地址下载源码:https://github.com/JakeWharton/DiskLruCache/tree/master/src/main/java/com/jakewharton/disklrucache

然后把源码中的三个类拷贝到工程中。

DiskLruCache常用方法:

方法 备注
DiskLruCache open(File directory, int appVersion, int valueCount, long maxSize) 打开一个缓存目录,如果没有则首先创建它,directory:指定数据缓存地址 appVersion:APP版本号,当版本号改变时,缓存数据会被清除 valueCount:同一个key可以对应多少文件 maxSize:最大可以缓存的数据量
Editor edit(String key) 通过key可以获得一个DiskLruCache.Editor,通过Editor可以得到一个输出流,进而缓存到本地存储上
void flush() 强制缓冲文件保存到文件系统
Snapshot get(String key) 通过key值来获得一个Snapshot,如果Snapshot存在,则移动到LRU队列的头部来,通过Snapshot可以得到一个输入流InputStream
long size() 缓存数据的大小,单位是byte
boolean remove(String key) 根据key值来删除对应的数据,如果该数据正在被编辑,则不能删除
void delete() 关闭缓存并且删除目录下所有的缓存数据,即使有的数据不是由DiskLruCache 缓存到本目录的
void close() 关闭DiskLruCache,缓存数据会保留在外存中
boolean isClosed() 判断DiskLruCache是否关闭,返回true表示已关闭
File getDirectory() 缓存数据的目录

初始化缓存对象

接下来具体介绍DiskLruCache的简单方法。首先我们在使用某个类的时候,一般都是首先找到它的构造方法,但是我们发现该类是final 类,无法被继承,并且构造方法是私有的方法,不能手动调用。

public final class DiskLruCache implements Closeable {

 private DiskLruCache(File directory, int appVersion, int valueCount, long maxSize) {
  this.directory = directory;
  this.appVersion = appVersion;
  this.journalFile = new File(directory, JOURNAL_FILE);
  this.journalFileTmp = new File(directory, JOURNAL_FILE_TEMP);
  this.journalFileBackup = new File(directory, JOURNAL_FILE_BACKUP);
  this.valueCount = valueCount;
  this.maxSize = maxSize;
 }

所以在初始化DiskLruCache的时候调用它的open方法

 //四个参数分别为,1.缓存的路径目录 2.版本号 3.每个节点对应的数据个数,4.缓存的大小,10 * 1024 * 1024 = 10M
      DiskLruCache diskLruCache = DiskLruCache.open(getCachFile(context, uniqueName), 1, 1, cacheSize);

/**
   * 获取缓存目录
   *
   * @param context
   * @param uniqueName 指定目录下的文件名
   */
  private File getCachFile(Context context, String uniqueName) {
    String catchPath;
    //有内存卡,并且内存卡没有正在移除,就把文件缓存到内存卡中
    if (Environment.MEDIA_MOUNTED.equals(Environment.getExternalStorageState()) || !Environment.isExternalStorageRemovable()) {
      catchPath = context.getExternalCacheDir().getPath();
    } else {
      catchPath = context.getCacheDir().getPath();
    }
    return new File(catchPath + File.separator + uniqueName);
  }

要传入四个参数:

  • File directory:sdcard缓存的目录。
  • int appVersion:版本号,一般传1即可
  • int valueCount:缓存的数据由key对应着,表示一个key对应多少个数据,一般传1即可
  • long maxSiz:缓存的大小 10 * 1024 * 1024 = 10M

传入sdcard缓存的目录的时候,记得先判断sdcard是否存在,或者sdcard是否正在移除。如果是这两种情况。缓存目录就设置为getCacheDir().getPath();在内存中缓存。

写入缓存

初始化缓存完成之后,就写入缓存,这个时候需要从网上下载一张图片。

new Thread() {
          @Override
          public void run() {
            DiskLruCache.Editor editor = null;
            try {
              //创建 Editor 对象
              editor = diskLruCache.edit(hashKeyForDisk(url));
              if (editor != null) {
                //创建输出流
                OutputStream outputStream = editor.newOutputStream(0);
                //url 也就是 下载图片的地址
                //outputStream 的作用在于,
                //从网络下载图片的时候,图片通过该输出流写到文件系统,
                //也就是说,图片下载到了磁盘缓存中。
                if (downloadUrlToStream(url, outputStream)) {
                  editor.commit();
                } else {
                  //释放编辑锁
                  editor.abort();
                }
                diskLruCache.flush();
              }

            } catch (Exception e) {
              e.printStackTrace();
            }

          }
        }.start();
 /**
   * 将key进行加密
   *
   * @param key
   * @return
   */
  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();
  }

我们首先初始化 DiskLruCache.Editor editor对象,把图片的url经过MD5加密,然后作为缓存图片的key。这里为什么不直接用url作为key而要进行md5加密呢。因为url中,可能存在一些特殊字符,这样一来可能在命名文件的时候不合法。 md5加密之后的字符是唯一的,并且都是0-F的字符。然后创建OutputStream outputStream对象

OutputStream outputStream = editor.newOutputStream(0);

下载图片之后就是通过该输出流进行写入文件,也就是说,把下载下来的图片写入到缓存目录中。

 //也就是说,图片下载到了磁盘缓存中。
                if (downloadUrlToStream(url, outputStream)) {
                  editor.commit();
                } else {
                  //释放编辑锁
                  editor.abort();
                }
                diskLruCache.flush();

下载成功后调用 editor.commit();提交即可。

我们具体看下下载图片的方法

/**
   * 从网络中下载图片,并写到缓存中
   *
   * @param urlString
   * @param outputStream
   * @return
   */
  private boolean downloadUrlToStream(String urlString, OutputStream outputStream) {
    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(), 8 * 1024);
      out = new BufferedOutputStream(outputStream, 8 * 1024);
      int b;
      while ((b = in.read()) != -1) {
        out.write(b);
      }
      return true;
    } catch (final IOException e) {
      e.printStackTrace();
    } finally {
      if (urlConnection != null) {
        urlConnection.disconnect();
      }
      try {
        if (out != null) {
          out.close();
        }
        if (in != null) {
          in.close();
        }
      } catch (final IOException e) {
        e.printStackTrace();
      }
    }
    return false;
  }

我们看到下载的图片写到 OutputStream outputStream中,也就是写到了缓存中。这样一来就把图片写到了缓存中了。
我们看下缓存图片的目录:

我们看到这里有一个journal文件和一个名字很长的文件,名字很长的文件,就是我们的缓存文件了,因为是经过md5加密后的字符串。

读取缓存

接下里我们介绍如何读取缓存文件。

 DiskLruCache.Snapshot snapshot = diskLruCache.get(hashKeyForDisk(url));
        if(snapshot!=null){
          InputStream inputStream = snapshot.getInputStream(0);
          Bitmap bitmap = BitmapFactory.decodeStream(inputStream);
          //如果不为空,则直接展示缓存中的bitmap
          imageView.setImageBitmap(bitmap);
        }

这里为什么是getInputStream(0);呢。因为我们上面定义了一个key对应一个数据,所以只获取第0个即可
我们看下运行的效果图:

移除缓存

调用remove方法,移除指定的数据。

public synchronized boolean remove(String key) throws IOException 

其他api

1.flush()

用于将内存中的操作记录同步到日志文件,也就是sdcard中的journal文件。DiskLruCache正常工作就要依赖该文件中的内容。但是没必要每次写入缓存操作的时候都调用一次,一般在Activity的onPause方法中调用一次即可。

2.delete()

删除所有的缓存

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持我们。

时间: 2018-08-25

浅谈Android LruCache的缓存策略

一.Android中的缓存策略 一般来说,缓存策略主要包含缓存的添加.获取和删除这三类操作.如何添加和获取缓存这个比较好理解,那么为什么还要删除缓存呢?这是因为不管是内存缓存还是硬盘缓存,它们的缓存大小都是有限的.当缓存满了之后,再想其添加缓存,这个时候就需要删除一些旧的缓存并添加新的缓存. 因此LRU(Least Recently Used)缓存算法便应运而生,LRU是近期最少使用的算法,它的核心思想是当缓存满时,会优先淘汰那些近期最少使用的缓存对象.采用LRU算法的缓存有两种:LrhCach

详解Android的内存优化--LruCache

概念: LruCache 什么是LruCache? LruCache实现原理是什么? 这两个问题其实可以作为一个问题来回答,知道了什么是 LruCache,就只然而然的知道 LruCache 的实现原理:Lru的全称是Least Recently Used ,近期最少使用的!所以我们可以推断出 LruCache 的实现原理:把近期最少使用的数据从缓存中移除,保留使用最频繁的数据,那具体代码要怎么实现呢,我们进入到源码中看看. LruCache源码分析 public class LruCache<

Android缓存机制——LruCache的详解

概述 LruCache的核心原理就是对LinkedHashMap的有效利用,它的内部存在一个LinkedHashMap成员变量,值得注意的4个方法:构造方法.get.put.trimToSize LRU(Least Recently Used)缓存算法便应运而生,LRU是最近最少使用的算法,它的核心思想是当缓存满时,会优先淘汰那些最近最少使用的缓存对象.采用LRU算法的缓存有两种:LrhCache和DisLruCache,分别用于实现内存缓存和硬盘缓存,其核心思想都是LRU缓存算法. LRU原理

Android 加载大图、多图和LruCache缓存详细介绍

我们在编写Android程序的时候经常要用到许多图片,不同图片总是会有不同的形状.不同的大小,但在大多数情况下,这些图片都会大于我们程序所需要的大小.比如说系统图片库里展示的图片大都是用手机摄像头拍出来的,这些图片的分辨率会比我们手机屏幕的分辨率高得多.大家应该知道,我们编写的应用程序都是有一定内存限制的,程序占用了过高的内存就容易出现OOM(OutOfMemory)异常.我们可以通过下面的代码看出每个应用程序最高可用内存是多少 int maxMemory = (int) (Runtime.ge

Android 加载大图及多图避免程序出现OOM(OutOfMemory)异常

Android 加载大图及多图避免程序出现OOM(OutOfMemory)异常 1.高效加载大图片 我们在编写Android程序的时候经常要用到许多图片,不同图片总是会有不同的形状.不同的大小,但在大多数情况下,这些图片都会大于我们程序所需要的大小.比如说系统图片库里展示的图片大都是用手机摄像头拍出来的,这些图片的分辨率会比我们手机屏幕的分辨率高得多.大家应该知道,我们编写的应用程序都是有一定内存限制的,程序占用了过高的内存就容易出现OOM(OutOfMemory)异常.我们可以通过下面的代码看

Android 加载GIF图最佳实践方案

起因 最近在项目中遇到需要在界面上显示一个本地的 GIF 图.按照惯例我直接用了 Glide 框架来实现. Glide 地址: https://github.com/bumptech/glide 我用的 Glide版本为 4.0.0-RC1 , 具体的实现代码如下: Glide.with( this ).asGif().load( R.drawable.yiba_location ).into( location_image ) ; 运行的效果很卡顿,我怀疑是不是方法没有用对,调了压缩模式,还是

Android之高效加载大图的方法示例

加载大图到内存是一件令人头疼的事情.因为大图的原因,我们会在Crash报告中看到OOM(内存不足).Android的内存有限,这一点我们应该心里有数. stackoverflow上有许多相关问题的回答,当你碰到oom时,可以直接跳过本文,粘贴复制答案即可.但是对于其他人来说,我想告诉你们一些加载大图的知识和原理. 加载Bitmap到内存 so easy.你所需要做的就是使用BitmapFactory解码你的图片. Bitmap bitmap = BitmapFactory.decodeResou

Android仿ios加载loading菊花图效果

项目中经常会用到加载数据的loading显示图,除了设计根据app自身设计的动画loading,一般用的比较多的是仿照ios 的菊花加载loading 图,当然一些条件下还会涉及到加载成功/ 失败情况的显示,还有显示文字.   使用ProgressBar 来加载动画转圈,这里使用drawable文件 定义转圈动画, indeterminateDrawable 属性进行加载. <?xml version="1.0" encoding="utf-8"?> &

在Android中高效的加载大图的方法示例

将大图加载到内存中总是令人痛苦,因为我们经常会在应用的崩溃报告中看到OOM(Out Of Memory)的bug.大家都知道,Android系统的内存有限.我们必须牢记这一点. stackoverflow上有很多关于大图加载的问题,当你的应用程序遇到OOM的时候,你可以选择直接复制粘贴其中的答案来解决这个问题.因此,你完全可以略过本篇文章,但我想介绍一些加载大图的基础知识及其实际工作的原理. 我只想解释图片解码背后的逻辑.我建议你使用Picasso或Glide来加载图片.没有必要重新发明轮子.

Android加载Gif动画实现代码

Android加载Gif动画如何实现?相信大家都很好奇,本文就为大家揭晓,内容如下 <?xml version="1.0" encoding="utf-8"?> <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" android:layout_width="fill_parent" android:layout_he

Android 加载assets中的资源文件实例代码

Android 加载assets资源 在android中,如何加载assets目录下的文件夹呢?方法很简单,使用 AssetManager, 即 AssetManager assetManager = getAssets(); 例子如下: AssetManager assetManager = getAssets(); try { String[] files = assetManager.list("Files"); for(int i=0; i<FILES.LENGTH; {

抽出www.templatemonster.com的鼠标悬停加载大图模板的代码

<html> <head>     <!--调用css调整显示层的属性-->     <link rel="stylesheet" href="lightBox.css" type="text/css">     <link rel="stylesheet" href="lightStyle.css" type="text/css"&

VC运用OPENGL加载BMP纹理图的实现方法汇总

OpenGL是专业的图形程序接口,功能非常强大,调用方便的底层图形库.本文汇总了运用OPENGL加载BMP纹理图的几个实现方法. 方法一: 首先获取位图句柄: HBITMAP hBmp = (HBITMAP) ::LoadImage (AfxGetResourceHandle(),MAKEINTRESOURCE(IDB_BITMAP1), IMAGE_BITMAP, 0, 0,LR_CREATEDIBSECTION); 然后根据位图句柄得到位图信息: BITMAP BM; ::GetObject