Universal-Image-Loader源码解析(1)总体框架

Universal-Image-Loader(以下简称UIL)这个Android的图片加载库年代已经比较久远了,现在作者也不更新了,不过使用的人还是很多,源码还是值得一看的。我打算分几章来分析一下UIL的源码。第一章就先介绍一下总体框架。

整体流程

首先借用官方的一张图看看UIL加载图片的流程,这对后续的分析起到一定的指导作用,大家可以将各个模块按照这幅流程图对号入座,这样就对模块的整体功能一目了然了。

Class Diagram-Overview.jpg

整体类图

UIL的使用方法这里就不介绍了,网上的教程很多。这里直接开始看看整体类图。

Class Diagram-Overview.jpg

类图里只画出了最重要的一些类和接口。下面我就针对这些类做一些大概的说明,详细的介绍在后续章节里奉上。

ImageLoader

ImageLoade在UIL中相当于指挥官的角色。大部分加载图片的功能都只需要用到这一个类就够了。比如:

ImageLoader imageLoader = ImageLoader.getInstance(); // Get singleton instance
imageLoader.displayImage(imageUri, imageView);

就是这样简单,只需要ImageLoader 一个类以及图片的uri和ImageView两个参数就够了。
ImageLoader 用的是单例模式,它里面重写了多个displayImage和loadImage方法。displayImage方法用来将图片展示在ImageView上,loadImage只是加载图片而不展示。所有加载图片的操作都是通过ImageLoader 的这两类方法完成的。
ImageLoader里包含一个ImageLoaderConfiguration对象,这个对象通过init方法传入。ImageLoaderConfiguration就是一些UIL的配置,它使用了Builder模式来创建,比较简单,略过。

public synchronized void init(ImageLoaderConfiguration configuration) {
        if (configuration == null) {
            throw new IllegalArgumentException(ERROR_INIT_CONFIG_WITH_NULL);
        }
        if (this.configuration == null) {
            L.d(LOG_INIT_CONFIG);
            engine = new ImageLoaderEngine(configuration);
            this.configuration = configuration;
        } else {
            L.w(WARNING_RE_INIT_CONFIG);
        }
    }

在init方法中还创建了ImageLoaderEngine这个类。这个类比较重要,正如它名字所描述的那样,它就是UIL的任务引擎。ImageLoader加载图片的逻辑是先判断MemoryCache中有没有缓存的图片,如果有且不需要后处理,就直接显示,需要处理就创建ProcessAndDisplayImageTask,然后提交到Engine。如果没有就创建LoadAndDisplayImageTask,然后提交到Engine中执行的。下面是displayImage方法的一个片段。

Bitmap bmp = configuration.memoryCache.get(memoryCacheKey);
        if (bmp != null && !bmp.isRecycled()) {
            ...

            if (options.shouldPostProcess()) {
                ...
                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);
                ...
            }
        } else {
            ...
            LoadAndDisplayImageTask displayTask = new LoadAndDisplayImageTask(engine, imageLoadingInfo,
                    defineHandler(options));
            if (options.isSyncLoading()) {
                displayTask.run();
            } else {
                engine.submit(displayTask);
            }
        }

ImageLoaderEngine

从类图中可以看到,有两类Task会提交到Engine中执行,他们分别是ProcessAndDisplayImageTask和LoadAndDisplayImageTask。ProcessAndDisplayImageTask的任务是加载图片并做后处理后显示图片,LoadAndDisplayImageTask只是单纯的加载和显示图片。
在类图中还有一个类:DisplayBitmapTask。它的任务就是显示图片。但在Engine中并没有一个submit方法是用来提交DisplayBitmapTask的。这个类其实是在前两个Task类的Run方法中用来加载图片的。补充一句,这三种Task都实现了Runnable接口。
Engine执行Task是提交到Executor中执行的。(Executor的知识请查阅Java文档)看一下代码片段:

private Executor taskExecutor;
private Executor taskExecutorForCachedImages;
private Executor taskDistributor;

一共有三个Executor。

void submit(final LoadAndDisplayImageTask task) {
        taskDistributor.execute(new Runnable() {
            @Override
            public void run() {
                File image = configuration.diskCache.get(task.getLoadingUri());
                boolean isImageCachedOnDisk = image != null && image.exists();
                initExecutorsIfNeed();
                if (isImageCachedOnDisk) {
                    taskExecutorForCachedImages.execute(task);
                } else {
                    taskExecutor.execute(task);
                }
            }
        });
    }

taskDistributor对Task进行分发。已经缓存在Disk上的图片就交给taskExecutorForCachedImages执行,没有缓存的就交给taskExecutor。

BitmapDisplayer和ImageAware

这是两个接口。他们都和显示图片相关。

 
public interface BitmapDisplayer {
    /**
     *
     * @param bitmap     Source bitmap
     * @param imageAware {@linkplain com.nostra13.universalimageloader.core.imageaware.ImageAware Image aware view} to
     *                   display Bitmap
     * @param loadedFrom Source of loaded image
     */
    void display(Bitmap bitmap, ImageAware imageAware, LoadedFrom loadedFrom);
}
public interface ImageAware {
    int getWidth();
    int getHeight();
    ViewScaleType getScaleType();
    View getWrappedView();
    boolean isCollected();
    int getId();

    boolean setImageDrawable(Drawable drawable);

    boolean setImageBitmap(Bitmap bitmap);
}

将图片的显示分成两个接口体现出了mvc的思想。BitmapDisplayer负责处理图片数据:Bitmap,ImageAware负责显示。BitmapDisplayer的实现类有:CircleBitmapDisplayer, FadeInBitmapDisplayer, RoundedBitmapDisplayer, RoundedVignetteBitmapDisplayer, SimpleBitmapDisplayer。从这些名字就基本可以看出这些类的功能。比如CircleBitmapDisplayer:

public class CircleBitmapDisplayer implements BitmapDisplayer {
    ...
    @Override
    public void display(Bitmap bitmap, ImageAware imageAware, LoadedFrom loadedFrom) {
        if (!(imageAware instanceof ImageViewAware)) {
            throw new IllegalArgumentException("ImageAware should wrap ImageView. ImageViewAware is expected.");
        }

        imageAware.setImageDrawable(new CircleDrawable(bitmap, strokeColor, strokeWidth));
    }

    public static class CircleDrawable extends Drawable {
        ...
        @Override
        public void draw(Canvas canvas) {
            canvas.drawCircle(radius, radius, radius, paint);
            if (strokePaint != null) {
                canvas.drawCircle(radius, radius, strokeRadius, strokePaint);
            }
        }
        ...
    }
}

它的功能就是在将原始图片变为圆形且有个圆圈的Drawable。
ImageAware的直接实现只有一个类:ViewAware。我们从ImageAware的接口总可以看出,它只是提供一些显示图片的基本数据,应该是View的一个封装。ViewAware就印证了这种想法。其中一点比较重要的是ViewAware使用了弱引用来封装View。

public abstract class ViewAware implements ImageAware {
    ...
    protected Reference<View> viewRef;
    ...
}

ViewAware的子类有两个ImageViewAware和NonViewAware。ImageViewAware就是ImageView的封装。它用ImageView来显示图片。当我们调用各种displayImage方法时,最终都会用ImageViewAware来显示图片。

@Override
    protected void setImageDrawableInto(Drawable drawable, View view) {
        ((ImageView) view).setImageDrawable(drawable);
        if (drawable instanceof AnimationDrawable) {
            ((AnimationDrawable)drawable).start();
        }
    }

    @Override
    protected void setImageBitmapInto(Bitmap bitmap, View view) {
        ((ImageView) view).setImageBitmap(bitmap);
    }

ImageViewAware简单的将显示图片的任务交给了ImageView。

NonViewAware里面封装的View为null,当调用loadImage方法时,最终都会用到NonViewAware。

    @Override
    public boolean setImageDrawable(Drawable drawable) { // Do nothing
        return true;
    }

    @Override
    public boolean setImageBitmap(Bitmap bitmap) { // Do nothing
        return true;
    }

因为loadImage只是为了获取图片数据,而不用显示,所以NonViewAware的setImageDrawable和setImageBitmap只是简单的返回true。

MemoryCache和DiskCache

图片的缓存就在这里了。后面的章节会详细介绍,这里略过。

总结

UIL的整体结构还是很清晰的。下面是包图,基本上主要的内容在上面都介绍过了。对某一方面有兴趣的朋友可以去相关包下面查看源码。


packages.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 156,907评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,546评论 1 289
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,705评论 0 238
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,624评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,940评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,371评论 1 210
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,672评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,396评论 0 195
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,069评论 1 238
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,350评论 2 242
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,876评论 1 256
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,243评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,847评论 3 231
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,004评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,755评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,378评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,266评论 2 259

推荐阅读更多精彩内容