Android开源框架Universal-Image-Loader完全解析（一） -基本介绍及使用
本文出自xiaanming的博客（http://blog.csdn.net/xiaanming/article/details/26810303）.
相信大家平时做Android应用的时候，多少会接触到异步加载图片，或者加载大量图片的问题，而加载图片我们常常会遇到许多的问题，比如说图片的错乱，OOM等问题，对于新手来说，这些问题解决起来会比较吃力，所以就有很多的开源图片加载框架应运而生，比较著名的就是Universal-Image-Loader，相信很多朋友都听过或者使用过这个强大的图片加载框架，今天这篇文章就是对这个框架的基本介绍以及使用，主要是帮助那些没有使用过这个框架的朋友们。该项目存在于Github上面https://github.com/nostra13/Android-Universal-Image-Loader，我们可以先看看这个开源库存在哪些特征
多线程下载图片，图片可以来源于网络，文件系统，项目文件夹assets中以及drawable中等支持随意的配置ImageLoader，例如线程池，图片下载器，内存缓存策略，硬盘缓存策略，图片显示选项以及其他的一些配置支持图片的内存缓存，文件系统缓存或者SD卡缓存支持图片下载过程的监听根据控件(ImageView)的大小对Bitmap进行裁剪，减少Bitmap占用过多的内存较好的控制图片的加载过程，例如暂停图片加载，重新开始加载图片，一般使用在ListView,GridView中，滑动过程中暂停加载图片，停止滑动的时候去加载图片提供在较慢的网络下对图片进行加载
当然上面列举的特性可能不全，要想了解一些其他的特性只能通过我们的使用慢慢去发现了，接下来我们就看看这个开源库的简单使用吧
新建一个Android项目，下载JAR包添加到工程libs目录下
新建一个MyApplication继承Application，并在onCreate()中创建ImageLoader的配置参数，并初始化到ImageLoader中代码如下
01.
package com.example.uil;
02.
03.
import com.nostra13.universalimageloader.core.ImageLoader;
04.
import com.nostra13.universalimageloader.core.ImageLoaderConfiguration;
05.
06.
import android.app.Application;
07.
08.
public class MyApplication extends Application {
09.
10.
@Override
11.
public void onCreate() {
12.
super.onCreate();
13.
14.
//创建默认的ImageLoader配置参数
15.
ImageLoaderConfiguration configuration = ImageLoaderConfiguration
16.
.createDefault(this);
17.
18.
//Initialize ImageLoader with configuration.
19.
ImageLoader.getInstance().init(configuration);
20.
}
21.
22.
}
01.
File cacheDir = StorageUtils.getCacheDirectory(context);
02.
ImageLoaderConfiguration config = new ImageLoaderConfiguration.Builder(context)
03.
.memoryCacheExtraOptions(480, 800) // default = device screen dimensions
04.
.diskCacheExtraOptions(480, 800, CompressFormat.JPEG, 75, null)
05.
.taskExecutor(...)
06.
.taskExecutorForCachedImages(...)
07.
.threadPoolSize(3) // default
08.
.threadPriority(Thread.NORM_PRIORITY - 1) // default
09.
.tasksProcessingOrder(QueueProcessingType.FIFO) // default
10.
.denyCacheImageMultipleSizesInMemory()
11.
.memoryCache(new LruMemoryCache(2 * 1024 * 1024))
12.
.memoryCacheSize(2 * 1024 * 1024)
13.
.memoryCacheSizePercentage(13) // default
14.
.diskCache(new UnlimitedDiscCache(cacheDir)) // default
15.
.diskCacheSize(50 * 1024 * 1024)
16.
.diskCacheFileCount(100)
17.
.diskCacheFileNameGenerator(new HashCodeFileNameGenerator()) // default
18.
.imageDownloader(new BaseImageDownloader(context)) // default
19.
.imageDecoder(new BaseImageDecoder()) // default
20.
.defaultDisplayImageOptions(DisplayImageOptions.createSimple()) // default
21.
.writeDebugLogs()
22.
.build();
上面的这些就是所有的选项配置，我们在项目中不需要每一个都自己设置，一般使用createDefault()创建的ImageLoaderConfiguration就能使用，然后调用ImageLoader的init（）方法将ImageLoaderConfiguration参数传递进去，ImageLoader使用单例模式。
配置Android Manifest文件
01.
02.
"android.permission.INTERNET" />03.
04.
"android.permission.WRITE_EXTERNAL_STORAGE" />05.
...
06.
"MyApplication">07.
...
08.
09.
接下来我们就可以来加载图片了，首先我们定义好Activity的布局文件
01.
"1.0" encoding="utf-8"?>02.
"http://schemas.android.com/apk/res/android"03.
android:layout_width="fill_parent"
04.
android:layout_height="fill_parent">
05.
06.
07.
android:layout_gravity="center"
08.
android:id="@+id/image"
09.
android:src="@drawable/ic_empty"
10.
android:layout_width="wrap_content"
11.
android:layout_height="wrap_content" />
12.
13.
里面只有一个ImageView，很简单，接下来我们就去加载图片，我们会发现ImageLader提供了几个图片加载的方法，主要是这几个displayImage(), loadImage(),loadImageSync()，loadImageSync()方法是同步的，android4.0有个特性，网络操作不能在主线程，所以loadImageSync()方法我们就不去使用
.
loadimage()加载图片
我们先使用ImageLoader的loadImage()方法来加载网络图片
01.
final ImageView mImageView = (ImageView) findViewById(R.id.image);
02.
String imageUrl ="https://lh6.googleusercontent.com/-55osAWw3x0Q/URquUtcFr5I/AAAAAAAAAbs/rWlj1RUKrYI/s1024/A%252520Photographer.jpg";
03.
04.
ImageLoader.getInstance().loadImage(imageUrl, new ImageLoadingListener() {
05.
06.
@Override
07.
public void onLoadingStarted(String imageUri, View view) {
08.
09.
}
10.
11.
@Override
12.
public void onLoadingFailed(String imageUri, View view,
13.
FailReason failReason) {
14.
15.
}
16.
17.
@Override
18.
public void onLoadingComplete(String imageUri, View view, Bitmap loadedImage) {
19.
mImageView.setImageBitmap(loadedImage);
20.
}
21.
22.
@Override
23.
public void onLoadingCancelled(String imageUri, View view) {
24.
25.
}
26.
});
01.
final ImageView mImageView = (ImageView) findViewById(R.id.image);
02.
String imageUrl ="https://lh6.googleusercontent.com/-55osAWw3x0Q/URquUtcFr5I/AAAAAAAAAbs/rWlj1RUKrYI/s1024/A%252520Photographer.jpg";
03.
04.
ImageLoader.getInstance().loadImage(imageUrl, new SimpleImageLoadingListener(){
05.
06.
@Override
07.
public void onLoadingComplete(String imageUri, View view,
08.
Bitmap loadedImage) {
09.
super.onLoadingComplete(imageUri, view, loadedImage);
10.
mImageView.setImageBitmap(loadedImage);
11.
}
12.
13.
});
01.
final ImageView mImageView = (ImageView) findViewById(R.id.image);
02.
String imageUrl ="https://lh6.googleusercontent.com/-55osAWw3x0Q/URquUtcFr5I/AAAAAAAAAbs/rWlj1RUKrYI/s1024/A%252520Photographer.jpg";
03.
04.
ImageSize mImageSize = new ImageSize(100, 100);
05.
06.
ImageLoader.getInstance().loadImage(imageUrl, mImageSize, new SimpleImageLoadingListener(){
07.
08.
@Override
09.
public void onLoadingComplete(String imageUri, View view,
10.
Bitmap loadedImage) {
11.
super.onLoadingComplete(imageUri, view, loadedImage);
12.
mImageView.setImageBitmap(loadedImage);
13.
}
14.
15.
});
上面只是很简单的使用ImageLoader来加载网络图片，在实际的开发中，我们并不会这么使用，那我们平常会怎么使用呢？我们会用到DisplayImageOptions，他可以配置一些图片显示的选项，比如图片在加载中ImageView显示的图片，是否需要使用内存缓存，是否需要使用文件缓存等等，可供我们选择的配置如下
01.
DisplayImageOptions options = new DisplayImageOptions.Builder()
02.
.showImageOnLoading(R.drawable.ic_stub) // resource or drawable
03.
.showImageForEmptyUri(R.drawable.ic_empty) // resource or drawable
04.
.showImageOnFail(R.drawable.ic_error) // resource or drawable
05.
.resetViewBeforeLoading(false) // default
06.
.delayBeforeLoading(1000)
07.
.cacheInMemory(false) // default
08.
.cacheOnDisk(false) // default
09.
.preProcessor(...)
10.
.postProcessor(...)
11.
.extraForDownloader(...)
12.
.considerExifParams(false) // default
13.
.imageScaleType(ImageScaleType.IN_SAMPLE_POWER_OF_2) // default
14.
.bitmapConfig(Bitmap.Config.ARGB_8888) // default
15.
.decodingOptions(...)
16.
.displayer(new SimpleBitmapDisplayer()) // default
17.
.handler(new Handler()) // default
18.
.build();
我们将上面的代码稍微修改下
01.
final ImageView mImageView = (ImageView) findViewById(R.id.image);
02.
String imageUrl ="https://lh6.googleusercontent.com/-55osAWw3x0Q/URquUtcFr5I/AAAAAAAAAbs/rWlj1RUKrYI/s1024/A%252520Photographer.jpg";
03.
ImageSize mImageSize = new ImageSize(100, 100);
04.
05.
//显示图片的配置
06.
DisplayImageOptions options = new DisplayImageOptions.Builder()
07.
.cacheInMemory(true)
08.
.cacheOnDisk(true)
09.
.bitmapConfig(Bitmap.Config.RGB_565)
10.
.build();
11.
12.
ImageLoader.getInstance().loadImage(imageUrl, mImageSize, options, new SimpleImageLoadingListener(){
13.
14.
@Override
15.
public void onLoadingComplete(String imageUri, View view,
16.
Bitmap loadedImage) {
17.
super.onLoadingComplete(imageUri, view, loadedImage);
18.
mImageView.setImageBitmap(loadedImage);
19.
}
20.
21.
});
我们使用了DisplayImageOptions来配置显示图片的一些选项，这里我添加了将图片缓存到内存中已经缓存图片到文件系统中，这样我们就不用担心每次都从网络中去加载图片了，是不是很方便呢，但是DisplayImageOptions选项中有些选项对于loadImage()方法是无效的，比如showImageOnLoading, showImageForEmptyUri等，
displayImage()加载图片
接下来我们就来看看网络图片加载的另一个方法displayImage()，代码如下
01.
final ImageView mImageView = (ImageView) findViewById(R.id.image);
02.
String imageUrl ="https://lh6.googleusercontent.com/-55osAWw3x0Q/URquUtcFr5I/AAAAAAAAAbs/rWlj1RUKrYI/s1024/A%252520Photographer.jpg";
03.
04.
//显示图片的配置
05.
DisplayImageOptions options = new DisplayImageOptions.Builder()
06.
.showImageOnLoading(R.drawable.ic_stub)
07.
.showImageOnFail(R.drawable.ic_error)
08.
.cacheInMemory(true)
09.
.cacheOnDisk(true)
10.
.bitmapConfig(Bitmap.Config.RGB_565)
11.
.build();
12.
13.
ImageLoader.getInstance().displayImage(imageUrl, mImageView, options);
从上面的代码中，我们可以看出，使用displayImage()比使用loadImage()方便很多，也不需要添加ImageLoadingListener接口，我们也不需要手动设置ImageView显示Bitmap对象，直接将ImageView作为参数传递到displayImage()中就行了，图片显示的配置选项中，我们添加了一个图片加载中ImageVIew上面显示的图片，以及图片加载出现错误显示的图片，效果如下，刚开始显示ic_stub图片，如果图片加载成功显示图片，加载产生错误显示ic_error
这个方法使用起来比较方便，而且使用displayImage()方法 他会根据控件的大小和imageScaleType来自动裁剪图片，我们修改下MyApplication，开启Log打印
01.
public class MyApplication extends Application {
02.
03.
@Override
04.
public void onCreate() {
05.
super.onCreate();
06.
07.
//创建默认的ImageLoader配置参数
08.
ImageLoaderConfiguration configuration = new ImageLoaderConfiguration.Builder(this)
09.
.writeDebugLogs() //打印log信息
10.
.build();
11.
12.
13.
//Initialize ImageLoader with configuration.
14.
ImageLoader.getInstance().init(configuration);
15.
}
16.
17.
}
我们来看下图片加载的Log信息
第一条信息中，告诉我们开始加载图片，打印出图片的url以及图片的最大宽度和高度，图片的宽高默认是设备的宽高，当然如果我们很清楚图片的大小，我们也可以去设置这个大小，在ImageLoaderConfiguration的选项中memoryCacheExtraOptions(int maxImageWidthForMemoryCache, int maxImageHeightForMemoryCache)
第二条信息显示我们加载的图片来源于网络
第三条信息显示图片的原始大小为1024 x 682 经过裁剪变成了512 x 341
第四条显示图片加入到了内存缓存中，我这里没有加入到sd卡中，所以没有加入文件缓存的Log
我们在加载网络图片的时候，经常有需要显示图片下载进度的需求，Universal-Image-Loader当然也提供这样的功能，只需要在displayImage()方法中传入ImageLoadingProgressListener接口就行了，代码如下
1.
imageLoader.displayImage(imageUrl, mImageView, options, new SimpleImageLoadingListener(), new ImageLoadingProgressListener() {
2.
3.
@Override
4.
public void onProgressUpdate(String imageUri, View view, int current,
5.
int total) {
6.
7.
}
8.
});
加载其他来源的图片
使用Universal-Image-Loader框架不仅可以加载网络图片，还可以加载sd卡中的图片，Content provider等，使用也很简单，只是将图片的url稍加的改变下就行了，下面是加载文件系统的图片
01.
//显示图片的配置
02.
DisplayImageOptions options = new DisplayImageOptions.Builder()
03.
.showImageOnLoading(R.drawable.ic_stub)
04.
.showImageOnFail(R.drawable.ic_error)
05.
.cacheInMemory(true)
06.
.cacheOnDisk(true)
07.
.bitmapConfig(Bitmap.Config.RGB_565)
08.
.build();
09.
10.
final ImageView mImageView = (ImageView) findViewById(R.id.image);
11.
String imagePath = "/mnt/sdcard/image.png";
12.
String imageUrl = Scheme.FILE.wrap(imagePath);
13.
14.
// String imageUrl = "https://img-my.csdn.net/uploads/201309/01/1378037235_7476.jpg";
15.
16.
imageLoader.displayImage(imageUrl, mImageView, options);
1.
//图片来源于Content provider
2.
String contentprividerUrl = "content://media/external/audio/albumart/13";
3.
4.
//图片来源于assets
5.
String assetsUrl = Scheme.ASSETS.wrap("image.png");
6.
7.
//图片来源于
8.
String drawableUrl = Scheme.DRAWABLE.wrap("R.drawable.image");
GirdView,ListView加载图片
相信大部分人都是使用GridView，ListView来显示大量的图片，而当我们快速滑动GridView，ListView，我们希望能停止图片的加载，而在GridView，ListView停止滑动的时候加载当前界面的图片，这个框架当然也提供这个功能，使用起来也很简单，它提供了PauseOnScrollListener这个类来控制ListView,GridView滑动过程中停止去加载图片，该类使用的是代理模式
1.
listView.setOnScrollListener(new PauseOnScrollListener(imageLoader, pauseOnScroll, pauseOnFling));
2.
gridView.setOnScrollListener(new PauseOnScrollListener(imageLoader, pauseOnScroll, pauseOnFling));
OutOfMemoryError
虽然这个框架有很好的缓存机制，有效的避免了OOM的产生，一般的情况下产生OOM的概率比较小，但是并不能保证OutOfMemoryError永远不发生，这个框架对于OutOfMemoryError做了简单的catch,保证我们的程序遇到OOM而不被crash掉，但是如果我们使用该框架经常发生OOM，我们应该怎么去改善呢？
减少线程池中线程的个数，在ImageLoaderConfiguration中的（.threadPoolSize）中配置，推荐配置1-5在DisplayImageOptions选项中配置bitmapConfig为Bitmap.Config.RGB_565，因为默认是ARGB_8888， 使用RGB_565会比使用ARGB_8888少消耗2倍的内存在ImageLoaderConfiguration中配置图片的内存缓存为memoryCache(new WeakMemoryCache()) 或者不使用内存缓存在DisplayImageOptions选项中设置.imageScaleType(ImageScaleType.IN_SAMPLE_INT)或者imageScaleType(ImageScaleType.EXACTLY)
通过上面这些，相信大家对Universal-Image-Loader框架的使用已经非常的了解了，我们在使用该框架的时候尽量的使用displayImage()方法去加载图片，loadImage()是将图片对象回调到ImageLoadingListener接口的onLoadingComplete()方法中，需要我们手动去设置到ImageView上面，displayImage()方法中，对ImageView对象使用的是Weak references，方便垃圾回收器回收ImageView对象，如果我们要加载固定大小的图片的时候，使用loadImage()方法需要传递一个ImageSize对象，而displayImage()方法会根据ImageView对象的测量值，或者android:layout_width and android:layout_height设定的值，或者android:maxWidth and/or android:maxHeight设定的值来裁剪图片