Android开源项目 异步图片缓存库 Universal-Image-Loader

在Android开发中，网络IO等耗时操作应独立于UI线程，对于需要使用大量网络图片的应用来说，能够异步下载并缓存图片的模块显得非常重要。
如名，异步缓存系统的两大特性是：
1.异步下载资源
2.缓存系统

基本思路：要实现一个最简单的异步缓存功能，可以开启一个Thread，通过Http下载图片，用HashMap缓存图片即可。

建立缓存时可以使用内存缓存和磁盘缓存，获取数据时先从内存缓存读取，如果没有数据则从磁盘缓存读取，再没有则从网络下载，下载完后记得写入磁盘缓存，内存缓存。
本文要介绍的 Universal-Image-Loader （以下简称UIL）也是类似思路，但功能更加强大，其建立了一套框架，方便扩展和配置，使用起来更为灵活。
UIL是GitHub上的开源项目，地址：https://github.com/nostra13/Android-Universal-Image-Loader
这里提供了完整的源码和示例，初次使用请阅读ReadMe文档了解基本情况。

使用方法：
1.Android工程导入库文件 universal-image-loader-xxx-with-sources.jar（在下载的downloads目录）
2.设置权限
<manifest>
<uses-permission android:name="android.permission.INTERNET" />
<!-- 如果要缓存图片到磁盘需要设置 -->
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
...
<application android:name="MyApplication">
...
</application>
</manifest>

3.编写代码
只需要三个步骤：
  (1) 配置选项
ImageLoaderConfiguration config = new ImageLoaderConfiguration.Builder(getApplicationContext())
...
.build();

  (2)初始化ImageLoader
ImageLoader.getInstance().init(config);

  (3)显示图片
ImageLoader.getInstance().displayImage(imageUrl, imageView); 
或
ImageLoader.getInstance().displayImage(imageUrl, listener); //通过listener传递ImageView对象

其中1,2两步初始化过程可以在继承Application的类中完成，第3步可以在Activity或Adapter等需要显示图片的类中完成

ImageLoader实现了displayImage和loadImage的多个不同版本的方法，具体可参考源码。

支持的URI类型

String imageUri = "http://site.com/image.png"; // 网络资源

String imageUri = "file:///mnt/sdcard/image.png"; // SD card 资源

String imageUri = "content://media/external/audio/albumart/13"; // content provider 资源

String imageUri = "assets://image.png"; // assets 资源

String imageUri = "drawable://" + R.drawable.image; // drawables 资源(针对非.9.png图片)

注：为提高效率，当使用"drawable://格式uri"时，尽量使用本地方法ImageView.setImageResource(...)

配置选项：
该项目包含2个配置选项的类：
1.ImageLoaderConfiguration 是全局配置，创建ImageLoader时使用
2.DisplayImageOptions 是局部配置，每次加载或显示图片时都可指定显示选项

ImageLoaderConfiguration 示例
//这里只是列出各种情况的例子，在设置自己的选项时不要完全拷贝这里的代码
//ImageLoaderConfiguration类中有个方法会判断如果某项没有设置，则创建默认的选项
File cacheDir = StorageUtils.getCacheDirectory(context);
ImageLoaderConfiguration config = new ImageLoaderConfiguration.Builder(context)
.memoryCacheExtraOptions(480, 800) //解析图片时使用的最大尺寸，默认为设备屏幕宽高
.discCacheExtraOptions(480, 800, CompressFormat.JPEG, 75, null) //从网络下载图片后保存到磁盘时使用的图片尺寸及压缩方法，如果不设置则保存原始图片
.taskExecutor(...)  //加载显示图片任务，默认创建一个以FIFO（先进先出）方式调度线程池的任务
.taskExecutorForCachedImages(...)  //显示图片任务（只针对已缓存到磁盘的图片），默认创建一个以FIFO（先进先出）方式调度线程池的任务
.threadPoolSize(3) // 线程池大小，这里是默认值（注意不要设太大，否则会有OOM问题）
.threadPriority(Thread.NORM_PRIORITY - 1) // 线程优先级，这里是默认值
.tasksProcessingOrder(QueueProcessingType.FIFO) // 线程调度方式，这里是默认值
.denyCacheImageMultipleSizesInMemory()  //关闭内存缓存同一张图片不同情况尺寸，对于同一张图片，当有不同尺寸缓存时后面尺寸会覆盖前面的尺寸
.memoryCache(new LruMemoryCache(2 * 1024 * 1024))   //设置内存缓存，默认会创建缓存大小为应用可用内存总大小1/8的LruMemoryCache
.memoryCacheSize(2 * 1024 * 1024)  //设置内存缓存大小
.memoryCacheSizePercentage(13) // 设置内存缓存大小在应用可用总内存大小的比例
.discCache(new UnlimitedDiscCache(cacheDir)) // 磁盘缓存，这里是默认方式
.discCacheSize(50 * 1024 * 1024)  //磁盘缓存大小
.discCacheFileCount(100)   //磁盘缓存文件数量（如果使用FileCountLimitedDiscCache）
.discCacheFileNameGenerator(new HashCodeFileNameGenerator()) // 磁盘缓存时文件命名方法，这里是默认值。另外该库还提供了MD5方式命名。
.imageDownloader(new BaseImageDownloader(context)) // 图片下载器，这里是默认方式
.imageDecoder(new BaseImageDecoder()) // 图片解码器，这里为默认方式
.defaultDisplayImageOptions(DisplayImageOptions.createSimple()) // 图片显示器，这里是默认方式
.writeDebugLogs()  //是否打印调试log
.build();

DisplayImageOptions 示例：
//这里只是列出各种情况的例子，在设置自己的选项时不要完全拷贝这里的代码
DisplayImageOptions options = new DisplayImageOptions.Builder()
.showImageOnLoading(R.drawable.ic_stub) // 加载图片时显示的图标
.showImageForEmptyUri(R.drawable.ic_empty) // uri为空时显示的图标
.showImageOnFail(R.drawable.ic_error) // 下载图片失败时显示的图标
.resetViewBeforeLoading(false)  // 加载图片前是否清空ImageView，默认为false
.delayBeforeLoading(1000) //加载图片前延迟时间，默认为0
.cacheInMemory(false) // 是否启用内存缓存，默认为false
.cacheOnDisc(false) // 是否启用磁盘缓存，默认为false
.preProcessor(...)  //图片处理函数，在图片缓存到内存之前运行
.postProcessor(...) //图片处理函数，在图片缓存到内存之后但显示图片之前运行
.extraForDownloader(...)  //下载图片时额外信息
.considerExifParams(false) // 解析图片时是否考虑JPEG图片的Exif信息，默认为false
.imageScaleType(ImageScaleType.IN_SAMPLE_POWER_OF_2) // 解析图片时缩放因子，这里是默认值
.bitmapConfig(Bitmap.Config.ARGB_8888) // 解析图片时采用的色彩格式，这里是默认值
.decodingOptions(...)  //解析图片时的option参数，该参数会覆盖上面的bitmapConfig中的参数，但其中的inSampleSize会被忽略，其采用imageScaleType设定的值
.displayer(new SimpleBitmapDisplayer()) // 图片显示器，这里是默认方式
.handler(new Handler()) // UI线程handler，用于绑定ImageView和Bitmap
.build();

目录结构



ImageLoaderEngine： 控制并发任务

LoadAndDisplayImageTask：加载和显示图片任务

xxxImageDownloader： 负责从网络，文件等获取图片数据流

xxxImageDecoder：解析图片

xxxBitmapDisplayer: 负责显示图片效果

  SimpleBitmapDisplayer：直接显示图片

  FadeInBitmapDisplayer：淡入淡出效果

  RoundedBitmapDisplayer：显示圆角

  RoundedVignetteBitmapDisplayer：圆角带光晕效果

  

Cache: 缓存

  MemoryCache: 内存缓存，通常使用元素为<String,Bitmap> 的Map来维护缓存内容
WeakMemoryCache：弱引用缓存，简单地对每个bitmap做弱引用
FuzzyKeyMemoryCache：可以传入比较规则，将不同的key视作相同，这样Map中新加元素时会将原来对应key的value覆盖
LruMemoryCache：当缓存容量超过最大值时，删除最近最少使用的对象
LRULimitedMemoryCache：当缓存容量超过最大值时，删除最近最少使用的对象
FIFOLimitedMemoryCache：当缓存容量超过最大值时，删除最先放入队列的对象
LargestLimitedMemoryCache：当缓存容量超过最大值时，删除当前最大的对象
LimitedAgeMemoryCache：当缓存容量超过最大值时，删除存活时间最长的对象
UsingFreqLimitedMemoryCache：当缓存容量超过最大值时，删除最不常使用的对象

  DiscCache: 磁盘缓存，使用元素为<String,Key>的Map来维护缓存内容
UnlimitedDiscCache：无限制
LimitedAgeDiscCache：当缓存对象缓存时间超过设定值时，将会被删除
TotalSizeLimitedDiscCache：当缓存容量超过最大值时，删除最不活跃的对象（上一次使用时间最早的对象）
FileCountLimitedDiscCache：当缓存文件数量超过最大值时，删除最不活跃的对象（上一次使用时间最早的对象）

缓存类图：





ImageLoaderEngine 中包含三个Executor成员对象，每个都带有线程池，其中一个Executor作为调度者用于管理另外两个Executor

另两个Executor一个用于下载网络图片，另一个专门处理已经在磁盘缓存过的图片。



整体流程图：



以上是关于UIL异步缓存框架的大体介绍，源码这里就不贴出来了，感兴趣的读者可以自己研究一下。

网上有很多详细介绍的，这里推荐几个：

Android 开源框架Universal-Image-Loader完全解析：

http://blog.csdn.net/xiaanming/article/details/26810303

Android 框架练成 教你打造高效的图片加载框架 ：
http://blog.csdn.net/lmj623565791/article/details/41874561