Android 应用开发 之使用LruCache和DiskLruCache来在内存和SD卡中缓存图片

android / By / 2015-08-28

http://blog.csdn.net/carrey1989/article/details/12152651

 

  之前写过一篇文章，通过Android提供的AsyncTask和自己实现的ThreadPool两种方法来实现了图片数据的异步加载，但在实际应用中，仅仅做到这样是不够的。我们在GridView中加载了大量的图片数据，但当我们向上向下来回滚动的时候，之前加载过的图片都会重新从服务器中获取，这样显然不是很好的用户体验。对用户来说，在上下滚动的时候，曾经看过不久的图片能够马上显示出来，而不是要等待从服务器下载那么久，才是更好的用户体验。

    为了实现这样的需求，Android为我们提供了LruCache和DiskLruCache两个工具。

    本文原创，如需转载，请注明转载地址http://blog.csdn.net/carrey1989/article/details/12152651

    我们今天讲解的代码建立在上一篇文章的基础之上，感兴趣的同学可以点击这里来查看。在文章最后有提供源码的下载链接。

    首先整体来说一下我们的思路：

    我们将在一个GridView中加载图片数据，在获取图片数据的时候，首先判断内存缓存中是否保存了这张图片。如果没有，将启动一个异步回调过程，先从SD卡中获得缓存的图片，如果依然没有，就会从服务器中来请求图片数据了。剩下的步骤就是刷新和缓存的工作了。

    上面的思路比较笼统，接下来会比较详细的讲解具体的代码。

    看一下项目的结构：

    与内存缓存和SD卡缓存相关的处理主要在MainActivity.java和MyThreadPoolTask.java两个类中。

    先看一下MainActivity.java的代码，下面会做出具体的解释：

[java] view plaincopy

  1. package com.carrey.bitmapcachedemo;
  3. import java.io.File;
  4. import java.lang.ref.SoftReference;
  5. import java.util.ArrayList;
  6. import java.util.HashMap;
  8. import com.carrey.customview.customview.CustomView;
  10. import android.os.Bundle;
  11. import android.os.Environment;
  12. import android.app.Activity;
  13. import android.content.Context;
  14. import android.graphics.Bitmap;
  15. import android.graphics.BitmapFactory;
  16. import android.util.Log;
  17. import android.view.LayoutInflater;
  18. import android.view.View;
  19. import android.view.ViewGroup;
  20. import android.widget.BaseAdapter;
  21. import android.widget.GridView;
  22. /**
  23.  * LruCache and DiskLruCache
  24.  * @author carrey
  25.  *
  26.  */
  27. public class MainActivity extends Activity {
  29.     private static final String TAG = “MainActivity”;
  31.     private LayoutInflater inflater;
  33.     private String webServerStr;
  35.     private ThreadPoolManager poolManager;
  37.     //LruCache
  38.     private static final int MEM_MAX_SIZE = 4 * 1024 * 1024;// MEM 4MB
  39.     private LruCache<String, Bitmap> mMemoryCache = null;
  41.     //DiskLruCache
  42.     private static final int DISK_MAX_SIZE = 32 * 1024 * 1024;// SD 32MB
  43.     private DiskLruCache mDiskCacke = null;
  45.     //下载任务队列 Map的key代表要下载的图片url，后面的List队列包含所有请求这张图片的回调
  46.     private HashMap<String, ArrayList<SoftReference<BitmapCallback>>> mCallbacks =
  47.             new HashMap<String, ArrayList<SoftReference<BitmapCallback>>>();
  49.     private GridView gridView;
  50.     private GridAdapter adapter;
  51.     @Override
  52.     protected void onCreate(Bundle savedInstanceState) {
  53.         super.onCreate(savedInstanceState);
  54.         setContentView(R.layout.activity_main);
  56.         webServerStr = getResources().getString(R.string.web_server);
  57.         inflater = (LayoutInflater) getSystemService(Context.LAYOUT_INFLATER_SERVICE);
  59.         poolManager = new ThreadPoolManager(ThreadPoolManager.TYPE_LIFO, 5);
  61.         //内存缓存
  62.         mMemoryCache = new LruCache<String, Bitmap>(MEM_MAX_SIZE) {
  63.             @Override
  64.             protected int sizeOf(String key, Bitmap value) {
  65.                 return value.getRowBytes() * value.getHeight();
  66.             }
  68.             @Override
  69.             protected void entryRemoved(boolean evicted, String key,
  70.                     Bitmap oldValue, Bitmap newValue) {
  71.                 // 不要在这里强制回收oldValue，因为从LruCache清掉的对象可能在屏幕上显示着，
  72.                 // 这样就会出现空白现象
  73.                 super.entryRemoved(evicted, key, oldValue, newValue);
  74.             }
  75.         };
  77.         //SD卡缓存
  78.         File cacheDir = new File(
  79.                 Environment.getExternalStorageDirectory().getAbsolutePath() +
  80.                 File.separator +
  81.                 “cacheDir”);
  82.         mDiskCacke = DiskLruCache.openCache(cacheDir, DISK_MAX_SIZE);
  84.         gridView = (GridView) findViewById(R.id.gridview);
  85.         adapter = new GridAdapter();
  86.         gridView.setAdapter(adapter);
  87.     }
  89.     private class GridAdapter extends BaseAdapter {
  90.         private Bitmap mBackgroundBitmap;
  92.         public GridAdapter() {
  93.             mBackgroundBitmap = BitmapFactory.decodeResource(getResources(), R.drawable.item_bg);
  94.         }
  95.         @Override
  96.         public int getCount() {
  97.             return 99;
  98.         }
  100.         @Override
  101.         public Object getItem(int position) {
  102.             return null;
  103.         }
  105.         @Override
  106.         public long getItemId(int position) {
  107.             return 0;
  108.         }
  110.         @Override
  111.         public View getView(int position, View convertView, ViewGroup parent) {
  112.             ViewHolder holder = null;
  113.             if (convertView == null) {
  114.                 holder = new ViewHolder();
  115.                 convertView = inflater.inflate(R.layout.item, null);
  116.                 holder.customView = (CustomView) convertView.findViewById(R.id.customview);
  117.                 convertView.setTag(holder);
  118.             } else {
  119.                 holder = (ViewHolder) convertView.getTag();
  120.             }
  121.             holder.customView.position = position;
  122.             holder.customView.setBackgroundBitmap(mBackgroundBitmap);
  124.             holder.customView.setTitleText(“cache demo”);
  125.             holder.customView.setSubTitleText(“position: “ + position);
  127.             String imageURL = ImageHelper.getImageUrl(webServerStr, position);
  128.             holder.customView.setUUID(imageURL);
  129.             holder.customView.setImageBitmap(getBitmap(holder.customView.getUUID(), holder.customView.getBitmapCallback()));
  130.             return convertView;
  131.         }
  133.     }
  135.     static class ViewHolder {
  136.         CustomView customView;
  137.     }
  139.     private Bitmap getBitmap(String url, BitmapCallback callback) {
  140.         if (url == null) {
  141.             return null;
  142.         }
  144.         synchronized (mMemoryCache) {
  145.             Bitmap bitmap = mMemoryCache.get(url);
  146.             if (bitmap != null && !bitmap.isRecycled()) {
  147.                 Log.i(TAG, “get bitmap from mem: url = “ + url);
  148.                 return bitmap;
  149.             }
  150.         }
  152.         //内存中没有，异步回调
  153.         if (callback != null) {
  154.             ArrayList<SoftReference<BitmapCallback>> callbacks = null;
  155.             synchronized (mCallbacks) {
  156.                 if ((callbacks = mCallbacks.get(url)) != null) {
  157.                     if (!callbacks.contains(callback)) {
  158.                         callbacks.add(new SoftReference<BitmapCallback>(callback));
  159.                     }
  160.                     return null;
  161.                 } else {
  162.                     callbacks = new ArrayList<SoftReference<BitmapCallback>>();
  163.                     callbacks.add(new SoftReference<BitmapCallback>(callback));
  164.                     mCallbacks.put(url, callbacks);
  165.                 }
  166.             }
  168.             poolManager.start();
  169.             poolManager.addAsyncTask(new MyThreadPoolTask(url, mDiskCacke, mTaskCallback));
  170.         }
  171.         return null;
  172.     }
  174.     private BitmapCallback mTaskCallback = new BitmapCallback() {
  176.         @Override
  177.         public void onReady(String key, Bitmap bitmap) {
  178.             Log.i(TAG, “task done callback url = “ + key);
  180.             ArrayList<SoftReference<BitmapCallback>> callbacks = null;
  181.             synchronized (mCallbacks) {
  182.                 if ((callbacks = mCallbacks.get(key)) != null) {
  183.                     mCallbacks.remove(key);
  184.                 }
  185.             }
  187.             if (bitmap != null) {
  188.                 synchronized (mDiskCacke) {
  189.                     if (!mDiskCacke.containsKey(key)) {
  190.                         Log.i(TAG, “put bitmap to SD url = “ + key);
  191.                         mDiskCacke.put(key, bitmap);
  192.                     }
  193.                 }
  194.                 synchronized (mMemoryCache) {
  195.                     Bitmap bmp = mMemoryCache.get(key);
  196.                     if (bmp == null || bmp.isRecycled()) {
  197.                         mMemoryCache.put(key, bitmap);
  198.                     }
  199.                 }
  200.             }
  202.             //调用请求这张图片的回调
  203.             if (callbacks != null) {
  204.                 for (int i = 0; i < callbacks.size(); i++) {
  205.                     SoftReference<BitmapCallback> ref = callbacks.get(i);
  206.                     BitmapCallback cal = ref.get();
  207.                     if (cal != null) {
  208.                         cal.onReady(key, bitmap);
  209.                     }
  210.                 }
  211.             }
  212.         }
  213.     };
  214. }

    在上面的代码中，我们对LruCache和DiskLruCache做了相关的初始化工作，设置了内存缓存的大小是4MB，SD卡缓存的大小是32MB。

    需要特别解释的是这里定义了一个任务队列mCallbacks变量，这是一个HashMap，其中key的值是要下载的图片的url，value是一个ArrayList，在这个List中保存的是所有请求这个url的图片的视图的刷新回调对象。简单的理解就是，key表示一个特定的资源，value表示哪些家伙请求了这个资源。

    我们在刷新视图的图片的时候，会先调用getBitmap方法，在其中先判断内存缓存中是否缓存了这张图片，如果有，就直接刷新，如果没有，就会向线程池中添加一个任务，启动一个异步刷新的过程，但是在这之前，会先对任务队列进行一些操作：我们会根据任务队列中的情况，判断当前是否有视图请求了这张图片，如果有，则再次判断当前请求的视图是否已经在队列之中。根据不同的情况，我们对队列进行不同的处理。

    接下来就进入MyThreadPoolTask.java了，代码如下：

[java] view plaincopy

  1. package com.carrey.bitmapcachedemo;
  3. import android.graphics.Bitmap;
  4. import android.os.Process;
  5. import android.util.Log;
  7. /**
  8.  * 任务单元，在内存缓存没有图片的情况下从sd卡或者网络中获得图片
  9.  * 然后调用回调来进行下一步操作
  10.  * @author carrey
  11.  *
  12.  */
  13. public class MyThreadPoolTask extends ThreadPoolTask {
  15.     private static final String TAG = “MyThreadPoolTask”;
  17.     private DiskLruCache mDiskLruCache;
  19.     private BitmapCallback callback;
  21.     public MyThreadPoolTask(String url, DiskLruCache mDiskLruCache, BitmapCallback callback) {
  22.         super(url);
  23.         this.mDiskLruCache = mDiskLruCache;
  24.         this.callback = callback;
  25.     }
  27.     @Override
  28.     public void run() {
  29.         Process.setThreadPriority(Process.THREAD_PRIORITY_LOWEST);
  30.         Bitmap bitmap = null;
  32.         synchronized (mDiskLruCache) {
  33.             bitmap = mDiskLruCache.get(url);
  34.         }
  36.         if (bitmap == null) {
  37.             Log.i(TAG, “bitmap from net, url = “ + url);
  38.             bitmap = ImageHelper.loadBitmapFromNet(url);
  39.         } else {
  40.             Log.i(TAG, “bitmap from SD, url = “ + url);
  41.         }
  43.         if (callback != null) {
  44.             callback.onReady(url, bitmap);
  45.         }
  46.     }
  48. }

    这里面的处理比较简单，我们先判断sd卡中是否有请求的资源，如果没有，将从网络中进行获取，最后调用MainActivity.java中实现的mTaskCallback回调对象，在回调的实现中，会依次更新内存缓存和SD卡缓存，然后依次循环请求该图片的队列，刷新他们的视图。

    之所以做了这样一个任务队列的设计，是因为异步过程有很多的不确定性。

    请求队列中视图的回调定义如下，在CustomView.java中：

[java] view plaincopy

  1. private String uuid = null;
  3. public void setUUID(String uuid) {
  4.     this.uuid = uuid;
  5. }
  7. public String getUUID() {
  8.     return this.uuid;
  9. }
  11. public BitmapCallback mBitmapCallback = new BitmapCallback() {
  13.     @Override
  14.     public void onReady(String key, Bitmap bitmap) {
  15.         if (bitmap != null && key != null && CustomView.this.uuid != null) {
  16.             if (key.equals(CustomView.this.uuid)) {
  17.                 setImageBitmap(bitmap);
  18.                 postInvalidate();
  19.             }
  20.         }
  21.     }
  22. };
  24. public BitmapCallback getBitmapCallback() {
  25.     return this.mBitmapCallback;
  26. }

    相比上一篇文章，我们添加了一个uuid属性，这也是因为convertView是不断复用的，如果一个convertView请求了一个网络资源，还没有加载，之后再次被复用，一旦第二次加载完成早于第一次加载，那么之后第一次加载的结果就会覆盖第二次加载，这样就造成了数据不准确，所以在这里需要一个标识作为判断，保证数据刷新的准确性。这里的uuid实际上是图片的url，所以如果两次请求的是同一张图片，这种情况是可以刷新两次的。

    今天的代码依然用到了之前写过的一个自定义控件，如果对此感兴趣，可以点击这里来查看。

    到这里关键的代码基本就讲解完了，具体实现的效果如下：

    通过与上一篇文章的效果对比可以看出，在之前加载过的图片数据再次加载的速度上要快了不少。
如果我们这个时候退出应用，然后再次打开应用，这个时候加载的图片实际上都是从SD卡中加载的：

    DiskLruCache会在SD卡中创建我们指定的缓存目录，在其中会存放我们缓存的文件：

    下面贴出源码的下载链接，如果有什么问题，欢迎留言交流！

源码下载

版权声明：本文为博主原创文章，未经博主允许不得转载。