Android Image开源框架之ImageLoader（一）

基本介绍及使用

一、功能特性：

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

"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文件夹中
Gradle dependency:

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

2、AndroidManifest.xml

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

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

 ImageLoaderConfiguration configuration = ImageLoaderConfiguration.createDefault(this); 

b、自己配置参数

File cacheDir = StorageUtils.getCacheDirectory(context);  //缓存文件夹路径  
ImageLoaderConfiguration config = new ImageLoaderConfiguration.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(new LruMemoryCache(2 * 1024 * 1024)) //可以通过自己的内存缓存实现  
        .memoryCacheSize(2 * 1024 * 1024)  // 内存缓存的最大值  
        .memoryCacheSizePercentage(13) // default  
        .diskCache(new UnlimitedDiscCache(cacheDir)) // default 可以自定义缓存路径    
        .diskCacheSize(50 * 1024 * 1024) // 50 Mb sd卡(本地)缓存的最大值  
        .diskCacheFileCount(100)  // 可以缓存的文件数量   
        // default为使用HASHCODE对UIL进行加密命名， 还可以用MD5(new Md5FileNameGenerator())加密  
        .diskCacheFileNameGenerator(new HashCodeFileNameGenerator())   
        .imageDownloader(new BaseImageDownloader(context)) // default  
        .imageDecoder(new BaseImageDecoder()) // default  
        .defaultDisplayImageOptions(DisplayImageOptions.createSimple()) // default  
        .writeDebugLogs() // 打印debug log  
        .build(); //开始构建   

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

ImageLoader.getInstance().init(config);  

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

4、图片显示操作

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

ImageLoader imageLoader = ImageLoader.getInstance(); 

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

b、相关显示参数配置

DisplayImageOptions options = new DisplayImageOptions.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(new SimpleBitmapDisplayer()) // default  还可以设置圆角图片new RoundedBitmapDisplayer(20)  
                .handler(new Handler()) // default  
                .build();  

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

c、显示图片

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);  

参数解析：

imageUrl   图片的URL地址  
imageView  显示图片的ImageView控件    
options    DisplayImageOptions配置信息   
listener   图片下载情况的监听  
progressListener  图片下载进度的监听

1)方法1:最简单的方式，我们只需要定义要显示的图片的URL和要显示图片的ImageView。这种情况下，图片的显示选项会使用默认的配置
2)方法2:加载自定义配置的一个图片
3)方法3:加载带监听的一个图片
4)方法4:加载自定义配置且带监听的一个图片
5)方法5:加载自定义配置且带监听和进度条的一个图片

ImageLoader.getInstance().displayImage(uri, imageView, options,  
        new ImageLoadingListener() {  

        @Override  
        public void onLoadingStarted(String arg0, View arg1) {  
            //开始加载  
        }  

        @Override  
        public void onLoadingFailed(String arg0, View arg1,  
                FailReason arg2) {  
            //加载失败  
        }  

        @Override  
        public void onLoadingComplete(String arg0, View arg1,  
                Bitmap arg2) {  
            //加载成功  
        }  

        @Override  
        public void onLoadingCancelled(String arg0, View arg1) {  
            //加载取消  
        }  
    }, new ImageLoadingProgressListener() {  

        @Override  
        public void onProgressUpdate(String imageUri, View view,  
                int current, int total) {  
            //加载进度  
        }  
    });  

三、提示和技巧

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文件中进行如下配置

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

5、内存缓存模式可以使用以下已实现的方法 (ImageLoaderConfiguration.memoryCache(...))
1)缓存只使用强引用
LruMemoryCache (缓存大小超过指定值时，删除最近最少使用的bitmap) –默认情况下使用
2)缓存使用弱引用和强引用

UsingFreqLimitedMemoryCache (缓存大小超过指定值时,删除最少使的bitmap)  
LRULimitedMemoryCache (缓存大小超过指定值时,删除最近最少使用的<span style="font-family: 'Helvetica Neue', Helvetica, 'Segoe UI', Arial, freesans, sans-serif;">bitmap) --默认值</span>  
FIFOLimitedMemoryCache (缓存大小超过指定值时,按先进先出规则删除的<span style="font-family: 'Helvetica Neue', Helvetica, 'Segoe UI', Arial, freesans, sans-serif;">bitmap)</span>  
LargestLimitedMemoryCache (缓存大小超过指定值时,删除最大的bitmap)  
LimitedAgeMemoryCache (缓存对象超过定义的时间后删除) 

3)缓存使用弱引用
WeakMemoryCache（没有限制缓存）
6、本地缓存模式可以使用以下已实现的方法 (ImageLoaderConfiguration.diskCache(...))

UnlimitedDiskCache   不限制缓存大小（默认）  
TotalSizeLimitedDiskCache (设置总缓存大小，超过时删除最久之前的缓存)  
FileCountLimitedDiskCache (设置总缓存文件数量，当到达警戒值时，删除最久之前的缓存。如果文件的大小都一样的时候，可以使用该模式)  
LimitedAgeDiskCache (不限制缓存大小，但是设置缓存时间，到期后删除)  

OutOfMemoryError

关于OOM异常

虽然这个框架有很好的缓存机制，有效的避免了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)

以上，我们在使用该框架的时候尽量的使用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设定的值来裁剪图片。