Android Universal Image Loader 是一个强大的、可高度定制的图片缓存,本文简称为UIL
。 简单的说 UIL 就做了一件事——获取图片并显示在相应的控件上。
添加完依赖后在Application
或Activity
中初始化ImageLoader
,如下:
public class YourApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
ImageLoaderConfiguration configuration = new ImageLoaderConfiguration.Builder(this)
// 添加你的配置需求
.build();
ImageLoader.getInstance().init(configuration);
}
}
其中 configuration 表示ImageLoader
的配置信息,可包括图片最大尺寸、线程池、缓存、下载器、解码器等等。
……
添加网络权限。如果允许磁盘缓存,需要添加写外设的权限。
1.2.3 下载显示图片下载图片,解析为 Bitmap 并在 ImageView 中显示。
imageLoader.displayImage(imageUri, imageView);
下载图片,解析为 Bitmap 传递给回调接口。
imageLoader.loadImage(imageUri, new SimpleImageLoadingListener() {
@Override
public void onLoadingComplete(String imageUri, View view, Bitmap loadedImage) {
// 图片处理
}
});
以上是简单使用,更复杂 API 见本文详细设计
。
- 可配置度高。支持任务线程池、下载器、解码器、内存及磁盘缓存、显示选项等等的配置。
- 包含内存缓存和磁盘缓存两级缓存。
- 支持多线程,支持异步和同步加载。
- 支持多种缓存算法、下载进度监听、ListView 图片错乱解决等。
上面是 UIL 的总体设计图。整个库分为
ImageLoaderEngine
,Cache
及ImageDownloader
,ImageDecoder
,BitmapDisplayer
,BitmapProcessor
五大模块,其中Cache
分为MemoryCache
和DiskCache
两部分。
简单的讲就是ImageLoader
收到加载及显示图片的任务,并将它交给ImageLoaderEngine
,ImageLoaderEngine
分发任务到具体线程池去执行,任务通过Cache
及ImageDownloader
获取图片,中间可能经过BitmapProcessor
和ImageDecoder
处理,最终转换为Bitmap
交给BitmapDisplayer
在ImageAware
中显示。
简单介绍一些概念,在4. 详细设计
中会仔细介绍。 ImageLoaderEngine:任务分发器,负责分发LoadAndDisplayImageTask
和ProcessAndDisplayImageTask
给具体的线程池去执行,本文中也称其为engine
,具体参考4.2.6 ImageLoaderEngine.java
。
ImageAware:显示图片的对象,可以是ImageView
等,具体参考4.2.9 ImageAware.java
。
ImageDownloader:图片下载器,负责从图片的各个来源获取输入流, 具体参考4.2.22 ImageDownloader.java
。
Cache:图片缓存,分为MemoryCache
和DiskCache
两部分。
MemoryCache:内存图片缓存,可向内存缓存缓存图片或从内存缓存读取图片,具体参考4.2.24 MemoryCache.java
。
DiskCache:本地图片缓存,可向本地磁盘缓存保存图片或从本地磁盘读取图片,具体参考4.2.38 DiskCache.java
。
ImageDecoder:图片解码器,负责将图片输入流InputStream
转换为Bitmap
对象, 具体参考4.2.53 ImageDecoder.java
。
BitmapProcessor:图片处理器,负责从缓存读取或写入前对图片进行处理。具体参考4.2.61 BitmapProcessor.java
。
BitmapDisplayer:将Bitmap
对象显示在相应的控件ImageAware
上, 具体参考4.2.56 BitmapDisplayer.java
。
LoadAndDisplayImageTask:用于加载并显示图片的任务, 具体参考4.2.20 LoadAndDisplayImageTask.java
。
ProcessAndDisplayImageTask:用于处理并显示图片的任务, 具体参考4.2.19 ProcessAndDisplayImageTask.java
。
DisplayBitmapTask:用于显示图片的任务, 具体参考4.2.18 DisplayBitmapTask.java
。
上图为图片加载及显示流程图,在uil库中给出,这里用中文重新画出。
图片加载器,对外的主要 API,采取了单例模式,用于图片的加载和显示。
主要函数:
(1). getInstance()得到ImageLoader
的单例。通过双层是否为 null 判断提高性能。
初始化配置参数,参数configuration
为ImageLoader
的配置信息,包括图片最大尺寸、任务线程池、磁盘缓存、下载器、解码器等等。 实现中会初始化ImageLoaderEngine engine
属性,该属性为任务分发器。
加载并显示图片或加载并执行回调接口。ImageLoader
加载图片主要分为三类接口:
displayImage(…)
表示异步加载并显示图片到对应的ImageAware
上。loadImage(…)
表示异步加载图片并执行回调接口。loadImageSync(…)
表示同步加载图片。
以上三类接口最终都会调用到这个函数进行图片加载。函数参数解释如下: uri: 图片的 uri。uri 支持多种来源的图片,包括 http、https、file、content、assets、drawable 及自定义,具体介绍可见ImageDownloader
。 imageAware: 一个接口,表示需要加载图片的对象,可包装 View。 options: 图片显示的配置项。比如加载前、加载中、加载失败应该显示的占位图片,图片是否需要在磁盘缓存,是否需要在内存缓存等。 listener: 图片加载各种时刻的回调接口,包括开始加载、加载失败、加载成功、取消加载四个时刻的回调函数。 progressListener: 图片加载进度的回调接口。
函数流程图如下:
ImageLoader
的配置信息,包括图片最大尺寸、线程池、缓存、下载器、解码器等等。
主要属性:
(1). Resources resources程序本地资源访问器,用于加载DisplayImageOptions
中设置的一些 App 中图片资源。
内存缓存的图片最大宽度。
(3). int maxImageHeightForMemoryCache内存缓存的图片最大高度。
(4). int maxImageWidthForDiskCache磁盘缓存的图片最大宽度。
(5). int maxImageHeightForDiskCache磁盘缓存的图片最大高度。
(6). BitmapProcessor processorForDiskCache图片处理器,用于处理从磁盘缓存中读取到的图片。
(7). Executor taskExecutorImageLoaderEngine
中用于执行从源获取图片任务的 Executor。
ImageLoaderEngine
中用于执行从缓存获取图片任务的 Executor。
用户是否自定义了上面的 taskExecutor。
(20). boolean customExecutorForCachedImages用户是否自定义了上面的 taskExecutorForCachedImages。
(21). int threadPoolSize上面两个默认线程池的核心池大小,即最大并发数。
(22). int threadPriority上面两个默认线程池的线程优先级。
(23). QueueProcessingType tasksProcessingType上面两个默认线程池的线程队列类型。目前只有 FIFO, LIFO 两种可供选择。
(24). MemoryCache memoryCache图片内存缓存。
(25). DiskCache diskCache图片磁盘缓存,一般放在 SD 卡。
(26). ImageDownloader downloader图片下载器。
(27). ImageDecoder decoder图片解码器,内部可使用我们常用的BitmapFactory.decode(…)
将图片资源解码成Bitmap
对象。
图片显示的配置项。比如加载前、加载中、加载失败应该显示的占位图片,图片是否需要在磁盘缓存,是否需要在内存缓存等。
(29). ImageDownloader networkDeniedDownloader不允许访问网络的图片下载器。
(30). ImageDownloader slowNetworkDownloader慢网络情况下的图片下载器。
4.2.3 ImageLoaderConfiguration.Builder.java 静态内部类Builder 模式,用于构造参数繁多的ImageLoaderConfiguration
。 其属性与ImageLoaderConfiguration
类似,函数多是属性设置函数。
主要函数及含义:
(1). build()按照配置,生成 ImageLoaderConfiguration。代码如下:
public ImageLoaderConfiguration build() {
initEmptyFieldsWithDefaultValues();
return new ImageLoaderConfiguration(this);
}
(2). initEmptyFieldsWithDefaultValues()
初始化值为null
的属性。若用户没有配置相关项,UIL 会通过调用DefaultConfigurationFactory
中的函数返回一个默认值当配置。 taskExecutorForCachedImages
、taskExecutor
及ImageLoaderEngine
的taskDistributor
的默认值如下:
diskCacheFileNameGenerator
默认值为HashCodeFileNameGenerator
。 memoryCache
默认值为LruMemoryCache
。如果内存缓存不允许缓存一张图片的多个尺寸,则用FuzzyKeyMemoryCache
做封装,同一个图片新的尺寸会覆盖缓存中该图片老的尺寸。 diskCache
默认值与diskCacheSize
和diskCacheFileCount
值有关,如果他们有一个大于 0,则默认为LruDiskCache
,否则使用无大小限制的UnlimitedDiskCache
。 downloader
默认值为BaseImageDownloader
。 decoder
默认值为BaseImageDecoder
。 详细及其他属性默认值请到DefaultConfigurationFactory
中查看。
设置内存缓存不允许缓存一张图片的多个尺寸,默认允许。 后面会讲到 View 的 getWidth()
在初始化前后的不同值与这个设置的关系。
设置磁盘缓存的最大字节数,如果大于 0 或者下面的maxFileCount
大于 0,默认的DiskCache
会用LruDiskCache
,否则使用无大小限制的UnlimitedDiskCache
。
设置磁盘缓存文件夹下最大文件数,如果大于 0 或者上面的maxCacheSize
大于 0,默认的DiskCache
会用LruDiskCache
,否则使用无大小限制的UnlimitedDiskCache
。
不允许访问网络的图片下载器,实现了ImageDownloader
接口。 实现也比较简单,包装一个ImageDownloader
对象,通过在 getStream(…) 函数中禁止 Http 和 Https Scheme 禁止网络访问,如下:
@Override
public InputStream getStream(String imageUri, Object extra) throws IOException {
switch (Scheme.ofUri(imageUri)) {
case HTTP:
case HTTPS:
throw new IllegalStateException();
default:
return wrappedDownloader.getStream(imageUri, extra);
}
}
4.2.5 ImageLoaderConfiguration.SlowNetworkImageDownloader.java 静态内部类
慢网络情况下的图片下载器,实现了ImageDownloader
接口。 通过包装一个ImageDownloader
对象实现,在 getStream(…) 函数中当 Scheme 为 Http 和 Https 时,用FlushedInputStream
代替InputStream
处理慢网络情况,具体见后面FlushedInputStream
的介绍。
LoadAndDisplayImageTask
和ProcessAndDisplayImageTask
任务分发器,负责分发任务给具体的线程池。
主要属性:
(1). ImageLoaderConfiguration configurationImageLoader
的配置信息,可包括图片最大尺寸、线程池、缓存、下载器、解码器等等。
用于执行从源获取图片任务的 Executor,为configuration
中的 taskExecutor,如果为null
,则会调用DefaultConfigurationFactory.createExecutor(…)
根据配置返回一个默认的线程池。
用于执行从缓存获取图片任务的 Executor,为configuration
中的 taskExecutorForCachedImages,如果为null
,则会调用DefaultConfigurationFactory.createExecutor(…)
根据配置返回一个默认的线程池。
任务分发线程池,任务指LoadAndDisplayImageTask
和ProcessAndDisplayImageTask
,因为只需要分发给上面的两个 Executor 去执行任务,不存在较耗时或阻塞操作,所以用无并发数(Int 最大值)限制的线程池即可。
ImageAware
与内存缓存 key 对应的 map,key 为ImageAware
的 id,value 为内存缓存的 key。
图片正在加载的重入锁 map,key 为图片的 uri,value 为标识其正在加载的重入锁。
(7). AtomicBoolean paused是否被暂停。如果为true
,则所有新的加载或显示任务都会等待直到取消暂停(为false
)。
是否不允许访问网络,如果为true
,通过ImageLoadingListener.onLoadingFailed(…)
获取图片,则所有不在缓存中需要网络访问的请求都会失败,返回失败原因为网络访问被禁止
。
是否是慢网络情况,如果为true
,则自动调用SlowNetworkImageDownloader
下载图片。
暂停的等待锁,可在engine
被暂停后调用这个锁等待。
主要函数:
(1). void submit(final LoadAndDisplayImageTask task)添加一个LoadAndDisplayImageTask
。直接用taskDistributor
执行一个 Runnable,在 Runnable 内部根据图片是否被磁盘缓存过确定使用taskExecutorForCachedImages
还是taskExecutor
执行该 task。
添加一个ProcessAndDisplayImageTask
。直接用taskExecutorForCachedImages
执行该 task。
暂停图片加载任务。所有新的加载或显示任务都会等待直到取消暂停(为false
)。
继续图片加载任务。
(5). stop()暂停所有加载和显示图片任务并清除这里的内部属性值。
(6). fireCallback(Runnable r)taskDistributor
立即执行某个任务。
得到某个 uri 的重入锁,如果不存在则新建。
(8). createTaskExecutor()调用DefaultConfigurationFactory.createExecutor(…)
创建一个线程池。
得到某个imageAware
正在加载的图片 uri。
准备开始一个Task
。向cacheKeysForImageAwares
中插入ImageAware
的 id 和图片在内存缓存中的 key。
取消一个显示任务。从cacheKeysForImageAwares
中删除ImageAware
对应元素。
设置是否不允许网络访问。
(13). handleSlowNetwork(boolean handleSlowNetwork)设置是否慢网络情况。
4.2.7 DefaultConfigurationFactory.java为ImageLoaderConfiguration
及ImageLoaderEngine
提供一些默认配置。
主要函数:
(1). createExecutor(int threadPoolSize, int threadPriority, QueueProcessingType tasksProcessingType)创建线程池。 threadPoolSize
表示核心池大小(最大并发数)。 threadPriority
表示线程优先级。 tasksProcessingType
表示线程队列类型,目前只有 FIFO, LIFO 两种可供选择。 内部实现会调用createThreadFactory(…)
返回一个支持线程优先级设置,并且以固定规则命名新建的线程的线程工厂类DefaultConfigurationFactory.DefaultThreadFactory
。
为ImageLoaderEngine
中的任务分发器taskDistributor
提供线程池,该线程池为 normal 优先级的无并发大小限制的线程池。
返回一个HashCodeFileNameGenerator
对象,即以 uri HashCode 为文件名的文件名生成器。
创建一个 Disk Cache。如果 diskCacheSize 或者 diskCacheFileCount 大于 0,返回一个LruDiskCache
,否则返回无大小限制的UnlimitedDiskCache
。
创建一个 Memory Cache。返回一个LruMemoryCache
,若 memoryCacheSize 为 0,则设置该内存缓存的最大字节数为 App 最大可用内存的 1/8。 这里 App 的最大可用内存也支持系统在 Honeycomb之后(ApiLevel >= 11) application 中android:largeHeap="true"
的设置。
创建图片下载器,返回一个BaseImageDownloader
。
创建图片解码器,返回一个BaseImageDecoder
。
创建图片显示器,返回一个SimpleBitmapDisplayer
。
默认的线程工厂类,为 DefaultConfigurationFactory.createExecutor(…)
和 DefaultConfigurationFactory.createTaskDistributor(…)
提供线程工厂。支持线程优先级设置,并且以固定规则命名新建的线程。
PS:重命名线程是个很好的习惯,它的一大作用就是方便问题排查,比如性能优化,用 TraceView 查看线程,根据名字很容易分辨各个线程。
4.2.9 ImageAware.java需要显示图片的对象的接口,可包装 View 表示某个需要显示图片的 View。
主要函数:
(1). View getWrappedView()得到被包装的 View,图片在该 View 上显示。
(2). getWidth() 与 getHeight()得到宽度高度,在计算图片缩放比例时会用到。
(3). getId()得到唯一标识 id。ImageLoaderEngine
中用这个 id 标识正在加载图片的ImageAware
和图片内存缓存 key 的对应关系,图片请求前会将内存缓存 key 与新的内存缓存 key 进行比较,如果不相等,则之前的图片请求会被取消。这样当ImageAware
被复用时就不会因异步加载(前面任务未取消)而造成错乱了。
封装 Android View 来显示图片的抽象类,实现了ImageAware
接口,利用Reference
来 Warp View 防止内存泄露。
主要函数:
(1). ViewAware(View view, boolean checkActualViewSize)构造函数。 view
表示需要显示图片的对象。 checkActualViewSize
表示通过getWidth()
和getHeight()
获取图片宽高时返回真实的宽和高,还是LayoutParams
的宽高,true 表示返回真实宽和高。 如果为true
会导致一个问题,View
在还没有初始化完成时加载图片,这时它的真实宽高为0,会取它LayoutParams
的宽高,而图片缓存的 key 与这个宽高有关,所以当View
初始化完成再次需要加载该图片时,getWidth()
和getHeight()
返回的宽高都已经变化,缓存 key 不一样,从而导致缓存命中失败会再次从网络下载一次图片。可通过ImageLoaderConfiguration.Builder.denyCacheImageMultipleSizesInMemory()
设置不允许内存缓存缓存一张图片的多个尺寸。
如果当前操作在主线程并且 View 没有被回收,则调用抽象函数setImageDrawableInto(Drawable drawable, View view)
去向View
设置图片。
如果当前操作在主线程并且 View 没有被回收,则调用抽象函数setImageBitmapInto(Bitmap bitmap, View view)
去向View
设置图片。
封装 Android ImageView 来显示图片的ImageAware
,继承了ViewAware
,利用Reference
来 Warp View 防止内存泄露。 如果getWidth()
函数小于等于0,会利用反射获取mMaxWidth
的值作为宽。 如果getHeight()
函数小于等于0,会利用反射获取mMaxHeight
的值作为高。
仅包含处理图片相关信息却没有需要显示图片的 View 的ImageAware
,实现了ImageAware
接口。常用于加载图片后调用回调接口而不是显示的情况。
图片显示的配置项。比如加载前、加载中、加载失败应该显示的占位图片,图片是否需要在磁盘缓存,是否需要在 memory 缓存等。
主要属性及含义:
(1). int imageResOnLoading图片正在加载中的占位图片的 resource id,优先级比下面的imageOnLoading
高,当存在时,imageOnLoading
不起作用。
空 uri 时的占位图片的 resource id,优先级比下面的imageForEmptyUri
高,当存在时,imageForEmptyUri
不起作用。
加载失败时的占位图片的 resource id,优先级比下面的imageOnFail
高,当存在时,imageOnFail
不起作用。
加载中的占位图片的 drawabled 对象,默认为 null。
(5). Drawable imageForEmptyUri空 uri 时的占位图片的 drawabled 对象,默认为 null。
(6). Drawable imageOnFail加载失败时的占位图片的 drawabled 对象,默认为 null。
(7). boolean resetViewBeforeLoading在加载前是否重置 view,通过 Builder 构建的对象默认为 false。
(8). boolean cacheInMemory是否缓存在内存中,通过 Builder 构建的对象默认为 false。
(9). boolean cacheOnDisk是否缓存在磁盘中,通过 Builder 构建的对象默认为 false。
(10). ImageScaleType imageScaleType图片的缩放类型,通过 Builder 构建的对象默认为IN_SAMPLE_POWER_OF_2
。
为 BitmapFactory.Options,用于BitmapFactory.decodeStream(imageStream, null, decodingOptions)
得到图片尺寸等信息。
设置在开始加载前的延迟时间,单位为毫秒,通过 Builder 构建的对象默认为 0。
(13). boolean considerExifParams是否考虑图片的 EXIF 信息,通过 Builder 构建的对象默认为 false。
(14). Object extraForDownloader下载器需要的辅助信息。下载时传入ImageDownloader.getStream(String, Object)
的对象,方便用户自己扩展,默认为 null。
缓存在内存之前的处理程序,默认为 null。
(16). BitmapProcessor postProcessor缓存在内存之后的处理程序,默认为 null。
(17). BitmapDisplayer displayer图片的显示方式,通过 Builder 构建的对象默认为SimpleBitmapDisplayer
。
handler 对象,默认为 null。
(19). boolean isSyncLoading是否同步加载,通过 Builder 构建的对象默认为 false。
4.2.14 DisplayImageOptions.Builder.java 静态内部类Builder 模式,用于构造参数繁多的DisplayImageOptions
。 其属性与DisplayImageOptions
类似,函数多是属性设置函数。
图片加载各种时刻的回调接口,可在图片加载的某些点做监听。 包括开始加载(onLoadingStarted)、加载失败(onLoadingFailed)、加载成功(onLoadingComplete)、取消加载(onLoadingCancelled)四个回调函数。
4.2.16 SimpleImageLoadingListener.java实现ImageLoadingListener
接口,不过各个函数都是空实现,表示不在 Image 加载过程中做任何回调监听。 ImageLoader.displayImage(…)
函数中当入参listener
为空时的默认值。
Image 加载进度的回调接口。其中抽象函数
void onProgressUpdate(String imageUri, View view, int current, int total)
会在获取图片存储到文件系统时被回调。其中total
表示图片总大小,为网络请求结果Response Header
中content-length
字段,如果不存在则为 -1。
显示图片的Task
,实现了Runnable
接口,必须在主线程调用。
主要函数:
(1) run()首先判断imageAware
是否被 GC 回收,如果是直接调用取消加载回调接口ImageLoadingListener.onLoadingCancelled(…)
; 否则判断imageAware
是否被复用,如果是直接调用取消加载回调接口ImageLoadingListener.onLoadingCancelled(…)
; 否则调用displayer
显示图片,并将imageAware
从正在加载的 map 中移除。调用加载成功回调接口ImageLoadingListener.onLoadingComplete(…)
。
对于 ListView 或是 GridView 这类会缓存 Item 的 View 来说,单个 Item 中如果含有 ImageView,在滑动过程中可能因为异步加载及 View 复用导致图片错乱,这里对imageAware
是否被复用的判断就能很好的解决这个问题。原因类似:Android ListView 滑动过程中图片显示重复错位闪烁问题原因及解决方案。
处理并显示图片的Task
,实现了Runnable
接口。
主要函数:
(1) run()主要通过 imageLoadingInfo 得到BitmapProcessor
处理图片,并用处理后的图片和配置新建一个DisplayBitmapTask
在ImageAware
中显示图片。
加载并显示图片的Task
,实现了Runnable
接口,用于从网络、文件系统或内存获取图片并解析,然后调用DisplayBitmapTask
在ImageAware
中显示图片。
主要函数:
(1) run()获取图片并显示,核心代码如下:
bmp = configuration.memoryCache.get(memoryCacheKey);
if (bmp == null || bmp.isRecycled()) {
bmp = tryLoadBitmap();
...
...
...
if (bmp != null && options.isCacheInMemory()) {
L.d(LOG_CACHE_IMAGE_IN_MEMORY, memoryCacheKey);
configuration.memoryCache.put(memoryCacheKey, bmp);
}
}
……
DisplayBitmapTask displayBitmapTask = new DisplayBitmapTask(bmp, imageLoadingInfo, engine, loadedFrom);
runTask(displayBitmapTask, syncLoading, handler, engine);
从上面代码段中可以看到先是从内存缓存中去读取 bitmap 对象,若 bitmap 对象不存在,则调用 tryLoadBitmap() 函数获取 bitmap 对象,获取成功后若在 DisplayImageOptions.Builder 中设置了 cacheInMemory(true), 同时将 bitmap 对象缓存到内存中。 最后新建DisplayBitmapTask
显示图片。
函数流程图如下:
- 判断图片的内存缓存是否存在,若存在直接执行步骤 8;
- 判断图片的磁盘缓存是否存在,若存在直接执行步骤 5;
- 从网络上下载图片;
- 将图片缓存在磁盘上;
- 将图片 decode 成 bitmap 对象;
- 根据
DisplayImageOptions
配置对图片进行预处理(Pre-process Bitmap); - 将 bitmap 对象缓存到内存中;
- 根据
DisplayImageOptions
配置对图片进行后处理(Post-process Bitmap); - 执行
DisplayBitmapTask
将图片显示在相应的控件上。 流程图可以参见3. 流程图
。
从磁盘缓存或网络获取图片,核心代码如下:
File imageFile = configuration.diskCache.get(uri);
if (imageFile != null && imageFile.exists()) {
...
bitmap = decodeImage(Scheme.FILE.wrap(imageFile.getAbsolutePath()));
}
if (bitmap == null || bitmap.getWidth()
关注
打赏
最近更新
- 深拷贝和浅拷贝的区别(重点)
- 【Vue】走进Vue框架世界
- 【云服务器】项目部署—搭建网站—vue电商后台管理系统
- 【React介绍】 一文带你深入React
- 【React】React组件实例的三大属性之state,props,refs(你学废了吗)
- 【脚手架VueCLI】从零开始,创建一个VUE项目
- 【React】深入理解React组件生命周期----图文详解(含代码)
- 【React】DOM的Diffing算法是什么?以及DOM中key的作用----经典面试题
- 【React】1_使用React脚手架创建项目步骤--------详解(含项目结构说明)
- 【React】2_如何使用react脚手架写一个简单的页面?


微信扫码登录