Android开源框架Universal-Image-Loader详解

如果说评价一下哪个图片开源库最被广泛使用的话，我想应该可以说是Universal-Image-Loader，在主流的应用中如

果你随便去反编译几个，基本都能看到他的身影，它就像个图片加载守护者，默默的守护着图片加载。相信很多人对

这个异步加载图片框架还不是很熟，再加上最近它更改优化了好几个地方，而网上的大部分资料还是以前的，于是花

了几天时间专门的研究了下开源框架Universal-Image-Loader（实际上是近期项目刚好用到，且仔细的考虑过各种情

况），希望对新手能有所帮助，也希望大神能指点下。

 

 

 

一、功能特性：

1、多线程异步加载和显示图片（图片来源于网络、sd卡、assets文件夹，drawable文件夹（不能加载9patch），新增加载视频缩略图）

 

?

1

2

3

4

5

6

7

http://site.com/image.png // from Web

file:///mnt/sdcard/image.png // from SD card

file:///mnt/sdcard/video.mp4 // from SD card (video thumbnail)

content://media/external/images/media/13 // from content provider

content://media/external/video/media/13 // from content provider (video thumbnail)

assets://image.png // from assets

drawable:// + R.drawable.img // from drawables (non-9patch images)

 

2、支持通过“listener”监视加载的过程，可以暂停加载图片，在经常使用的ListView、GridView中，可以设置滑动时暂

停加载，停止滑动时加载图片（便于节约流量，在一些优化中可以使用）

3、缓存图片至内存时，可以更加高效的工作

4、高度可定制化（可以根据自己的需求进行各种配置，如：线程池，图片下载器，内存缓存策略等）

5、支持图片的内存缓存，SD卡（文件）缓存

6、在网络速度较慢时，还可以对图片进行加载并设置下载监听

 

二、配置详解

1、下载jar包放在libs文件夹中

注：Maven dependency:

 

?

1

2

3

4

5

<dependency>

    <groupid>com.nostra13.universalimageloader</groupid>

    universal-image-loader</artifactid>

    <version>1.9.3</version>

</dependency>

 

Gradle dependency:

 

?

1

compile'com.nostra13.universalimageloader:universal-image-loader:1.9.3'

 

2、AndroidManifest.xml

?

1

2

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE">

<uses-permission android:name="android.permission.INTERNET"></uses-permission></uses-permission>

3、在应用中配置ImageLoaderConfiguration参数（只能配置一次，如多次配置，则默认第一次的配置参数）

a、使用默认设置

 

?

1

ImageLoaderConfiguration configuration = ImageLoaderConfiguration.createDefault(this);

 

b、自己配置参数

 

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

File cacheDir = StorageUtils.getCacheDirectory(context);  //缓存文件夹路径

ImageLoaderConfiguration config = newImageLoaderConfiguration.Builder(context)

        .memoryCacheExtraOptions(480,800)// default = device screen dimensions 内存缓存文件的最大长宽

        .diskCacheExtraOptions(480,800,null) // 本地缓存的详细信息(缓存的最大长宽)，最好不要设置这个

        .taskExecutor(...)

        .taskExecutorForCachedImages(...)

        .threadPoolSize(3)// default  线程池内加载的数量

        .threadPriority(Thread.NORM_PRIORITY - 2)// default 设置当前线程的优先级

        .tasksProcessingOrder(QueueProcessingType.FIFO)// default

        .denyCacheImageMultipleSizesInMemory()

        .memoryCache(newLruMemoryCache(2* 1024* 1024))//可以通过自己的内存缓存实现

        .memoryCacheSize(2* 1024* 1024) // 内存缓存的最大值

        .memoryCacheSizePercentage(13)// default

        .diskCache(newUnlimitedDiscCache(cacheDir)) // default 可以自定义缓存路径 

        .diskCacheSize(50* 1024* 1024)// 50 Mb sd卡(本地)缓存的最大值

        .diskCacheFileCount(100) // 可以缓存的文件数量

        // default为使用HASHCODE对UIL进行加密命名， 还可以用MD5(new Md5FileNameGenerator())加密

        .diskCacheFileNameGenerator(newHashCodeFileNameGenerator())

        .imageDownloader(newBaseImageDownloader(context)) // default

        .imageDecoder(newBaseImageDecoder()) // default

        .defaultDisplayImageOptions(DisplayImageOptions.createSimple())// default

        .writeDebugLogs()// 打印debug log

        .build();//开始构建

配置好ImageLoaderConfiguration，一定不要忘记进行初始化操作（一般在application中进行初始化）

 

 

?

1

ImageLoader.getInstance().init(config);

注：上面的配置请根据自己的需要进行配置，不是所有的都要进行配置的

 

 

4、图片显示操作

a、首先要得到ImageLoader的实例(使用的单例模式)

 

?

1

ImageLoader imageLoader = ImageLoader.getInstance();

 

注：在每个显示任务（布局中都需实例化才能进行相关操作

b、相关显示参数配置

 

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

DisplayImageOptions options = newDisplayImageOptions.Builder()

        .showImageOnLoading(R.drawable.ic_stub)// 设置图片下载期间显示的图片

        .showImageForEmptyUri(R.drawable.ic_empty)// 设置图片Uri为空或是错误的时候显示的图片

        .showImageOnFail(R.drawable.ic_error)// 设置图片加载或解码过程中发生错误显示的图片

        .resetViewBeforeLoading(false) // default 设置图片在加载前是否重置、复位

        .delayBeforeLoading(1000) // 下载前的延迟时间

        .cacheInMemory(false)// default  设置下载的图片是否缓存在内存中

        .cacheOnDisk(false)// default  设置下载的图片是否缓存在SD卡中

        .preProcessor(...)

        .postProcessor(...)

        .extraForDownloader(...)

        .considerExifParams(false)// default

        .imageScaleType(ImageScaleType.IN_SAMPLE_POWER_OF_2)// default 设置图片以如何的编码方式显示

        .bitmapConfig(Bitmap.Config.ARGB_8888)// default 设置图片的解码类型

        .decodingOptions(...) // 图片的解码设置

        .displayer(newSimpleBitmapDisplayer()) // default  还可以设置圆角图片new RoundedBitmapDisplayer(20)

        .handler(newHandler()) // default

        .build();

 

注：如果DisplayImageOption没有传递给ImageLoader.displayImage(…)方法，那么从配置默认显示选项
(ImageLoaderConfiguration.defaultDisplayImageOptions(…))将被使用。

 

 

?

1

2

3

4

5

6

7

8

9

10

11

12

13

1）.imageScaleType(ImageScaleType imageScaleType)  //设置图片的缩放方式

缩放类型mageScaleType:

EXACTLY :图像将完全按比例缩小的目标大小

    EXACTLY_STRETCHED:图片会缩放到目标大小完全

    IN_SAMPLE_INT:图像将被二次采样的整数倍

    IN_SAMPLE_POWER_OF_2:图片将降低2倍，直到下一减少步骤，使图像更小的目标大小   

    NONE:图片不会调整

2）.displayer(BitmapDisplayer displayer)   //设置图片的显示方式

显示方式displayer：

    RoundedBitmapDisplayer（introundPixels）设置圆角图片

    FakeBitmapDisplayer（）这个类什么都没做

    FadeInBitmapDisplayer（intdurationMillis）设置图片渐显的时间

    SimpleBitmapDisplayer()正常显示一张图片

 

参数补充:

 

?

1

2

.considerExifParams(true) //是否考虑JPEG图像EXIF参数（旋转，翻转）

.displayer(newFadeInBitmapDisplayer(100))// 图片加载好后渐入的动画时间

 

c、显示图片

 

?

1

2

3

4

5

1、  ImageLoader.getInstance().displayImage(uri, imageView);

2、  ImageLoader.getInstance().displayImage(uri, imageView, options);

3、  ImageLoader.getInstance().displayImage(uri, imageView, listener);

4、  ImageLoader.getInstance().displayImage(uri, imageView, options, listener);

5、  ImageLoader.getInstance().displayImage(uri, imageView, options, listener, progressListener);

 

 

参数解析：

 

?

1

2

3

4

5

imageUrl   图片的URL地址

imageView  显示图片的ImageView控件 

options    DisplayImageOptions配置信息

listener   图片下载情况的监听

progressListener  图片下载进度的监听

 

1)方法1:最简单的方式，我们只需要定义要显示的图片的URL和要显示图片的ImageView。这种情况下，图片的显示选项会使用默认的配置

2)方法2:加载自定义配置的一个图片

3)方法3:加载带监听的一个图片

4)方法4:加载自定义配置且带监听的一个图片

5)方法5:加载自定义配置且带监听和进度条的一个图片

 

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

ImageLoader.getInstance().displayImage(uri, imageView, options,

        newImageLoadingListener() {

 

            @Override

            publicvoid onLoadingStarted(String arg0, View arg1) {

                //开始加载

            }

 

            @Override

            publicvoid onLoadingFailed(String arg0, View arg1,

                    FailReason arg2) {

                //加载失败

            }

 

            @Override

            publicvoid onLoadingComplete(String arg0, View arg1,

                    Bitmap arg2) {

                //加载成功

            }

 

            @Override

            publicvoid onLoadingCancelled(String arg0, View arg1) {

                //加载取消

            }

        },newImageLoadingProgressListener() {

 

            @Override

            publicvoid onProgressUpdate(String imageUri, View view,

                    intcurrent, inttotal) {

                //加载进度

            }

        });

 

三、提示和技巧

1、只有在你需要让Image的尺寸比当前设备的尺寸大的时候，你才需要配置maxImageWidthForMemoryCach(...)和

maxImageHeightForMemoryCache(...)这两个参数，比如放大图片的时候。其他情况下，不需要做这些配置，因为默

认的配置会根据屏幕尺寸以最节约内存的方式处理Bitmap。

2、在设置中配置线程池的大小是非常明智的。一个大的线程池会允许多条线程同时工作，但是也会显著的影响到UI

线程的速度。但是可以通过设置一个较低的优先级来解决：当ImageLoader在使用的时候，可以降低它的优先级，这

样UI线程会更加流畅。在使用List的时候，UI 线程经常会不太流畅，所以在你的程序中最好设置threadPoolSize(...)和

threadPriority(...)这两个参数来优化你的应用。

3、memoryCache(...)和memoryCacheSize(...)这两个参数会互相覆盖，所以在ImageLoaderConfiguration中使用一个就好了

4、diskCacheSize(...)、diskCache(...)和diskCacheFileCount(...)这三个参数会互相覆盖，只使用一个

注：不要使用discCacheSize(...)、discCache(...)和discCacheFileCount(...)这三个参数已经弃用

5、如果你的程序中使用displayImage（）方法时传入的参数经常是一样的，那么一个合理的解决方法是，把这些选项

配置在ImageLoader的设置中作为默认的选项（通过调用defaultDisplayImageOptions(...)方法）。之后调用

displayImage(...)方法的时候就不必再指定这些选项了，如果这些选项没有明确的指定给

defaultDisplayImageOptions(...)方法，那调用的时候将会调用UIL的默认设置。

 

四、注意事项

1、如果你经常出现oom，你可以尝试:

1)禁用在内存中缓存cacheInMemory(false)，如果oom仍然发生那么似乎你的应用程序有内存泄漏，使用MemoryAnalyzer来检测它。否则尝试以下步骤(尝试所有或几个)

2)减少配置的线程池的大小(.threadPoolSize(...))，建议1~5

3)在显示选项中使用 .bitmapConfig(Bitmap.Config.RGB_565) . RGB_565模式消耗的内存比ARGB_8888模式少两倍.

4)配置中使用.diskCacheExtraOptions(480, 320, null)

5)配置中使用 .memoryCache(newWeakMemoryCache()) 或者完全禁用在内存中缓存(don't call .cacheInMemory()).

6)在显示选项中使用.imageScaleType(ImageScaleType.EXACTLY) 或 .imageScaleType(ImageScaleType.IN_SAMPLE_INT)

7)避免使用 RoundedBitmapDisplayer. 调用的时候它使用ARGB-8888模式创建了一个新的Bitmap对象来显示，对于内存缓存模式 (ImageLoaderConfiguration.memoryCache(...)) 你可以使用已经实现好的方法.

2、ImageLoader是根据ImageView的height，width确定图片的宽高

3、一定要对ImageLoaderConfiguration进行初始化,否则会报错

4、开启缓存后默认会缓存到外置SD卡如下地址(/sdcard/Android/data/[package_name]/cache).如果外置SD卡不存在，会缓存到手机. 缓存到Sd卡需要在AndroidManifest.xml文件中进行如下配置

 

?

1

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"></uses-permission>

 

5、内存缓存模式可以使用以下已实现的方法 (ImageLoaderConfiguration.memoryCache(...))

1)缓存只使用强引用

LruMemoryCache (缓存大小超过指定值时，删除最近最少使用的bitmap) --默认情况下使用

2)缓存使用弱引用和强引用

 

?

1

2

3

4

5

UsingFreqLimitedMemoryCache (缓存大小超过指定值时,删除最少使的bitmap)

LRULimitedMemoryCache (缓存大小超过指定值时,删除最近最少使用的<span helvetica=""segoe=""style="font-family:">bitmap) --默认值</span>

FIFOLimitedMemoryCache (缓存大小超过指定值时,按先进先出规则删除的<span helvetica=""segoe=""style="font-family:">bitmap)</span>

LargestLimitedMemoryCache (缓存大小超过指定值时,删除最大的bitmap)

LimitedAgeMemoryCache (缓存对象超过定义的时间后删除)

 

3)缓存使用弱引用

WeakMemoryCache（没有限制缓存）

6、本地缓存模式可以使用以下已实现的方法 (ImageLoaderConfiguration.diskCache(...))

 

?

1

2

3

4

UnlimitedDiskCache   不限制缓存大小（默认）

TotalSizeLimitedDiskCache (设置总缓存大小，超过时删除最久之前的缓存)

FileCountLimitedDiskCache (设置总缓存文件数量，当到达警戒值时，删除最久之前的缓存。如果文件的大小都一样的时候，可以使用该模式)

LimitedAgeDiskCache (不限制缓存大小，但是设置缓存时间，到期后删除)

 

五、完美例子(参考源码)

1、项目结构图

Constans主要用来存放图片的url地址的

2、项目效果图

 

3、代码讲解

1)权限添加

 

?

1

2

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE">

<uses-permission android:name="android.permission.INTERNET"></uses-permission></uses-permission>

 

2)初始化配置

 

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

packagecom.xwj.imageloaderdemo;

 

importjava.io.File;

 

importandroid.app.Application;

importandroid.content.Context;

 

importcom.nostra13.universalimageloader.cache.disc.impl.UnlimitedDiscCache;

importcom.nostra13.universalimageloader.cache.disc.naming.Md5FileNameGenerator;

importcom.nostra13.universalimageloader.cache.memory.impl.UsingFreqLimitedMemoryCache;

importcom.nostra13.universalimageloader.core.ImageLoader;

importcom.nostra13.universalimageloader.core.ImageLoaderConfiguration;

importcom.nostra13.universalimageloader.core.assist.QueueProcessingType;

importcom.nostra13.universalimageloader.core.download.BaseImageDownloader;

importcom.nostra13.universalimageloader.utils.StorageUtils;

 

publicclass ImageLoaderApplication extendsApplication {

    publicvoid onCreate() {

        super.onCreate();

        initImageLoader(getApplicationContext());

    }

 

    publicstatic void initImageLoader(Context context) {

        //缓存文件的目录

        File cacheDir = StorageUtils.getOwnCacheDirectory(context, imageloader/Cache);

        ImageLoaderConfiguration config = newImageLoaderConfiguration.Builder(context)

                .memoryCacheExtraOptions(480,800)// max width, max height，即保存的每个缓存文件的最大长宽

                .threadPoolSize(3)//线程池内加载的数量

                .threadPriority(Thread.NORM_PRIORITY - 2)

                .denyCacheImageMultipleSizesInMemory()

                .diskCacheFileNameGenerator(newMd5FileNameGenerator()) //将保存的时候的URI名称用MD5 加密

                .memoryCache(newUsingFreqLimitedMemoryCache(2* 1024* 1024))// You can pass your own memory cache implementation/你可以通过自己的内存缓存实现

                .memoryCacheSize(2* 1024* 1024)// 内存缓存的最大值

                .diskCacheSize(50* 1024* 1024) // 50 Mb sd卡(本地)缓存的最大值

                .tasksProcessingOrder(QueueProcessingType.LIFO)

                // 由原先的discCache -> diskCache

                .diskCache(newUnlimitedDiscCache(cacheDir))//自定义缓存路径 

                .imageDownloader(newBaseImageDownloader(context, 5* 1000,30* 1000))// connectTimeout (5 s), readTimeout (30 s)超时时间 

                .writeDebugLogs()// Remove for release app

                .build();

        //全局初始化此配置 

        ImageLoader.getInstance().init(config);

    }

}

注：1.记得在AndroidManifest.xml中添加android:name=com.xwj.imageloaderdemo.ImageLoaderApplication

 

2.自定义了缓存目录

3)初始化显示配置

 

?

1

2

3

4

5

6

7

8

9

// 使用DisplayImageOptions.Builder()创建DisplayImageOptions

options = newDisplayImageOptions.Builder()

        .showImageOnLoading(R.drawable.ic_stub)// 设置图片下载期间显示的图片

        .showImageForEmptyUri(R.drawable.ic_empty)// 设置图片Uri为空或是错误的时候显示的图片

        .showImageOnFail(R.drawable.ic_error)// 设置图片加载或解码过程中发生错误显示的图片

        .cacheInMemory(true)// 设置下载的图片是否缓存在内存中

        .cacheOnDisk(true)// 设置下载的图片是否缓存在SD卡中

        .displayer(newRoundedBitmapDisplayer(20))// 设置成圆角图片

        .build();// 构建完成

 

4)显示图片

 

?

1

2

imageLoader.displayImage(imageUrls[position],

                viewHolder.image, options);

 

5)清除缓存

 

?

1

2

3

4

5

6

7

8

9

publicvoid onClearMemoryClick(View view) {

    Toast.makeText(this, 清除内存缓存成功, Toast.LENGTH_SHORT).show();

    ImageLoader.getInstance().clearMemoryCache(); // 清除内存缓存

}

 

publicvoid onClearDiskClick(View view) {

    Toast.makeText(this, 清除本地缓存成功, Toast.LENGTH_SHORT).show();

    ImageLoader.getInstance().clearDiskCache(); // 清除本地缓存

}

 

其余是比较常规的代码，就不多做介绍了，下一篇将详细描述Universal-Image-Loader的各个应用场景