民浩

 

Android 开源框架Universal-Image-Loader完全解析（一）--- 基本介绍及使用

转载请注明本文出自xiaanming的博客（http://blog.csdn.net/xiaanming/article/details/26810303），请尊重他人的辛勤劳动成果，谢谢！

大 家好！差不多两个来月没有写文章了，前段时间也是在忙换工作的事，准备笔试面试什么的事情，现在新工作找好了，新工作自己也比较满意，唯一遗憾的就是自己 要去一个新的城市，新的环境新的开始，希望自己能尽快的适应新环境，现在在准备交接的事情，自己也有一些时间了，所以就继续给大家分享Android方面 的东西。

相信大家平时做Android应用的时候，多少会接触到异步加载图片，或者加载大量图片的问题，而加载图片我们常常会遇到许多的问 题，比如说图片的错乱，OOM等问题，对于新手来说，这些问题解决起来会比较吃力，所以就有很多的开源图片加载框架应运而生，比较著名的就是 Universal-Image-Loader，相信很多朋友都听过或者使用过这个强大的图片加载框架，今天这篇文章就是对这个框架的基本介绍以及使用， 主要是帮助那些没有使用过这个框架的朋友们。该项目存在于Github上面https://github.com/nostra13/Android-Universal-Image-Loader，我们可以先看看这个开源库存在哪些特征

  1. 多线程下载图片，图片可以来源于网络，文件系统，项目文件夹assets中以及drawable中等
  2. 支持随意的配置ImageLoader，例如线程池，图片下载器，内存缓存策略，硬盘缓存策略，图片显示选项以及其他的一些配置
  3. 支持图片的内存缓存，文件系统缓存或者SD卡缓存
  4. 支持图片下载过程的监听
  5. 根据控件(ImageView)的大小对Bitmap进行裁剪，减少Bitmap占用过多的内存
  6. 较好的控制图片的加载过程，例如暂停图片加载，重新开始加载图片，一般使用在ListView,GridView中，滑动过程中暂停加载图片，停止滑动的时候去加载图片
  7. 提供在较慢的网络下对图片进行加载

当然上面列举的特性可能不全，要想了解一些其他的特性只能通过我们的使用慢慢去发现了，接下来我们就看看这个开源库的简单使用吧

 

新建一个Android项目，下载JAR包添加到工程libs目录下

新建一个MyApplication继承Application，并在onCreate()中创建ImageLoader的配置参数，并初始化到ImageLoader中代码如下

[java] view plaincopy在CODE上查看代码片派生到我的代码片
  1. package com.example.uil;  
  2.   
  3. import com.nostra13.universalimageloader.core.ImageLoader;  
  4. import com.nostra13.universalimageloader.core.ImageLoaderConfiguration;  
  5.   
  6. import android.app.Application;  
  7.   
  8. public class MyApplication extends Application {  
  9.   
  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. }  

ImageLoaderConfiguration 是图片加载器ImageLoader的配置参数，使用了建造者模式，这里是直接使用了createDefault()方法创建一个默认的 ImageLoaderConfiguration，当然我们还可以自己设置ImageLoaderConfiguration，设置如下

[java] view plaincopy在CODE上查看代码片派生到我的代码片
  1. File cacheDir = StorageUtils.getCacheDirectory(context);  
  2. ImageLoaderConfiguration config = new ImageLoaderConfiguration.Builder(context)  
  3.         .memoryCacheExtraOptions(480, 800) // default = device screen dimensions  
  4.         .diskCacheExtraOptions(480, 800, CompressFormat.JPEG, 75, null)  
  5.         .taskExecutor(...)  
  6.         .taskExecutorForCachedImages(...)  
  7.         .threadPoolSize(3) // default  
  8.         .threadPriority(Thread.NORM_PRIORITY - 1) // default  
  9.         .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文件

[html] view plaincopy在CODE上查看代码片派生到我的代码片
  1. <manifest>  
  2.     <uses-permission android:name="android.permission.INTERNET" />  
  3.     <!-- Include next permission if you want to allow UIL to cache images on SD card -->  
  4.     <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />  
  5.     ...  
  6.     <application android:name="MyApplication">  
  7.         ...  
  8.     </application>  
  9. </manifest>  


接下来我们就可以来加载图片了，首先我们定义好Activity的布局文件

[html] view plaincopy在CODE上查看代码片派生到我的代码片
  1. <?xml version="1.0" encoding="utf-8"?>  
  2. <FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"  
  3.     android:layout_width="fill_parent"  
  4.     android:layout_height="fill_parent">  
  5.   
  6.     <ImageView  
  7.         android:layout_gravity="center"  
  8.         android:id="@+id/image"  
  9.         android:src="@drawable/ic_empty"  
  10.         android:layout_width="wrap_content"  
  11.         android:layout_height="wrap_content" />  
  12.   
  13. </FrameLayout>  

里 面只有一个ImageView，很简单，接下来我们就去加载图片，我们会发现ImageLader提供了几个图片加载的方法，主要是这几个 displayImage(), loadImage(),loadImageSync()，loadImageSync()方法是同步 的，android4.0有个特性，网络操作不能在主线程，所以loadImageSync()方法我们就不去使用

.

loadimage()加载图片

 

我们先使用ImageLoader的loadImage()方法来加载网络图片

[java] view plaincopy在CODE上查看代码片派生到我的代码片
  1. final ImageView mImageView = (ImageView) findViewById(R.id.image);  
  2.         String imageUrl = "https://lh6.googleusercontent.com/-55osAWw3x0Q/URquUtcFr5I/AAAAAAAAAbs/rWlj1RUKrYI/s1024/A%252520Photographer.jpg";  
  3.           
  4.         ImageLoader.getInstance().loadImage(imageUrl, new ImageLoadingListener() {  
  5.               
  6.             @Override  
  7.             public void onLoadingStarted(String imageUri, View view) {  
  8.                   
  9.             }  
  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.         });  

传 入图片的url和ImageLoaderListener, 在回调方法onLoadingComplete()中将loadedImage设置到ImageView上面就行了，如果你觉得传入 ImageLoaderListener太复杂了，我们可以使用SimpleImageLoadingListener类，该类提供了 ImageLoaderListener接口方法的空实现，使用的是缺省适配器模式

[java] view plaincopy在CODE上查看代码片派生到我的代码片
  1. final ImageView mImageView = (ImageView) findViewById(R.id.image);  
  2.         String imageUrl = "https://lh6.googleusercontent.com/-55osAWw3x0Q/URquUtcFr5I/AAAAAAAAAbs/rWlj1RUKrYI/s1024/A%252520Photographer.jpg";  
  3.           
  4.         ImageLoader.getInstance().loadImage(imageUrl, new SimpleImageLoadingListener(){  
  5.   
  6.             @Override  
  7.             public void onLoadingComplete(String imageUri, View view,  
  8.                     Bitmap loadedImage) {  
  9.                 super.onLoadingComplete(imageUri, view, loadedImage);  
  10.                 mImageView.setImageBitmap(loadedImage);  
  11.             }  
  12.               
  13.         });  

如果我们要指定图片的大小该怎么办呢，这也好办，初始化一个ImageSize对象，指定图片的宽和高，代码如下

[java] view plaincopy在CODE上查看代码片派生到我的代码片
  1. final ImageView mImageView = (ImageView) findViewById(R.id.image);  
  2.         String imageUrl = "https://lh6.googleusercontent.com/-55osAWw3x0Q/URquUtcFr5I/AAAAAAAAAbs/rWlj1RUKrYI/s1024/A%252520Photographer.jpg";  
  3.           
  4.         ImageSize mImageSize = new ImageSize(100, 100);  
  5.           
  6.         ImageLoader.getInstance().loadImage(imageUrl, mImageSize, new SimpleImageLoadingListener(){  
  7.   
  8.             @Override  
  9.             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显示的图片，是否需要使用内存缓存，是否需 要使用文件缓存等等，可供我们选择的配置如下

[java] view plaincopy在CODE上查看代码片派生到我的代码片
  1. DisplayImageOptions options = new DisplayImageOptions.Builder()  
  2.         .showImageOnLoading(R.drawable.ic_stub) // resource or drawable  
  3.         .showImageForEmptyUri(R.drawable.ic_empty) // resource or drawable  
  4.         .showImageOnFail(R.drawable.ic_error) // resource or drawable  
  5.         .resetViewBeforeLoading(false)  // default  
  6.         .delayBeforeLoading(1000)  
  7.         .cacheInMemory(false) // default  
  8.         .cacheOnDisk(false) // default  
  9.         .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();  


我们将上面的代码稍微修改下

[java] view plaincopy在CODE上查看代码片派生到我的代码片
  1. final ImageView mImageView = (ImageView) findViewById(R.id.image);  
  2.         String imageUrl = "https://lh6.googleusercontent.com/-55osAWw3x0Q/URquUtcFr5I/AAAAAAAAAbs/rWlj1RUKrYI/s1024/A%252520Photographer.jpg";  
  3.         ImageSize mImageSize = new ImageSize(100, 100);  
  4.           
  5.         //显示图片的配置  
  6.         DisplayImageOptions options = new DisplayImageOptions.Builder()  
  7.                 .cacheInMemory(true)  
  8.                 .cacheOnDisk(true)  
  9.                 .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()，代码如下

[java] view plaincopy在CODE上查看代码片派生到我的代码片
  1. final ImageView mImageView = (ImageView) findViewById(R.id.image);  
  2.         String imageUrl = "https://lh6.googleusercontent.com/-55osAWw3x0Q/URquUtcFr5I/AAAAAAAAAbs/rWlj1RUKrYI/s1024/A%252520Photographer.jpg";  
  3.           
  4.         //显示图片的配置  
  5.         DisplayImageOptions options = new DisplayImageOptions.Builder()  
  6.                 .showImageOnLoading(R.drawable.ic_stub)  
  7.                 .showImageOnFail(R.drawable.ic_error)  
  8.                 .cacheInMemory(true)  
  9.                 .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打印

[java] view plaincopy在CODE上查看代码片派生到我的代码片
  1. public class MyApplication extends Application {  
  2.   
  3.     @Override  
  4.     public void onCreate() {  
  5.         super.onCreate();  
  6.   
  7.         //创建默认的ImageLoader配置参数  
  8.         ImageLoaderConfiguration configuration = new ImageLoaderConfiguration.Builder(this)  
  9.         .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接口就行了，代码如下

[java] view plaincopy在CODE上查看代码片派生到我的代码片
  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.         });  

由 于displayImage()方法中带ImageLoadingProgressListener参数的方法都有带 ImageLoadingListener参数，所以我这里直接new 一个SimpleImageLoadingListener，然后我们就可以在回调方法onProgressUpdate()得到图片的加载进度。

 

加载其他来源的图片

 

使用Universal-Image-Loader框架不仅可以加载网络图片，还可以加载sd卡中的图片，Content provider等，使用也很简单，只是将图片的url稍加的改变下就行了，下面是加载文件系统的图片

 

[java] view plaincopy在CODE上查看代码片派生到我的代码片
  1. //显示图片的配置  
  2.         DisplayImageOptions options = new DisplayImageOptions.Builder()  
  3.                 .showImageOnLoading(R.drawable.ic_stub)  
  4.                 .showImageOnFail(R.drawable.ic_error)  
  5.                 .cacheInMemory(true)  
  6.                 .cacheOnDisk(true)  
  7.                 .bitmapConfig(Bitmap.Config.RGB_565)  
  8.                 .build();  
  9.           
  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 = "//img-my.csdn.net/uploads/201309/01/1378037235_7476.jpg";  
  15.           
  16.         imageLoader.displayImage(imageUrl, mImageView, options);  

当 然还有来源于Content provider,drawable,assets中，使用的时候也很简单，我们只需要给每个图片来源的地方加上Scheme包裹起来(Content provider除外)，然后当做图片的url传递到imageLoader中，Universal-Image-Loader框架会根据不同的 Scheme获取到输入流

[java] view plaincopy在CODE上查看代码片派生到我的代码片
  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滑动过程中停止去加载图片，该类使用的是代理模式

[java] view plaincopy在CODE上查看代码片派生到我的代码片
  1. listView.setOnScrollListener(new PauseOnScrollListener(imageLoader, pauseOnScroll, pauseOnFling));  
  2.         gridView.setOnScrollListener(new PauseOnScrollListener(imageLoader, pauseOnScroll, pauseOnFling));  

第一个参数就是我们的图片加载对象ImageLoader, 第二个是控制是否在滑动过程中暂停加载图片，如果需要暂停传true就行了，第三个参数控制猛的滑动界面的时候图片是否加载

 

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设定的值来裁剪图片

 

今天就给大家分享到这里，有不明白的地方在下面留言，我会尽量为大家解答的，下一篇文章我将继续更深入的分析这个框架，希望大家继续关注！

posted on 2015-04-21 10:28  民浩  阅读(127)  评论(0)  编辑  收藏  举报

导航