全面解析Android的开源图片框架Universal-Image-Loader
相信大家平时做android应用的时候,多少会接触到异步加载图片,或者加载大量图片的问题,而加载图片我们常常会遇到许多的问题,比如说图片的错乱,oom等问题,对于新手来说,这些问题解决起来会比较吃力,所以就有很多的开源图片加载框架应运而生,比较著名的就是universal-image-loader,相信很多朋友都听过或者使用过这个强大的图片加载框架,今天这篇文章就是对这个框架的基本介绍以及使用,主要是帮助那些没有使用过这个框架的朋友们。该项目存在于github上面https://github.com/nostra13/android-universal-image-loader,我们可以先看看这个开源库存在哪些特征
- 多线程下载图片,图片可以来源于网络,文件系统,项目文件夹assets中以及drawable中等
- 支持随意的配置imageloader,例如线程池,图片下载器,内存缓存策略,硬盘缓存策略,图片显示选项以及其他的一些配置
- 支持图片的内存缓存,文件系统缓存或者sd卡缓存
- 支持图片下载过程的监听
- 根据控件(imageview)的大小对bitmap进行裁剪,减少bitmap占用过多的内存
- 较好的控制图片的加载过程,例如暂停图片加载,重新开始加载图片,一般使用在listview,gridview中
- 动过程中暂停加载图片
- 停止滑动的时候去加载图片
- 供在较慢的网络下对图片进行加载。
当然上面列举的特性可能不全,要想了解一些其他的特性只能通过我们的使用慢慢去发现了,接下来我们就看看这个开源库的简单使用吧。
新建一个android项目,下载jar包添加到工程libs目录下。
新建一个myapplication继承application,并在oncreate()中创建imageloader的配置参数,并初始化到imageloader中代码如下:
package com.example.uil; import com.nostra13.universalimageloader.core.imageloader; import com.nostra13.universalimageloader.core.imageloaderconfiguration; import android.app.application; public class myapplication extends application { @override public void oncreate() { super.oncreate(); //创建默认的imageloader配置参数 imageloaderconfiguration configuration = imageloaderconfiguration .createdefault(this); //initialize imageloader with configuration. imageloader.getinstance().init(configuration); } }
imageloaderconfiguration是图片加载器imageloader的配置参数,使用了建造者模式,这里是直接使用了createdefault()方法创建一个默认的imageloaderconfiguration,当然我们还可以自己设置imageloaderconfiguration,设置如下
file cachedir = storageutils.getcachedirectory(context); imageloaderconfiguration config = new imageloaderconfiguration.builder(context) .memorycacheextraoptions(480, 800) // default = device screen dimensions .diskcacheextraoptions(480, 800, compressformat.jpeg, 75, null) .taskexecutor(...) .taskexecutorforcachedimages(...) .threadpoolsize(3) // default .threadpriority(thread.norm_priority - 1) // 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) .diskcachefilecount(100) .diskcachefilenamegenerator(new hashcodefilenamegenerator()) // default .imagedownloader(new baseimagedownloader(context)) // default .imagedecoder(new baseimagedecoder()) // default .defaultdisplayimageoptions(displayimageoptions.createsimple()) // default .writedebuglogs() .build();
上面的这些就是所有的选项配置,我们在项目中不需要每一个都自己设置,一般使用createdefault()创建的imageloaderconfiguration就能使用,然后调用imageloader的init()方法将imageloaderconfiguration参数传递进去,imageloader使用单例模式。
配置android manifest文件
<manifest> <uses-permission android:name="android.permission.internet" /> <!-- include next permission if you want to allow uil to cache images on sd card --> <uses-permission android:name="android.permission.write_external_storage" /> ... <application android:name="myapplication"> ... </application> </manifest>
接下来我们就可以来加载图片了,首先我们定义好activity的布局文件
<?xml version="1.0" encoding="utf-8"?> <framelayout xmlns:android="http://schemas.android.com/apk/res/android" android:layout_width="fill_parent" android:layout_height="fill_parent"> <imageview android:layout_gravity="center" android:id="@+id/image" android:src="@drawable/ic_empty" android:layout_width="wrap_content" android:layout_height="wrap_content" /> </framelayout>
里面只有一个imageview,很简单,接下来我们就去加载图片,我们会发现imagelader提供了几个图片加载的方法,主要是这几个displayimage(), loadimage(),loadimagesync(),loadimagesync()方法是同步的,android4.0有个特性,网络操作不能在主线程,所以loadimagesync()方法我们就不去使用
.
loadimage()加载图片
我们先使用imageloader的loadimage()方法来加载网络图片
final imageview mimageview = (imageview) findviewbyid(r.id.image); string imageurl = "https://lh6.googleusercontent.com/-55osaww3x0q/urquutcfr5i/aaaaaaaaabs/rwlj1rukryi/s1024/a%252520photographer.jpg"; imageloader.getinstance().loadimage(imageurl, new imageloadinglistener() { @override public void onloadingstarted(string imageuri, view view) { } @override public void onloadingfailed(string imageuri, view view, failreason failreason) { } @override public void onloadingcomplete(string imageuri, view view, bitmap loadedimage) { mimageview.setimagebitmap(loadedimage); } @override public void onloadingcancelled(string imageuri, view view) { } });
传入图片的url和imageloaderlistener, 在回调方法onloadingcomplete()中将loadedimage设置到imageview上面就行了,如果你觉得传入imageloaderlistener太复杂了,我们可以使用simpleimageloadinglistener类,该类提供了imageloaderlistener接口方法的空实现,使用的是缺省适配器模式
final imageview mimageview = (imageview) findviewbyid(r.id.image); string imageurl = "https://lh6.googleusercontent.com/-55osaww3x0q/urquutcfr5i/aaaaaaaaabs/rwlj1rukryi/s1024/a%252520photographer.jpg"; imageloader.getinstance().loadimage(imageurl, new simpleimageloadinglistener(){ @override public void onloadingcomplete(string imageuri, view view, bitmap loadedimage) { super.onloadingcomplete(imageuri, view, loadedimage); mimageview.setimagebitmap(loadedimage); } });
如果我们要指定图片的大小该怎么办呢,这也好办,初始化一个imagesize对象,指定图片的宽和高,代码如下
final imageview mimageview = (imageview) findviewbyid(r.id.image); string imageurl = "https://lh6.googleusercontent.com/-55osaww3x0q/urquutcfr5i/aaaaaaaaabs/rwlj1rukryi/s1024/a%252520photographer.jpg"; imagesize mimagesize = new imagesize(100, 100); imageloader.getinstance().loadimage(imageurl, mimagesize, new simpleimageloadinglistener(){ @override public void onloadingcomplete(string imageuri, view view, bitmap loadedimage) { super.onloadingcomplete(imageuri, view, loadedimage); mimageview.setimagebitmap(loadedimage); } });
上面只是很简单的使用imageloader来加载网络图片,在实际的开发中,我们并不会这么使用,那我们平常会怎么使用呢?我们会用到displayimageoptions,他可以配置一些图片显示的选项,比如图片在加载中imageview显示的图片,是否需要使用内存缓存,是否需要使用文件缓存等等,可供我们选择的配置如下
displayimageoptions options = new displayimageoptions.builder() .showimageonloading(r.drawable.ic_stub) // resource or drawable .showimageforemptyuri(r.drawable.ic_empty) // resource or drawable .showimageonfail(r.drawable.ic_error) // resource or drawable .resetviewbeforeloading(false) // default .delaybeforeloading(1000) .cacheinmemory(false) // default .cacheondisk(false) // default .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 .handler(new handler()) // default .build();
我们将上面的代码稍微修改下
final imageview mimageview = (imageview) findviewbyid(r.id.image); string imageurl = "https://lh6.googleusercontent.com/-55osaww3x0q/urquutcfr5i/aaaaaaaaabs/rwlj1rukryi/s1024/a%252520photographer.jpg"; imagesize mimagesize = new imagesize(100, 100); //显示图片的配置 displayimageoptions options = new displayimageoptions.builder() .cacheinmemory(true) .cacheondisk(true) .bitmapconfig(bitmap.config.rgb_565) .build(); imageloader.getinstance().loadimage(imageurl, mimagesize, options, new simpleimageloadinglistener(){ @override public void onloadingcomplete(string imageuri, view view, bitmap loadedimage) { super.onloadingcomplete(imageuri, view, loadedimage); mimageview.setimagebitmap(loadedimage); } });
我们使用了displayimageoptions来配置显示图片的一些选项,这里我添加了将图片缓存到内存中已经缓存图片到文件系统中,这样我们就不用担心每次都从网络中去加载图片了,是不是很方便呢,但是displayimageoptions选项中有些选项对于loadimage()方法是无效的,比如showimageonloading, showimageforemptyuri等,
displayimage()加载图片
接下来我们就来看看网络图片加载的另一个方法displayimage(),代码如下
final imageview mimageview = (imageview) findviewbyid(r.id.image); string imageurl = "https://lh6.googleusercontent.com/-55osaww3x0q/urquutcfr5i/aaaaaaaaabs/rwlj1rukryi/s1024/a%252520photographer.jpg"; //显示图片的配置 displayimageoptions options = new displayimageoptions.builder() .showimageonloading(r.drawable.ic_stub) .showimageonfail(r.drawable.ic_error) .cacheinmemory(true) .cacheondisk(true) .bitmapconfig(bitmap.config.rgb_565) .build(); imageloader.getinstance().displayimage(imageurl, mimageview, options);
从上面的代码中,我们可以看出,使用displayimage()比使用loadimage()方便很多,也不需要添加imageloadinglistener接口,我们也不需要手动设置imageview显示bitmap对象,直接将imageview作为参数传递到displayimage()中就行了,图片显示的配置选项中,我们添加了一个图片加载中imageview上面显示的图片,以及图片加载出现错误显示的图片,效果如下,刚开始显示ic_stub图片,如果图片加载成功显示图片,加载产生错误显示ic_error
这个方法使用起来比较方便,而且使用displayimage()方法 他会根据控件的大小和imagescaletype来自动裁剪图片,我们修改下myapplication,开启log打印
public class myapplication extends application { @override public void oncreate() { super.oncreate(); //创建默认的imageloader配置参数 imageloaderconfiguration configuration = new imageloaderconfiguration.builder(this) .writedebuglogs() //打印log信息 .build(); //initialize imageloader with configuration. imageloader.getinstance().init(configuration); } }
我们来看下图片加载的log信息
第一条信息中,告诉我们开始加载图片,打印出图片的url以及图片的最大宽度和高度,图片的宽高默认是设备的宽高,当然如果我们很清楚图片的大小,我们也可以去设置这个大小,在imageloaderconfiguration的选项中memorycacheextraoptions(int maximagewidthformemorycache, int maximageheightformemorycache)
第二条信息显示我们加载的图片来源于网络
第三条信息显示图片的原始大小为1024 x 682 经过裁剪变成了512 x 341
第四条显示图片加入到了内存缓存中,我这里没有加入到sd卡中,所以没有加入文件缓存的log
我们在加载网络图片的时候,经常有需要显示图片下载进度的需求,universal-image-loader当然也提供这样的功能,只需要在displayimage()方法中传入imageloadingprogresslistener接口就行了,代码如下
imageloader.displayimage(imageurl, mimageview, options, new simpleimageloadinglistener(), new imageloadingprogresslistener() { @override public void onprogressupdate(string imageuri, view view, int current, int total) { } });
由于displayimage()方法中带imageloadingprogresslistener参数的方法都有带imageloadinglistener参数,所以我这里直接new 一个simpleimageloadinglistener,然后我们就可以在回调方法onprogressupdate()得到图片的加载进度。
加载其他来源的图片
使用universal-image-loader框架不仅可以加载网络图片,还可以加载sd卡中的图片,content provider等,使用也很简单,只是将图片的url稍加的改变下就行了,下面是加载文件系统的图片
//显示图片的配置 displayimageoptions options = new displayimageoptions.builder() .showimageonloading(r.drawable.ic_stub) .showimageonfail(r.drawable.ic_error) .cacheinmemory(true) .cacheondisk(true) .bitmapconfig(bitmap.config.rgb_565) .build(); final imageview mimageview = (imageview) findviewbyid(r.id.image); string imagepath = "/mnt/sdcard/image.png"; string imageurl = scheme.file.wrap(imagepath); // string imageurl = "http://img.my.csdn.net/uploads/201309/01/1378037235_7476.jpg"; imageloader.displayimage(imageurl, mimageview, options);
当然还有来源于content provider,drawable,assets中,使用的时候也很简单,我们只需要给每个图片来源的地方加上scheme包裹起来(content provider除外),然后当做图片的url传递到imageloader中,universal-image-loader框架会根据不同的scheme获取到输入流
//图片来源于content provider string contentprividerurl = "content://media/external/audio/albumart/13"; //图片来源于assets string assetsurl = scheme.assets.wrap("image.png"); //图片来源于 string drawableurl = scheme.drawable.wrap("r.drawable.image");
girdview,listview加载图片
相信大部分人都是使用gridview,listview来显示大量的图片,而当我们快速滑动gridview,listview,我们希望能停止图片的加载,而在gridview,listview停止滑动的时候加载当前界面的图片,这个框架当然也提供这个功能,使用起来也很简单,它提供了pauseonscrolllistener这个类来控制listview,gridview滑动过程中停止去加载图片,该类使用的是代理模式
[java] view plain copy 在code上查看代码片派生到我的代码片
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设定的值来裁剪图片。
内存缓存
首先我们来了解下什么是强引用和什么是弱引用?
强引用是指创建一个对象并把这个对象赋给一个引用变量, 强引用有引用变量指向时永远不会被垃圾回收。即使内存不足的时候宁愿报oom也不被垃圾回收器回收,我们new的对象都是强引用
弱引用通过weakreference类来实现,它具有很强的不确定性,如果垃圾回收器扫描到有着weakreference的对象,就会将其回收释放内存
现在我们来看universal-image-loader有哪些内存缓存策略
1. 只使用的是强引用缓存
lrumemorycache(这个类就是这个开源框架默认的内存缓存类,缓存的是bitmap的强引用,下面我会从源码上面分析这个类)
2.使用强引用和弱引用相结合的缓存有
usingfreqlimitedmemorycache(如果缓存的图片总量超过限定值,先删除使用频率最小的bitmap)
lrulimitedmemorycache(这个也是使用的lru算法,和lrumemorycache不同的是,他缓存的是bitmap的弱引用)
fifolimitedmemorycache(先进先出的缓存策略,当超过设定值,先删除最先加入缓存的bitmap)
largestlimitedmemorycache(当超过缓存限定值,先删除最大的bitmap对象)
limitedagememorycache(当 bitmap加入缓存中的时间超过我们设定的值,将其删除)
3.只使用弱引用缓存
weakmemorycache(这个类缓存bitmap的总大小没有限制,唯一不足的地方就是不稳定,缓存的图片容易被回收掉)
上面介绍了universal-image-loader所提供的所有的内存缓存的类,当然我们也可以使用我们自己写的内存缓存类,我们还要看看要怎么将这些内存缓存加入到我们的项目中,我们只需要配置imageloaderconfiguration.memorycache(...),如下
imageloaderconfiguration configuration = new imageloaderconfiguration.builder(this) .memorycache(new weakmemorycache()) .build();
下面我们来分析lrumemorycache这个类的源代码
package com.nostra13.universalimageloader.cache.memory.impl; import android.graphics.bitmap; import com.nostra13.universalimageloader.cache.memory.memorycacheaware; import java.util.collection; import java.util.hashset; import java.util.linkedhashmap; import java.util.map; /** * a cache that holds strong references to a limited number of bitmaps. each time a bitmap is accessed, it is moved to * the head of a queue. when a bitmap is added to a full cache, the bitmap at the end of that queue is evicted and may * become eligible for garbage collection.<br /> * <br /> * <b>note:</b> this cache uses only strong references for stored bitmaps. * * @author sergey tarasevich (nostra13[at]gmail[dot]com) * @since 1.8.1 */ public class lrumemorycache implements memorycacheaware<string, bitmap> { private final linkedhashmap<string, bitmap> map; private final int maxsize; /** size of this cache in bytes */ private int size; /** @param maxsize maximum sum of the sizes of the bitmaps in this cache */ public lrumemorycache(int maxsize) { if (maxsize <= 0) { throw new illegalargumentexception("maxsize <= 0"); } this.maxsize = maxsize; this.map = new linkedhashmap<string, bitmap>(0, 0.75f, true); } /** * returns the bitmap for {@code key} if it exists in the cache. if a bitmap was returned, it is moved to the head * of the queue. this returns null if a bitmap is not cached. */ @override public final bitmap get(string key) { if (key == null) { throw new nullpointerexception("key == null"); } synchronized (this) { return map.get(key); } } /** caches {@code bitmap} for {@code key}. the bitmap is moved to the head of the queue. */ @override public final boolean put(string key, bitmap value) { if (key == null || value == null) { throw new nullpointerexception("key == null || value == null"); } synchronized (this) { size += sizeof(key, value); bitmap previous = map.put(key, value); if (previous != null) { size -= sizeof(key, previous); } } trimtosize(maxsize); return true; } /** * remove the eldest entries until the total of remaining entries is at or below the requested size. * * @param maxsize the maximum size of the cache before returning. may be -1 to evict even 0-sized elements. */ private void trimtosize(int maxsize) { while (true) { string key; bitmap value; synchronized (this) { if (size < 0 || (map.isempty() && size != 0)) { throw new illegalstateexception(getclass().getname() + ".sizeof() is reporting inconsistent results!"); } if (size <= maxsize || map.isempty()) { break; } map.entry<string, bitmap> toevict = map.entryset().iterator().next(); if (toevict == null) { break; } key = toevict.getkey(); value = toevict.getvalue(); map.remove(key); size -= sizeof(key, value); } } } /** removes the entry for {@code key} if it exists. */ @override public final void remove(string key) { if (key == null) { throw new nullpointerexception("key == null"); } synchronized (this) { bitmap previous = map.remove(key); if (previous != null) { size -= sizeof(key, previous); } } } @override public collection<string> keys() { synchronized (this) { return new hashset<string>(map.keyset()); } } @override public void clear() { trimtosize(-1); // -1 will evict 0-sized elements } /** * returns the size {@code bitmap} in bytes. * <p/> * an entry's size must not change while it is in the cache. */ private int sizeof(string key, bitmap value) { return value.getrowbytes() * value.getheight(); } @override public synchronized final string tostring() { return string.format("lrucache[maxsize=%d]", maxsize); } }
我们可以看到这个类中维护的是一个linkedhashmap,在lrumemorycache构造函数中我们可以看到,我们为其设置了一个缓存图片的最大值maxsize,并实例化linkedhashmap, 而从linkedhashmap构造函数的第三个参数为ture,表示它是按照访问顺序进行排序的,
我们来看将bitmap加入到lrumemorycache的方法put(string key, bitmap value), 第61行,sizeof()是计算每张图片所占的byte数,size是记录当前缓存bitmap的总大小,如果该key之前就缓存了bitmap,我们需要将之前的bitmap减掉去,接下来看trimtosize()方法,我们直接看86行,如果当前缓存的bitmap总数小于设定值maxsize,不做任何处理,如果当前缓存的bitmap总数大于maxsize,删除linkedhashmap中的第一个元素,size中减去该bitmap对应的byte数
我们可以看到该缓存类比较简单,逻辑也比较清晰,如果大家想知道其他内存缓存的逻辑,可以去分析分析其源码,在这里我简单说下fifolimitedmemorycache的实现逻辑,该类使用的hashmap来缓存bitmap的弱引用,然后使用linkedlist来保存成功加入到fifolimitedmemorycache的bitmap的强引用,如果加入的fifolimitedmemorycache的bitmap总数超过限定值,直接删除linkedlist的第一个元素,所以就实现了先进先出的缓存策略,其他的缓存都类似,有兴趣的可以去看看。
硬盘缓存
接下来就给大家分析分析硬盘缓存的策略,这个框架也提供了几种常见的缓存策略,当然如果你觉得都不符合你的要求,你也可以自己去扩展
- filecountlimiteddisccache(可以设定缓存图片的个数,当超过设定值,删除掉最先加入到硬盘的文件)
- limitedagedisccache(设定文件存活的最长时间,当超过这个值,就删除该文件)
- totalsizelimiteddisccache(设定缓存bitmap的最大值,当超过这个值,删除最先加入到硬盘的文件)
- unlimiteddisccache(这个缓存类没有任何的限制)
下面我们就来分析分析totalsizelimiteddisccache的源码实现
/******************************************************************************* * copyright 2011-2013 sergey tarasevich * * licensed under the apache license, version 2.0 (the "license"); * you may not use this file except in compliance with the license. * you may obtain a copy of the license at * * http://www.apache.org/licenses/license-2.0 * * unless required by applicable law or agreed to in writing, software * distributed under the license is distributed on an "as is" basis, * without warranties or conditions of any kind, either express or implied. * see the license for the specific language governing permissions and * limitations under the license. *******************************************************************************/ package com.nostra13.universalimageloader.cache.disc.impl; import com.nostra13.universalimageloader.cache.disc.limiteddisccache; import com.nostra13.universalimageloader.cache.disc.naming.filenamegenerator; import com.nostra13.universalimageloader.core.defaultconfigurationfactory; import com.nostra13.universalimageloader.utils.l; import java.io.file; /** * disc cache limited by total cache size. if cache size exceeds specified limit then file with the most oldest last * usage date will be deleted. * * @author sergey tarasevich (nostra13[at]gmail[dot]com) * @see limiteddisccache * @since 1.0.0 */ public class totalsizelimiteddisccache extends limiteddisccache { private static final int min_normal_cache_size_in_mb = 2; private static final int min_normal_cache_size = min_normal_cache_size_in_mb * 1024 * 1024; /** * @param cachedir directory for file caching. <b>important:</b> specify separate folder for cached files. it's * needed for right cache limit work. * @param maxcachesize maximum cache directory size (in bytes). if cache size exceeds this limit then file with the * most oldest last usage date will be deleted. */ public totalsizelimiteddisccache(file cachedir, int maxcachesize) { this(cachedir, defaultconfigurationfactory.createfilenamegenerator(), maxcachesize); } /** * @param cachedir directory for file caching. <b>important:</b> specify separate folder for cached files. it's * needed for right cache limit work. * @param filenamegenerator name generator for cached files * @param maxcachesize maximum cache directory size (in bytes). if cache size exceeds this limit then file with the * most oldest last usage date will be deleted. */ public totalsizelimiteddisccache(file cachedir, filenamegenerator filenamegenerator, int maxcachesize) { super(cachedir, filenamegenerator, maxcachesize); if (maxcachesize < min_normal_cache_size) { l.w("you set too small disc cache size (less than %1$d mb)", min_normal_cache_size_in_mb); } } @override protected int getsize(file file) { return (int) file.length(); } }
这个类是继承limiteddisccache,除了两个构造函数之外,还重写了getsize()方法,返回文件的大小,接下来我们就来看看limiteddisccache
/******************************************************************************* * copyright 2011-2013 sergey tarasevich * * licensed under the apache license, version 2.0 (the "license"); * you may not use this file except in compliance with the license. * you may obtain a copy of the license at * * http://www.apache.org/licenses/license-2.0 * * unless required by applicable law or agreed to in writing, software * distributed under the license is distributed on an "as is" basis, * without warranties or conditions of any kind, either express or implied. * see the license for the specific language governing permissions and * limitations under the license. *******************************************************************************/ package com.nostra13.universalimageloader.cache.disc; import com.nostra13.universalimageloader.cache.disc.naming.filenamegenerator; import com.nostra13.universalimageloader.core.defaultconfigurationfactory; import java.io.file; import java.util.collections; import java.util.hashmap; import java.util.map; import java.util.map.entry; import java.util.set; import java.util.concurrent.atomic.atomicinteger; /** * abstract disc cache limited by some parameter. if cache exceeds specified limit then file with the most oldest last * usage date will be deleted. * * @author sergey tarasevich (nostra13[at]gmail[dot]com) * @see basedisccache * @see filenamegenerator * @since 1.0.0 */ public abstract class limiteddisccache extends basedisccache { private static final int invalid_size = -1; //记录缓存文件的大小 private final atomicinteger cachesize; //缓存文件的最大值 private final int sizelimit; private final map<file, long> lastusagedates = collections.synchronizedmap(new hashmap<file, long>()); /** * @param cachedir directory for file caching. <b>important:</b> specify separate folder for cached files. it's * needed for right cache limit work. * @param sizelimit cache limit value. if cache exceeds this limit then file with the most oldest last usage date * will be deleted. */ public limiteddisccache(file cachedir, int sizelimit) { this(cachedir, defaultconfigurationfactory.createfilenamegenerator(), sizelimit); } /** * @param cachedir directory for file caching. <b>important:</b> specify separate folder for cached files. it's * needed for right cache limit work. * @param filenamegenerator name generator for cached files * @param sizelimit cache limit value. if cache exceeds this limit then file with the most oldest last usage date * will be deleted. */ public limiteddisccache(file cachedir, filenamegenerator filenamegenerator, int sizelimit) { super(cachedir, filenamegenerator); this.sizelimit = sizelimit; cachesize = new atomicinteger(); calculatecachesizeandfillusagemap(); } /** * 另开线程计算cachedir里面文件的大小,并将文件和最后修改的毫秒数加入到map中 */ private void calculatecachesizeandfillusagemap() { new thread(new runnable() { @override public void run() { int size = 0; file[] cachedfiles = cachedir.listfiles(); if (cachedfiles != null) { // rarely but it can happen, don't know why for (file cachedfile : cachedfiles) { //getsize()是一个抽象方法,子类自行实现getsize()的逻辑 size += getsize(cachedfile); //将文件的最后修改时间加入到map中 lastusagedates.put(cachedfile, cachedfile.lastmodified()); } cachesize.set(size); } } }).start(); } /** * 将文件添加到map中,并计算缓存文件的大小是否超过了我们设置的最大缓存数 * 超过了就删除最先加入的那个文件 */ @override public void put(string key, file file) { //要加入文件的大小 int valuesize = getsize(file); //获取当前缓存文件大小总数 int curcachesize = cachesize.get(); //判断是否超过设定的最大缓存值 while (curcachesize + valuesize > sizelimit) { int freedsize = removenext(); if (freedsize == invalid_size) break; // cache is empty (have nothing to delete) curcachesize = cachesize.addandget(-freedsize); } cachesize.addandget(valuesize); long currenttime = system.currenttimemillis(); file.setlastmodified(currenttime); lastusagedates.put(file, currenttime); } /** * 根据key生成文件 */ @override public file get(string key) { file file = super.get(key); long currenttime = system.currenttimemillis(); file.setlastmodified(currenttime); lastusagedates.put(file, currenttime); return file; } /** * 硬盘缓存的清理 */ @override public void clear() { lastusagedates.clear(); cachesize.set(0); super.clear(); } /** * 获取最早加入的缓存文件,并将其删除 */ private int removenext() { if (lastusagedates.isempty()) { return invalid_size; } long oldestusage = null; file mostlongusedfile = null; set<entry<file, long>> entries = lastusagedates.entryset(); synchronized (lastusagedates) { for (entry<file, long> entry : entries) { if (mostlongusedfile == null) { mostlongusedfile = entry.getkey(); oldestusage = entry.getvalue(); } else { long lastvalueusage = entry.getvalue(); if (lastvalueusage < oldestusage) { oldestusage = lastvalueusage; mostlongusedfile = entry.getkey(); } } } } int filesize = 0; if (mostlongusedfile != null) { if (mostlongusedfile.exists()) { filesize = getsize(mostlongusedfile); if (mostlongusedfile.delete()) { lastusagedates.remove(mostlongusedfile); } } else { lastusagedates.remove(mostlongusedfile); } } return filesize; } /** * 抽象方法,获取文件大小 * @param file * @return */ protected abstract int getsize(file file); }
在构造方法中,第69行有一个方法calculatecachesizeandfillusagemap(),该方法是计算cachedir的文件大小,并将文件和文件的最后修改时间加入到map中
然后是将文件加入硬盘缓存的方法put(),在106行判断当前文件的缓存总数加上即将要加入缓存的文件大小是否超过缓存设定值,如果超过了执行removenext()方法,接下来就来看看这个方法的具体实现,150-167中找出最先加入硬盘的文件,169-180中将其从文件硬盘中删除,并返回该文件的大小,删除成功之后成员变量cachesize需要减掉改文件大小。
filecountlimiteddisccache这个类实现逻辑跟totalsizelimiteddisccache是一样的,区别在于getsize()方法,前者返回1,表示为文件数是1,后者返回文件的大小。
等我写完了这篇文章,我才发现filecountlimiteddisccache和totalsizelimiteddisccache在最新的源码中已经删除了,加入了lrudisccache,由于我的是之前的源码,所以我也不改了,大家如果想要了解lrudisccache可以去看最新的源码,我这里就不介绍了,还好内存缓存的没变化,下面分析的是最新的源码中的部分,我们在使用中可以不自行配置硬盘缓存策略,直接用defaultconfigurationfactory中的就行了
我们看defaultconfigurationfactory这个类的creatediskcache()方法
/** * creates default implementation of {@link diskcache} depends on incoming parameters */ public static diskcache creatediskcache(context context, filenamegenerator diskcachefilenamegenerator, long diskcachesize, int diskcachefilecount) { file reservecachedir = createreservediskcachedir(context); if (diskcachesize > 0 || diskcachefilecount > 0) { file individualcachedir = storageutils.getindividualcachedirectory(context); lrudisccache diskcache = new lrudisccache(individualcachedir, diskcachefilenamegenerator, diskcachesize, diskcachefilecount); diskcache.setreservecachedir(reservecachedir); return diskcache; } else { file cachedir = storageutils.getcachedirectory(context); return new unlimiteddisccache(cachedir, reservecachedir, diskcachefilenamegenerator); } }
如果我们在imageloaderconfiguration中配置了diskcachesize和diskcachefilecount,他就使用的是lrudisccache,否则使用的是unlimiteddisccache,在最新的源码中还有一个硬盘缓存类可以配置,那就是limitedagedisccache,可以在imageloaderconfiguration.diskcache(...)配置。
源代码解读
imageview mimageview = (imageview) findviewbyid(r.id.image); string imageurl = "https://lh6.googleusercontent.com/-55osaww3x0q/urquutcfr5i/aaaaaaaaabs/rwlj1rukryi/s1024/a%252520photographer.jpg"; //显示图片的配置 displayimageoptions options = new displayimageoptions.builder() .showimageonloading(r.drawable.ic_stub) .showimageonfail(r.drawable.ic_error) .cacheinmemory(true) .cacheondisk(true) .bitmapconfig(bitmap.config.rgb_565) .build();
imageloader.getinstance().displayimage(imageurl, mimageview, options);
大部分的时候我们都是使用上面的代码去加载图片,我们先看下
public void displayimage(string uri, imageview imageview, displayimageoptions options) { displayimage(uri, new imageviewaware(imageview), options, null, null); }
从上面的代码中,我们可以看出,它会将imageview转换成imageviewaware, imageviewaware主要是做什么的呢?该类主要是将imageview进行一个包装,将imageview的强引用变成弱引用,当内存不足的时候,可以更好的回收imageview对象,还有就是获取imageview的宽度和高度。这使得我们可以根据imageview的宽高去对图片进行一个裁剪,减少内存的使用。
接下来看具体的displayimage方法啦,由于这个方法代码量蛮多的,所以这里我分开来读
checkconfiguration(); if (imageaware == null) { throw new illegalargumentexception(error_wrong_arguments); } if (listener == null) { listener = emptylistener; } if (options == null) { options = configuration.defaultdisplayimageoptions; } if (textutils.isempty(uri)) { engine.canceldisplaytaskfor(imageaware); listener.onloadingstarted(uri, imageaware.getwrappedview()); if (options.shouldshowimageforemptyuri()) { imageaware.setimagedrawable(options.getimageforemptyuri(configuration.resources)); } else { imageaware.setimagedrawable(null); } listener.onloadingcomplete(uri, imageaware.getwrappedview(), null); return; }
第1行代码是检查imageloaderconfiguration是否初始化,这个初始化是在application中进行的
12-21行主要是针对url为空的时候做的处理,第13行代码中,imageloaderengine中存在一个hashmap,用来记录正在加载的任务,加载图片的时候会将imageview的id和图片的url加上尺寸加入到hashmap中,加载完成之后会将其移除,然后将displayimageoptions的imageresforemptyuri的图片设置给imageview,最后回调给imageloadinglistener接口告诉它这次任务完成了。
imagesize targetsize = imagesizeutils.definetargetsizeforview(imageaware, configuration.getmaximagesize()); string memorycachekey = memorycacheutils.generatekey(uri, targetsize); engine.preparedisplaytaskfor(imageaware, memorycachekey); listener.onloadingstarted(uri, imageaware.getwrappedview()); bitmap bmp = configuration.memorycache.get(memorycachekey); if (bmp != null && !bmp.isrecycled()) { l.d(log_load_image_from_memory_cache, memorycachekey); if (options.shouldpostprocess()) { imageloadinginfo imageloadinginfo = new imageloadinginfo(uri, imageaware, targetsize, memorycachekey, options, listener, progresslistener, engine.getlockforuri(uri)); processanddisplayimagetask displaytask = new processanddisplayimagetask(engine, bmp, imageloadinginfo, definehandler(options)); if (options.issyncloading()) { displaytask.run(); } else { engine.submit(displaytask); } } else { options.getdisplayer().display(bmp, imageaware, loadedfrom.memory_cache); listener.onloadingcomplete(uri, imageaware.getwrappedview(), bmp); } }
第1行主要是将imageview的宽高封装成imagesize对象,如果获取imageview的宽高为0,就会使用手机屏幕的宽高作为imageview的宽高,我们在使用listview,gridview去加载图片的时候,第一页获取宽度是0,所以第一页使用的手机的屏幕宽高,后面的获取的都是控件本身的大小了
第7行从内存缓存中获取bitmap对象,我们可以再imageloaderconfiguration中配置内存缓存逻辑,默认使用的是lrumemorycache,这个类我在前面的文章中讲过
第11行中有一个判断,我们如果在displayimageoptions中设置了postprocessor就进入true逻辑,不过默认postprocessor是为null的,bitmapprocessor接口主要是对bitmap进行处理,这个框架并没有给出相对应的实现,如果我们有自己的需求的时候可以自己实现bitmapprocessor接口(比如将图片设置成圆形的)
第22 -23行是将bitmap设置到imageview上面,这里我们可以在displayimageoptions中配置显示需求displayer,默认使用的是simplebitmapdisplayer,直接将bitmap设置到imageview上面,我们可以配置其他的显示逻辑, 他这里提供了fadeinbitmapdisplayer(透明度从0-1)roundedbitmapdisplayer(4个角是圆弧)等, 然后回调到imageloadinglistener接口
if (options.shouldshowimageonloading()) { imageaware.setimagedrawable(options.getimageonloading(configuration.resources)); } else if (options.isresetviewbeforeloading()) { imageaware.setimagedrawable(null); } imageloadinginfo imageloadinginfo = new imageloadinginfo(uri, imageaware, targetsize, memorycachekey, options, listener, progresslistener, engine.getlockforuri(uri)); loadanddisplayimagetask displaytask = new loadanddisplayimagetask(engine, imageloadinginfo, definehandler(options)); if (options.issyncloading()) { displaytask.run(); } else { engine.submit(displaytask); }
这段代码主要是bitmap不在内存缓存,从文件中或者网络里面获取bitmap对象,实例化一个loadanddisplayimagetask对象,loadanddisplayimagetask实现了runnable,如果配置了issyncloading为true, 直接执行loadanddisplayimagetask的run方法,表示同步,默认是false,将loadanddisplayimagetask提交给线程池对象
接下来我们就看loadanddisplayimagetask的run(), 这个类还是蛮复杂的,我们还是一段一段的分析
if (waitifpaused()) return; if (delayifneed()) return;
如果waitifpaused(), delayifneed()返回true的话,直接从run()方法中返回了,不执行下面的逻辑, 接下来我们先看看
waitifpaused() private boolean waitifpaused() { atomicboolean pause = engine.getpause(); if (pause.get()) { synchronized (engine.getpauselock()) { if (pause.get()) { l.d(log_waiting_for_resume, memorycachekey); try { engine.getpauselock().wait(); } catch (interruptedexception e) { l.e(log_task_interrupted, memorycachekey); return true; } l.d(log_resume_after_pause, memorycachekey); } } } return istasknotactual(); }
这个方法是干嘛用呢,主要是我们在使用listview,gridview去加载图片的时候,有时候为了滑动更加的流畅,我们会选择手指在滑动或者猛地一滑动的时候不去加载图片,所以才提出了这么一个方法,那么要怎么用呢? 这里用到了pauseonscrolllistener这个类,使用很简单listview.setonscrolllistener(new pauseonscrolllistener(pauseonscroll, pauseonfling )), pauseonscroll控制我们缓慢滑动listview,gridview是否停止加载图片,pauseonfling 控制猛的滑动listview,gridview是否停止加载图片
除此之外,这个方法的返回值由istasknotactual()决定,我们接着看看istasknotactual()的源码
private boolean istasknotactual() { return isviewcollected() || isviewreused(); }
isviewcollected()是判断我们imageview是否被垃圾回收器回收了,如果回收了,loadanddisplayimagetask方法的run()就直接返回了,isviewreused()判断该imageview是否被重用,被重用run()方法也直接返回,为什么要用isviewreused()方法呢?主要是listview,gridview我们会复用item对象,假如我们先去加载listview,gridview第一页的图片的时候,第一页图片还没有全部加载完我们就快速的滚动,isviewreused()方法就会避免这些不可见的item去加载图片,而直接加载当前界面的图片
reentrantlock loadfromurilock = imageloadinginfo.loadfromurilock; l.d(log_start_display_image_task, memorycachekey); if (loadfromurilock.islocked()) { l.d(log_waiting_for_image_loaded, memorycachekey); } loadfromurilock.lock(); bitmap bmp; try { checktasknotactual(); bmp = configuration.memorycache.get(memorycachekey); if (bmp == null || bmp.isrecycled()) { bmp = tryloadbitmap(); if (bmp == null) return; // listener callback already was fired checktasknotactual(); checktaskinterrupted(); if (options.shouldpreprocess()) { l.d(log_preprocess_image, memorycachekey); bmp = options.getpreprocessor().process(bmp); if (bmp == null) { l.e(error_pre_processor_null, memorycachekey); } } if (bmp != null && options.iscacheinmemory()) { l.d(log_cache_image_in_memory, memorycachekey); configuration.memorycache.put(memorycachekey, bmp); } } else { loadedfrom = loadedfrom.memory_cache; l.d(log_get_image_from_memory_cache_after_waiting, memorycachekey); } if (bmp != null && options.shouldpostprocess()) { l.d(log_postprocess_image, memorycachekey); bmp = options.getpostprocessor().process(bmp); if (bmp == null) { l.e(error_post_processor_null, memorycachekey); } } checktasknotactual(); checktaskinterrupted(); } catch (taskcancelledexception e) { firecancelevent(); return; } finally { loadfromurilock.unlock(); }
第1行代码有一个loadfromurilock,这个是一个锁,获取锁的方法在imageloaderengine类的getlockforuri()方法中
reentrantlock getlockforuri(string uri) { reentrantlock lock = urilocks.get(uri); if (lock == null) { lock = new reentrantlock(); urilocks.put(uri, lock); } return lock; }
从上面可以看出,这个锁对象与图片的url是相互对应的,为什么要这么做?也行你还有点不理解,不知道大家有没有考虑过一个场景,假如在一个listview中,某个item正在获取图片的过程中,而此时我们将这个item滚出界面之后又将其滚进来,滚进来之后如果没有加锁,该item又会去加载一次图片,假设在很短的时间内滚动很频繁,那么就会出现多次去网络上面请求图片,所以这里根据图片的url去对应一个reentrantlock对象,让具有相同url的请求就会在第7行等待,等到这次图片加载完成之后,reentrantlock就被释放,刚刚那些相同url的请求就会继续执行第7行下面的代码
来到第12行,它们会先从内存缓存中获取一遍,如果内存缓存中没有在去执行下面的逻辑,所以reentrantlock的作用就是避免这种情况下重复的去从网络上面请求图片。
第14行的方法tryloadbitmap(),这个方法确实也有点长,我先告诉大家,这里面的逻辑是先从文件缓存中获取有没有bitmap对象,如果没有在去从网络中获取,然后将bitmap保存在文件系统中,我们还是具体分析下
file imagefile = configuration.diskcache.get(uri); if (imagefile != null && imagefile.exists()) { l.d(log_load_image_from_disk_cache, memorycachekey); loadedfrom = loadedfrom.disc_cache; checktasknotactual(); bitmap = decodeimage(scheme.file.wrap(imagefile.getabsolutepath())); }
先判断文件缓存中有没有该文件,如果有的话,直接去调用decodeimage()方法去解码图片,该方法里面调用baseimagedecoder类的decode()方法,根据imageview的宽高,scaletype去裁剪图片,具体的代码我就不介绍了,大家自己去看看,我们接下往下看tryloadbitmap()方法
if (bitmap == null || bitmap.getwidth() <= 0 || bitmap.getheight() <= 0) { l.d(log_load_image_from_network, memorycachekey); loadedfrom = loadedfrom.network; string imageurifordecoding = uri; if (options.iscacheondisk() && trycacheimageondisk()) { imagefile = configuration.diskcache.get(uri); if (imagefile != null) { imageurifordecoding = scheme.file.wrap(imagefile.getabsolutepath()); } } checktasknotactual(); bitmap = decodeimage(imageurifordecoding); if (bitmap == null || bitmap.getwidth() <= 0 || bitmap.getheight() <= 0) { firefailevent(failtype.decoding_error, null); } }
第1行表示从文件缓存中获取的bitmap为null,或者宽高为0,就去网络上面获取bitmap,来到第6行代码是否配置了displayimageoptions的iscacheondisk,表示是否需要将bitmap对象保存在文件系统中,一般我们需要配置为true, 默认是false这个要注意下,然后就是执行trycacheimageondisk()方法,去服务器上面拉取图片并保存在本地文件中
private bitmap decodeimage(string imageuri) throws ioexception { viewscaletype viewscaletype = imageaware.getscaletype(); imagedecodinginfo decodinginfo = new imagedecodinginfo(memorycachekey, imageuri, uri, targetsize, viewscaletype, getdownloader(), options); return decoder.decode(decodinginfo); } /** @return <b>true</b> - if image was downloaded successfully; <b>false</b> - otherwise */ private boolean trycacheimageondisk() throws taskcancelledexception { l.d(log_cache_image_on_disk, memorycachekey); boolean loaded; try { loaded = downloadimage(); if (loaded) { int width = configuration.maximagewidthfordiskcache; int height = configuration.maximageheightfordiskcache; if (width > 0 || height > 0) { l.d(log_resize_cached_image_file, memorycachekey); resizeandsaveimage(width, height); // todo : process boolean result } } } catch (ioexception e) { l.e(e); loaded = false; } return loaded; } private boolean downloadimage() throws ioexception { inputstream is = getdownloader().getstream(uri, options.getextrafordownloader()); return configuration.diskcache.save(uri, is, this); }
第6行的downloadimage()方法是负责下载图片,并将其保持到文件缓存中,将下载保存bitmap的进度回调到ioutils.copylistener接口的onbytescopied(int current, int total)方法中,所以我们可以设置imageloadingprogresslistener接口来获取图片下载保存的进度,这里保存在文件系统中的图片是原图
第16-17行,获取imageloaderconfiguration是否设置保存在文件系统中的图片大小,如果设置了maximagewidthfordiskcache和maximageheightfordiskcache,会调用resizeandsaveimage()方法对图片进行裁剪然后在替换之前的原图,保存裁剪后的图片到文件系统的,之前有同学问过我说这个框架保存在文件系统的图片都是原图,怎么才能保存缩略图,只要在application中实例化imageloaderconfiguration的时候设置maximagewidthfordiskcache和maximageheightfordiskcache就行了
if (bmp == null) return; // listener callback already was fired checktasknotactual(); checktaskinterrupted(); if (options.shouldpreprocess()) { l.d(log_preprocess_image, memorycachekey); bmp = options.getpreprocessor().process(bmp); if (bmp == null) { l.e(error_pre_processor_null, memorycachekey); } } if (bmp != null && options.iscacheinmemory()) { l.d(log_cache_image_in_memory, memorycachekey); configuration.memorycache.put(memorycachekey, bmp); }
接下来这里就简单了,6-12行是否要对bitmap进行处理,这个需要自行实现,14-17就是将图片保存到内存缓存中去
displaybitmaptask displaybitmaptask = new displaybitmaptask(bmp, imageloadinginfo, engine, loadedfrom); runtask(displaybitmaptask, syncloading, handler, engine);
最后这两行代码就是一个显示任务,直接看displaybitmaptask类的run()方法
@override public void run() { if (imageaware.iscollected()) { l.d(log_task_cancelled_imageaware_collected, memorycachekey); listener.onloadingcancelled(imageuri, imageaware.getwrappedview()); } else if (isviewwasreused()) { l.d(log_task_cancelled_imageaware_reused, memorycachekey); listener.onloadingcancelled(imageuri, imageaware.getwrappedview()); } else { l.d(log_display_image_in_imageaware, loadedfrom, memorycachekey); displayer.display(bitmap, imageaware, loadedfrom); engine.canceldisplaytaskfor(imageaware); listener.onloadingcomplete(imageuri, imageaware.getwrappedview(), bitmap); } }
假如imageview被回收了或者被重用了,回调给imageloadinglistener接口,否则就调用bitmapdisplayer去显示bitmap
文章写到这里就已经写完了,不知道大家对这个开源框架有没有进一步的理解,这个开源框架设计也很灵活,用了很多的设计模式,比如建造者模式,装饰模式,代理模式,策略模式等等,这样方便我们去扩展,实现我们想要的功能。
推荐阅读
-
全面解析Android的开源图片框架Universal-Image-Loader
-
全面解析Android的开源图片框架Universal-Image-Loader
-
Android图片加载框架解析之实现带进度的Glide图片加载功能
-
一款好用的android图片缩放查看开源框架photoview的使用。
-
Android图片加载框架解析之Glide的自定义模块功能讲解
-
Android 开源框架Universal-Image-Loader完全解析(三)---源代码解读
-
Android图片加载框架解析之Glide的自定义模块功能讲解
-
Android图片加载框架解析之实现带进度的Glide图片加载功能
-
Android图片加载框架最全解析,实现带进度的Glide图片加载功能
-
Android图片加载框架最全解析(一),Glide的基本用法