跟着我一步步写一个图片加载框架

起因

对于Android开发来说, 图片加载框架相信很多人都用过, 比如Android-Universal-Image-Loader, Picasso, Glide等等, 但是如果能够自己去实现一个图片加载框架, 那对于充分理解图片的三级缓存（三级还是二级？emmm...其实这并不重要）是十分有帮助的，同时也能让我们更好的理解那些知名的图片加载框架的原理。下面我将演示如何写一个简易的图片加载框架。

---

模块结构

首先说明一下框架的整体结构。
这是我定义的ImageLoader的结构，里面含有两个成员变量：MemoryCache和DiskCache，是我自定义的两个类。MemoryCache负责管理内存中的bitmap加载。DiskCache负责磁盘的bitmap加载,同时DiskCache中有一个ImageFetcher的模块，负责从网络下载图片到本地磁盘。

---

加载流程

现在来梳理一下图片的加载流程。

具体就是如上面的流程图所示，已经画的比较详细了。首先ImageLoader根据图片的url从MemoryCache中取bitmap，如果MemoryCache中没有，就去DiskCache中取bitmap。DiskCache根据图片url先从磁盘取bitmap，如果没有就从网络下载图片到磁盘，然后再从磁盘取出这张bitmap返回给ImageLoader。最后就是将这张bitmap设置到ImageView上。接下来就是具体的细节代码了。

---

ImageLoader

ImageLoader中主要的是displayImage(String url, ImageView iv)这个方法

public void displayImage(final String url, final ImageView imageView, final int reqWidth, final int reqHeight) {
    imageView.setTag(url);
        Bitmap bitmap = mMemoryCache.get(url);
        if (bitmap != null) {
            imageView.setImageBitmap(bitmap);
            return;
        }
        Runnable loadBitmapRunnable = new Runnable() {
            @Override
            public void run() {
                // 从本地或者网络获取图片, 在子线程中进行
                final Bitmap bitmap = mDiskCache.get(url, reqWidth, reqHeight);
                if (bitmap == null) {
                    return;
                }
                // 添加到内存缓存中
                mMemoryCache.put(url, bitmap);
                mHandler.post(new Runnable() {
                    @Override
                    public void run() {
                        // 判断是否数据错乱, 因为加载图片的过程过程是异步的, 哪些图片先下载好是不一定的
                        // 有可能一张图片先下了, 但是另一张图片后下载的却比它下载的更快
                        String uri =(String)imageView.getTag();
                        if (TextUtils.equals(url, uri)) {
                            imageView.setImageBitmap(bitmap);
                        } else {
                            Log.w(TAG, "The url associated with imageView has changed");
                        }
                    }
                });
            }
        };
        mThreadPoolExecutor.execute(loadBitmapRunnable);
}

这里需要注意的地方是需要将url设置为ImageView的tag, 主要作用是为了防止listView或者recyclerView加载图片错乱的问题。产生错乱的原因是listview复用了机制和异步加载任务造成的。具体可以见这两篇文章 android listview 异步加载图片并防止错位
Android ListView异步加载图片乱序问题，原因分析及解决方案
想起之前面试的时候还被问到怎么解决ListView图片错乱的问题，我直接说我没遇到过这个问题（==...我真没遇到过），现在想来，是我使用的那些图片加载框架已经帮我处理了这个问题。

---

MemoryCache

MemoryCache这里使用了Android自带的LruCache,全部代码也就这么多

public class MemoryCache implements ImageCache {
    private LruCache mMemoryCache;
    
    public MemoryCache() {
        final int MAX_MEMORY = (int) (Runtime.getRuntime().maxMemory() / 1024);
        final int CACHE_SIZE = MAX_MEMORY / 4;
        mMemoryCache = new LruCache(CACHE_SIZE) {
            @Override
            protected int sizeOf(String key, Bitmap bitmap) {
                return bitmap.getByteCount() / 1024;
            }
        };
    }
    
    @Override
    public Bitmap get(String url) {
        return mMemoryCache.get(getKey(url));
    }
    
    public void put(String url, Bitmap bitmap) {
        mMemoryCache.put(getKey(url), bitmap);
    }
    
    private String getKey(String url) {
        return MD5Util.hashKeyFromUrl(url);
    }
    
    @Override
    public void remove(String url) {
        mMemoryCache.remove(getKey(url));
    }
}

这里就不讲LruCache的原理了，有兴趣可以看这篇彻底解析Android缓存机制——LruCache

---

DiskCache

DiskCache这里使用了第三方的DiskLruCache，用法可以参考郭霖大神的这篇Android DiskLruCache完全解析，硬盘缓存的最佳方案
主要的方法如下

public Bitmap get(String url, int reqWidth, int reqHeight) {
        Bitmap bitmap = getFromDiskCache(url, reqWidth, reqHeight);
        if (bitmap != null) {
            return bitmap;
        }
        downloadBitmapToDiskCache(url);
        return getFromDiskCache(url, reqWidth, reqHeight);
    }
    
    public void downloadBitmapToDiskCache(String url) {
        String key = MD5Util.hashKeyFromUrl(url);
        try {
            DiskLruCache.Editor editor = mDiskLruCache.edit(key);
            if (editor == null) {
                return;
            }
            // 由于在创建DiskLruCache的时候valueCount指定为1, 所以这里索引传0就可以了
            OutputStream outputStream = editor.newOutputStream(0);
            if (mImageFetcher.downloadSuccess(url, outputStream)) {
                editor.commit();
            } else {
                editor.abort();
            }
            mDiskLruCache.flush();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
    
    public Bitmap getFromDiskCache(String url, int reqWidth, int reqHeight) {
        String key = MD5Util.hashKeyFromUrl(url);
        try {
            DiskLruCache.Snapshot snapshot = mDiskLruCache.get(key);
            if (snapshot == null) {
                return null;
            }
            FileInputStream fis = (FileInputStream) snapshot.getInputStream(0);
            if (reqWidth <= 0 || reqHeight <= 0) {
                return BitmapFactory.decodeStream(fis);
            } else {
                return BitmapUtils.getSmallBitmap(fis.getFD(), reqWidth, reqHeight);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }

---

ImageFetcher

ImageFetcher其实是一个接口类，里面包含了一个下载图片到输出流的方法

boolean downloadSuccess(String urlString, OutputStream outputStream);

然后我定义了一个UrlConnectionImageFetcher实现了这个接口，重写了downloadSuccess(url, out)方法

@Override
    public boolean downloadSuccess(String urlString, OutputStream outputStream) {
        if (Looper.myLooper() == Looper.getMainLooper()) {
            throw new RuntimeException("Do not load Bitmap in main thread.");
        }
        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());
            out = new BufferedOutputStream(outputStream);
            
            int len;
            byte[] buffer = new byte[8 * 1024];
            while ((len = in.read(buffer)) != -1) {
                out.write(buffer, 0, len);
            }
            return true;
        } catch (final Exception e) {
            Log.e(TAG, "Error in downloadBitmap - " + e);
        } finally {
            if (urlConnection != null) {
                urlConnection.disconnect();
            }
            CloseUtil.CloseQuietly(in);
            CloseUtil.CloseQuietly(out);
        }
        return false;
    }

为什么我要这样做呢？其实是因为依赖倒置原则。假如DiskCache直接依赖于UrlConnectionImageFetcher,当我想使用别的网络框架比如OkHttp而不是HttpURLConnection来下载图片时,就必须修改DiskCache的代码。而如果依赖抽象，假如我想用OkHttp来下载，只要再定义一个OkHttpImageFetcher实现ImageFetcher的接口，然后调用DiskCache的setImageFetcher(ImageFetcher fetcher)方法替换其中的ImageFetcher，DiskCache还是调用的ImageFetcher的downloadSuccess()方法，但是调用的却是OkHttpImageFetcher中的具体代码了。

---

结语

最后上一个github地址
https://github.com/mundane799699/SimpleImageLoader