Glide加入图片加载进度展示

最近一个项目中需要实现图片加载时下载进度百分比的展示。如果使用原始的HttpUrlConnection方式来加载图片的话,实现起来就非常简单了,直接读取InputStream时将进度回调到上层即可。在Glide中有这样的实现方式么?网上查到的都是使用okhttp方式来加载的示例,其实用系统的HttpUrlConnection方式来加载也是能够实现的。

因为Glide并没有直接暴露出下载进度这个信息,需要研究下有没有办法重写掉Glide的图片下载这个流程。很自然的想起Glide有个接口能够重写掉加载的一些过程:
<code>com.bumptech.glide.RequestManager#using(com.bumptech.glide.load.model.stream.StreamModelLoader)</code>
看一下文档中这个方法的定义:

  • Returns a request builder that uses the given {@link com.bumptech.glide.load.model.stream.StreamModelLoader} to* fetch an {@link InputStream} for loading images.

可以通过这个方法重写Glide获取图片的InputStream,完全代理掉网络模块。网上比较多的例子是通过okhttp方式来重写网络模块,但实际用什么网络模块是没有任何关系的。如何实现StreamModelLoader实际上在Glide源码中也有非常多的例子。因为我实现的是单次请求时的网络模块替换,StreamModelLoader中的cache逻辑完全可以不用去理会,关注核心点的接口就行了,简单的实现如下:
<pre>
public class ImageUrlLoader implements StreamModelLoader<GlideUrl> {
private InputStreamReadCallback inputStreamReadCallback;

public ImageUrlLoader(InputStreamReadCallback inputStreamReadCallback) {
    this.inputStreamReadCallback = inputStreamReadCallback;
}

@Override
public DataFetcher<InputStream> getResourceFetcher(GlideUrl model, int width, int height) {
    //这里简单粗暴,直接返回用于获得网络InputStream的DataFetcher。内部才是真正读网络的逻辑,所以将读网络的回调传进去
    return new HttpUrlFetcher(model, inputStreamReadCallback);
}

}
</pre>

HttpUrlFetcher在Glide中有默认实现,我这里的实现跟它提供的没有太多区别,唯一的区别就是将回调传到InputStream中的Wrapper里面去,让读取网络进度时能够将进度回调出来。
<pre>
/**

  • A DataFetcher that retrieves an {@link java.io.InputStream} for a Url.
    */
    public class HttpUrlFetcher implements DataFetcher<InputStream> {
    private static final String TAG = "HttpUrlFetcher";
    private static final int MAXIMUM_REDIRECTS = 5;
    private final GlideUrl glideUrl;
    private HttpURLConnection urlConnection;
    private InputStream stream;
    private volatile boolean isCancelled;
    private InputStreamReadCallback inputStreamReadCallback;
// Visible for testing.
HttpUrlFetcher(GlideUrl glideUrl, InputStreamReadCallback inputStreamReadCallback) {
    this.glideUrl = glideUrl;
    this.inputStreamReadCallback = inputStreamReadCallback;
}

@Override
public InputStream loadData(Priority priority) throws Exception {
    return loadDataWithRedirects(glideUrl.toURL(), 0 /*redirects*/, null /*lastUrl*/, glideUrl.getHeaders());
}

private InputStream loadDataWithRedirects(URL url, int redirects, URL lastUrl, Map<String, String> headers)
        throws IOException {
    if (redirects >= MAXIMUM_REDIRECTS) {
        throw new IOException("Too many (> " + MAXIMUM_REDIRECTS + ") redirects!");
    } else {
        // Comparing the URLs using .equals performs additional network I/O and is generally broken.
        // See http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html.
        try {
            if (lastUrl != null && url.toURI().equals(lastUrl.toURI())) {
                throw new IOException("In re-direct loop");
            }
        } catch (URISyntaxException e) {
            // Do nothing, this is best effort.
        }
    }
    urlConnection = (HttpURLConnection) url.openConnection();
    for (Map.Entry<String, String> headerEntry : headers.entrySet()) {
        urlConnection.addRequestProperty(headerEntry.getKey(), headerEntry.getValue());
    }
    urlConnection.setConnectTimeout(5500);
    urlConnection.setReadTimeout(5500);
    urlConnection.setUseCaches(false);
    urlConnection.setDoInput(true);

    // Connect explicitly to avoid errors in decoders if connection fails.
    urlConnection.connect();
    if (isCancelled) {
        return null;
    }
    final int statusCode = urlConnection.getResponseCode();
    if (statusCode / 100 == 2) {
        return getStreamForSuccessfulRequest(urlConnection, inputStreamReadCallback);
    } else if (statusCode / 100 == 3) {
        String redirectUrlString = urlConnection.getHeaderField("Location");
        if (TextUtils.isEmpty(redirectUrlString)) {
            throw new IOException("Received empty or null redirect url");
        }
        URL redirectUrl = new URL(url, redirectUrlString);
        return loadDataWithRedirects(redirectUrl, redirects + 1, url, headers);
    } else {
        if (statusCode == -1) {
            throw new IOException("Unable to retrieve response code from HttpUrlConnection.");
        }
        throw new IOException("Request failed " + statusCode + ": " + urlConnection.getResponseMessage());
    }
}

private InputStream getStreamForSuccessfulRequest(HttpURLConnection urlConnection, InputStreamReadCallback inputStreamReadCallback)
        throws IOException {
    if (TextUtils.isEmpty(urlConnection.getContentEncoding())) {
        int contentLength = urlConnection.getContentLength();
        //修改这里,对网络返回的InputStream做一个包装,并提供回调的接口
        stream = ContentLengthReadCallbackInputStream.obtain(urlConnection.getInputStream(), contentLength, inputStreamReadCallback);
    } else {
        if (Log.isLoggable(TAG, Log.DEBUG)) {
            Log.d(TAG, "Got non empty content encoding: " + urlConnection.getContentEncoding());
        }
        stream = urlConnection.getInputStream();
    }
    return stream;
}

@Override
public void cleanup() {
    if (stream != null) {
        try {
            stream.close();
        } catch (IOException e) {
            // Ignore
        }
    }
    if (urlConnection != null) {
        urlConnection.disconnect();
    }
}

@Override
public String getId() {
    return glideUrl.getCacheKey();
}

@Override
public void cancel() {
    // TODO: we should consider disconnecting the url connection here, but we can't do so directly because cancel is
    // often called on the main thread.
    isCancelled = true;
}

}
</pre>

InputStream的包装类实现如下:
<pre>
public final class ContentLengthReadCallbackInputStream extends FilterInputStream {
private InputStreamReadCallback readCallback;

private final long contentLength;
private int readSoFar;

public static InputStream obtain(InputStream other, long contentLength, InputStreamReadCallback readCallback) {
    return new ContentLengthReadCallbackInputStream(other, contentLength, readCallback);
}


ContentLengthReadCallbackInputStream(InputStream in, long contentLength, InputStreamReadCallback readCallback) {
    super(in);
    this.readCallback = readCallback;
    this.contentLength = contentLength;
}

@Override
public synchronized int available() throws IOException {
    return (int) Math.max(contentLength - readSoFar, in.available());
}

@Override
public synchronized int read() throws IOException {
    return checkReadSoFarOrThrow(super.read());
}

@Override
public int read(byte[] buffer) throws IOException {
    return read(buffer, 0 /*byteOffset*/, buffer.length /*byteCount*/);
}

@Override
public synchronized int read(byte[] buffer, int byteOffset, int byteCount) throws IOException {
    return checkReadSoFarOrThrow(super.read(buffer, byteOffset, byteCount));
}

private int checkReadSoFarOrThrow(int read) throws IOException {
    if (read >= 0) {
        readSoFar += read;
    } else if (contentLength - readSoFar > 0) {
        throw new IOException("Failed to read all expected data"
                + ", expected: " + contentLength
                + ", but read: " + readSoFar);
    }
    if (readCallback != null) {
        //实际网络读取数和总长度在这里回调到外部
        readCallback.onRead(readSoFar, contentLength);
    }
    return read;
}

}
</pre>

在UI层更新进度时注意下,底层的回调是很快的,UI更新时做个间隔,例如30MS才更新一次不然会很卡的。

<code>Glide.with(context).using(new ImageUrlLoader(this)).load(new GlideUrl(picUrl))</code>通过这种方式就可以愉快的显示图片加载进度了:


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

推荐阅读更多精彩内容