Android开源框架Universal-Image-Loader基本介绍和使用

时间:2022-12-06 09:56:41


相信大家平时做Android应用的时候,多少会接触到异步加载图片,或者加载大量图片的问题,这个开源框架就是用来做这些工作的。

该项目存在于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目录下

并在onCreate()中创建ImageLoader的配置参数,并初始化到ImageLoader中代码如下:


//创建默认的ImageLoader配置参数 
ImageLoaderConfiguration configuration = ImageLoaderConfiguration .createDefault(this);

//Initialize ImageLoader with configuration.
ImageLoader.getInstance().init(configuration);

  


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


    1. File cacheDir = StorageUtils.getCacheDirectory(context);  
    2. ImageLoaderConfiguration config = new ImageLoaderConfiguration.Builder(context)
    3. 480, 800) // default = device screen dimensions
    4. 480, 800, CompressFormat.JPEG, 75, null)
    5. .taskExecutor(...)
    6. .taskExecutorForCachedImages(...)
    7. 3) // default
    8. 1) // default
    9. // default
    10. .denyCacheImageMultipleSizesInMemory()
    11. new LruMemoryCache(2 * 1024 * 1024))
    12. 2 * 1024 * 1024)
    13. 13) // default
    14. new UnlimitedDiscCache(cacheDir)) // default
    15. 50 * 1024 * 1024)
    16. 100)
    17. new HashCodeFileNameGenerator()) // default
    18. new BaseImageDownloader(context)) // default
    19. new BaseImageDecoder()) // default
    20. // default
    21. .writeDebugLogs()
    22. .build();


    上面的这些就是所有的选项配置,我们在项目中不需要每一个都自己设置,一般使用createDefault()创建的ImageLoaderConfiguration就能使用,然后调用ImageLoader的init()方法将ImageLoaderConfiguration参数传递进去,ImageLoader使用单例模式。


    配置Android Manifest文件


    ​​


    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. </manifest>


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

    .

    loadImage()加载图片


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

    ​​



      1. final ImageView mImageView = (ImageView) findViewById(R.id.image);  
      2. "http://7xi8ex.com1.z0.glb.clouddn.com/fengjing/99.jpg";
      3.
      4. 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接口方法的空实现,使用的是缺省适配器模式


      ​​

      1. final ImageView mImageView = (ImageView) findViewById(R.id.image);  
      2. "http://7xi8ex.com1.z0.glb.clouddn.com/fengjing/99.jpg";
      3.
      4. 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. });


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


      ​​


      1. final ImageView mImageView = (ImageView) findViewById(R.id.image);  
      2. "http://7xi8ex.com1.z0.glb.clouddn.com/fengjing/99.jpg";
      3.
      4. new ImageSize(100, 100);
      5.
      6. ImageLoader.getInstance().loadImage(imageUrl, mImageSize,
      7. new SimpleImageLoadingListener(){
      8.
      9. @Override
      10. public void onLoadingComplete(String imageUri, View view,
      11. Bitmap loadedImage) {
      12. super.onLoadingComplete(imageUri, view, loadedImage);
      13. mImageView.setImageBitmap(loadedImage);
      14. }
      15.
      16. });


      上面只是很简单的使用ImageLoader来加载网络图片,在实际的开发中,我们并不会这么使用,那我们平常会怎么使用呢?我们会用到DisplayImageOptions,他可以配置一些图片显示的选项,比如图片在加载中ImageView显示的图片,是否需要使用内存缓存,是否需要使用文件缓存等等,可供我们选择的配置如下


      ​​


      1. DisplayImageOptions options = new DisplayImageOptions.Builder()  
      2. // resource or drawable
      3. // resource or drawable
      4. // resource or drawable
      5. false) // default
      6. 1000)
      7. false) // default
      8. false) // default
      9. .preProcessor(...)
      10. .postProcessor(...)
      11. .extraForDownloader(...)
      12. false) // default
      13. // default
      14. // default
      15. .decodingOptions(...)
      16. new SimpleBitmapDisplayer()) // default
      17. new Handler()) // default
      18. .build();



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


      ​​


      1. final ImageView mImageView = (ImageView) findViewById(R.id.image);  
      2. "http://7xi8ex.com1.z0.glb.clouddn.com/fengjing/99.jpg";
      3. new ImageSize(100, 100);
      4.
      5. //显示图片的配置
      6. new DisplayImageOptions.Builder()
      7. true)
      8. true)
      9. .bitmapConfig(Bitmap.Config.RGB_565)
      10. .build();
      11.
      12. ImageLoader.getInstance().loadImage(imageUrl, mImageSize, options,
      13. new SimpleImageLoadingListener(){
      14.
      15. @Override
      16. public void onLoadingComplete(String imageUri, View view,
      17. Bitmap loadedImage) {
      18. super.onLoadingComplete(imageUri, view, loadedImage);
      19. mImageView.setImageBitmap(loadedImage);
      20. }
      21. });


      我们使用了DisplayImageOptions来配置显示图片的一些选项,这里我添加了将图片缓存到内存中已经缓存图片到文件系统中,这样我们就不用担心每次都从网络中去加载图片了,是不是很方便呢,但是DisplayImageOptions选项中有些选项对于loadImage()方法是无效的,比如showImageOnLoading, showImageForEmptyUri等,


      displayImage()加载图片


      接下来我们就来看看网络图片加载的另一个方法displayImage(),代码如下


      ​​



        1. final ImageView mImageView = (ImageView) findViewById(R.id.image);  
        2. "http://7xi8ex.com1.z0.glb.clouddn.com/fengjing/99.jpg";
        3.
        4. //显示图片的配置
        5. new DisplayImageOptions.Builder()
        6. .showImageOnLoading(R.drawable.ic_stub)
        7. .showImageOnFail(R.drawable.ic_error)
        8. true)
        9. true)
        10. .bitmapConfig(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。

        我们在加载网络图片的时候,经常有需要显示图片下载进度的需求,Universal-Image-Loader当然也提供这样的功能,只需要在displayImage()方法中传入ImageLoadingProgressListener接口就行了,代码如下


        ​​


        1. imageLoader.displayImage(imageUrl, mImageView, options, new SimpleImageLoadingListener(), 
        2. new ImageLoadingProgressListener() {
        3.
        4. @Override
        5. public void onProgressUpdate(String imageUri, View view,
        6. int current,int total) {
        7.
        8. }
        9. });

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


        加载其他来源的图片


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



        ​​




        1. //显示图片的配置  
        2. new DisplayImageOptions.Builder()
        3. .showImageOnLoading(R.drawable.ic_stub)
        4. .showImageOnFail(R.drawable.ic_error)
        5. true)
        6. true)
        7. .bitmapConfig(Bitmap.Config.RGB_565)
        8. .build();
        9.
        10. final ImageView mImageView = (ImageView) findViewById(R.id.image);
        11. "/mnt/sdcard/image.png";
        12. String imageUrl = Scheme.FILE.wrap(imagePath);
        13.
        14. // String imageUrl = "http://7xi8ex.com1.z0.glb.clouddn.com/fengjing/99.jpg";
        15.
        1.         imageLoader.displayImage(imageUrl, mImageView, options);  


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


        ​​


        1.            //图片来源于Content provider  
        2. "content://media/external/audio/albumart/13";
        3.
        4. //图片来源于assets
        5. "image.png");
        6.
        7. //图片来源于
        8. "R.drawable.image");




        GirdView,ListView加载图片


        相信大部分人都是使用GridView,ListView来显示大量的图片,而当我们快速滑动GridView,ListView,我们希望能停止图片的加载,而在GridView,ListView停止滑动的时候加载当前界面的图片,这个框架当然也提供这个功能,使用起来也很简单,它提供了PauseOnScrollListener这个类来控制ListView,GridView滑动过程中停止去加载图片,该类使用的是代理模式


        ​​


        1. listView.setOnScrollListener(new PauseOnScrollListener(imageLoader, pauseOnScroll, pauseOnFling));    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设定的值来裁剪图片。