Glide源码学习八：实现带进度的Glide图片加载功能

Android面试题：Glide

Glide源码学习一：Glide框架介绍、with方法详解

Glide源码学习二：load()详解

Glide源码学习三：into()详解

Glide源码学习四：缓存

Glide源码学习五：回调与监听

Glide源码学习六：图片变换

Glide源码学习七：自定义模块功能

Glide源码学习八：实现带进度的Glide图片加载功能

Glide源码学习九：带你全面了解Glide 4的用法

相关文章：

=====

Android图片加载框架最全解析（七），实现带进度的Glide图片加载功能

扩展目标

====

首先来确立一下功能扩展的目标。虽说Glide本身就已经十分强大了，但是有一个功能却长期以来都不支持，那就是监听下载进度功能。

我们都知道，使用Glide来加载一张网络上的图片是非常简单的，但是让人头疼的是，我们却无从得知当前图片的下载进度。如果这张图片很小的话，那么问题也不大，反正很快就会被加载出来。但如果这是一张比较大的GIF图，用户耐心等了很久结果图片还没显示出来，这个时候你就会觉得下载进度功能是十分有必要的了。

好的，那么我们今天的目标就是对Glide进行功能扩展，使其支持监听图片下载进度的功能。

开始

==

今天这篇文章我会带着大家从零去创建一个新的项目，一步步地进行实现，最终完成一个带进度的Glide图片加载的Demo。当然，在本篇文章的最后我会提供这个Demo的完整源码，但是这里我仍然希望大家能用心跟着我一步步来编写。

那么我们现在就开始吧，首先创建一个新项目，就叫做GlideProgressTest吧。

项目创建完成后的第一件事就是要将必要的依赖库引入到当前的项目当中，目前我们必须要依赖的两个库就是Glide和OkHttp。在app/build.gradle文件当中添加如下配置：

dependencies {

compile ‘com.github.bumptech.glide:glide:3.7.0’

compile ‘com.squareup.okhttp3:okhttp:3.9.0’

}

另外，由于Glide和OkHttp都需要用到网络功能，因此我们还得在AndroidManifest.xml中声明一下网络权限才行：

好了，这样准备工作就完成了。

替换通讯组件

======

通过第二篇文章的源码分析，我们知道了Glide内部HTTP通讯组件的底层实现是基于HttpUrlConnection来进行定制的。但是HttpUrlConnection的可扩展性比较有限，我们在它的基础之上无法实现监听下载进度的功能，因此今天的第一个大动作就是要将Glide中的HTTP通讯组件替换成OkHttp。

关于HTTP通讯组件的替换原理和替换方式，我在第六篇文章当中都介绍得比较清楚了，这里就不再赘述。下面我们就来开始快速地替换一下。

新建一个OkHttpFetcher类，并且实现DataFetcher接口，代码如下所示：

public class OkHttpFetcher implements DataFetcher {

private final OkHttpClient client;

private final GlideUrl url;

private InputStream stream;

private ResponseBody responseBody;

private volatile boolean isCancelled;

public OkHttpFetcher(OkHttpClient client, GlideUrl url) {

this.client = client;

this.url = url;

}

@Override

public InputStream loadData(Priority priority) throws Exception {

Request.Builder requestBuilder = new Request.Builder()

.url(url.toStringUrl());

for (Map.Entry<String, String> headerEntry : url.getHeaders().entrySet()) {

String key = headerEntry.getKey();

requestBuilder.addHeader(key, headerEntry.getValue());

}

Request request = requestBuilder.build();

if (isCancelled) {

return null;

}

Response response = client.newCall(request).execute();

responseBody = response.body();

if (!response.isSuccessful() || responseBody == null) {

throw new IOException("Request failed with code: " + response.code());

}

stream = ContentLengthInputStream.obtain(responseBody.byteStream(),

responseBody.contentLength());

return stream;

}

@Override

public void cleanup() {

try {

if (stream != null) {

stream.close();

}

if (responseBody != null) {

responseBody.close();

}

} catch (IOException e) {

e.printStackTrace();

}

}

@Override

public String getId() {

return url.getCacheKey();

}

@Override

public void cancel() {

isCancelled = true;

}

}

然后新建一个OkHttpGlideUrlLoader类，并且实现ModelLoader

public class OkHttpGlideUrlLoader implements ModelLoader<GlideUrl, InputStream> {

private OkHttpClient okHttpClient;

public static class Factory implements ModelLoaderFactory<GlideUrl, InputStream> {

private OkHttpClient client;

public Factory() {

}

public Factory(OkHttpClient client) {

this.client = client;

}

private synchronized OkHttpClient getOkHttpClient() {

if (client == null) {

client = new OkHttpClient();

}

return client;

}

@Override

public ModelLoader<GlideUrl, InputStream> build(Context context, GenericLoaderFactory factories) {

return new OkHttpGlideUrlLoader(getOkHttpClient());

}

@Override

public void teardown() {

}

}

public OkHttpGlideUrlLoader(OkHttpClient client) {

this.okHttpClient = client;

}

@Override

public DataFetcher getResourceFetcher(GlideUrl model, int width, int height) {

return new OkHttpFetcher(okHttpClient, model);

}

}

接下来，新建一个MyGlideModule类并实现GlideModule接口，然后在registerComponents()方法中将我们刚刚创建的OkHttpGlideUrlLoader和OkHttpFetcher注册到Glide当中，将原来的HTTP通讯组件给替换掉，如下所示：

public class MyGlideModule implements GlideModule {

@Override

public void applyOptions(Context context, GlideBuilder builder) {

}

@Override

public void registerComponents(Context context, Glide glide) {

glide.register(GlideUrl.class, InputStream.class, new OkHttpGlideUrlLoader.Factory());

}

}

最后，为了让Glide能够识别我们自定义的MyGlideModule，还得在AndroidManifest.xml文件当中加入如下配置才行：

…

<meta-data

android:name=“com.example.glideprogresstest.MyGlideModule”

android:value=“GlideModule” />

…

OK，这样我们就把Glide中的HTTP通讯组件成功替换成OkHttp了。

实现下载进度监听

========

那么，将HTTP通讯组件替换成OkHttp之后，我们又该如何去实现监听下载进度的功能呢？这就要依靠OkHttp强大的拦截器机制了。

我们只要向OkHttp中添加一个自定义的拦截器，就可以在拦截器中捕获到整个HTTP的通讯过程，然后加入一些自己的逻辑来计算下载进度，这样就可以实现下载进度监听的功能了。

拦截器属于OkHttp的高级功能，不过即使你之前并没有接触过拦截器，我相信你也能轻松看懂本篇文章的，因为它本身并不难。

确定了实现思路之后，那我们就开始动手吧。首先创建一个没有任何逻辑的空拦截器，新建ProgressInterceptor类并实现Interceptor接口，代码如下所示：

public class ProgressInterceptor implements Interceptor {

@Override

public Response intercept(Chain chain) throws IOException {

Request request = chain.request();

Response response = chain.proceed(request);

return response;

}

}

这个拦截器中我们可以说是什么都没有做。就是拦截到了OkHttp的请求，然后调用proceed()方法去处理这个请求，最终将服务器响应的Response返回。

接下来我们需要启用这个拦截器，修改MyGlideModule中的代码，如下所示：

public class MyGlideModule implements GlideModule {

@Override

public void applyOptions(Context context, GlideBuilder builder) {

}

@Override

public void registerComponents(Context context, Glide glide) {

OkHttpClient.Builder builder = new OkHttpClient.Builder();

builder.addInterceptor(new ProgressInterceptor());

OkHttpClient okHttpClient = builder.build();

glide.register(GlideUrl.class, InputStream.class, new OkHttpGlideUrlLoader.Factory(okHttpClient));

}

}

这里我们创建了一个OkHttpClient.Builder，然后调用addInterceptor()方法将刚才创建的ProgressInterceptor添加进去，最后将构建出来的新OkHttpClient对象传入到OkHttpGlideUrlLoader.Factory中即可。

好的，现在自定义的拦截器已经启用了，接下来就可以开始去实现下载进度监听的具体逻辑了。首先新建一个ProgressListener接口，用于作为进度监听回调的工具，如下所示：

public interface ProgressListener {

void onProgress(int progress);

}

然后我们在ProgressInterceptor中加入注册下载监听和取消注册下载监听的方法。修改ProgressInterceptor中的代码，如下所示：

public class ProgressInterceptor implements Interceptor {

static final Map<String, ProgressListener> LISTENER_MAP = new HashMap<>();

public static void addListener(String url, ProgressListener listener) {

LISTENER_MAP.put(url, listener);

}

public static void removeListener(String url) {

LISTENER_MAP.remove(url);

}

@Override

public Response intercept(Chain chain) throws IOException {

Request request = chain.request();

Response response = chain.proceed(request);

return response;

}

}

可以看到，这里使用了一个Map来保存注册的监听器，Map的键是一个URL地址。之所以要这么做，是因为你可能会使用Glide同时加载很多张图片，而这种情况下，必须要能区分出来每个下载进度的回调到底是对应哪个图片URL地址的。

接下来就要到今天最复杂的部分了，也就是下载进度的具体计算。我们需要新建一个ProgressResponseBody类，并让它继承自OkHttp的ResponseBody，然后在这个类当中去编写具体的监听下载进度的逻辑，代码如下所示：

public class ProgressResponseBody extends ResponseBody {

private static final String TAG = “ProgressResponseBody”;

private BufferedSource bufferedSource;

private ResponseBody responseBody;

private ProgressListener listener;

public ProgressResponseBody(String url, ResponseBody responseBody) {

this.responseBody = responseBody;

listener = ProgressInterceptor.LISTENER_MAP.get(url);

}

@Override

public MediaType contentType() {

return responseBody.contentType();

}

@Override

public long contentLength() {

return responseBody.contentLength();

}

@Override

public BufferedSource source() {

if (bufferedSource == null) {

bufferedSource = Okio.buffer(new ProgressSource(responseBody.source()));

}

return bufferedSource;

}

private class ProgressSource extends ForwardingSource {

long totalBytesRead = 0;

int currentProgress;

ProgressSource(Source source) {

super(source);

}

@Override

public long read(Buffer sink, long byteCount) throws IOException {

long bytesRead = super.read(sink, byteCount);

long fullLength = responseBody.contentLength();

if (bytesRead == -1) {

totalBytesRead = fullLength;

} else {

totalBytesRead += bytesRead;

}

int progress = (int) (100f * totalBytesRead / fullLength);

Log.d(TAG, "download progress is " + progress);

if (listener != null && progress != currentProgress) {

listener.onProgress(progress);

}

if (listener != null && totalBytesRead == fullLength) {

listener = null;

}
自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则近万的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注：Android）

最后

目前已经更新的部分资料：

《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》，点击传送门即可获取！

[外链图片转存中…(img-AQwq9e12-1712275073363)]

[外链图片转存中…(img-PBIUNMkk-1712275073364)]

[外链图片转存中…(img-7RvPLZ5T-1712275073365)]

[外链图片转存中…(img-zhegiDDD-1712275073365)]

[外链图片转存中…(img-1de3rX8M-1712275073366)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注：Android）

最后

目前已经更新的部分资料：

[外链图片转存中…(img-xo7xidkb-1712275073366)]
[外链图片转存中…(img-5IFoiqaO-1712275073366)]
[外链图片转存中…(img-sIwIe36h-1712275073367)]

《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》，点击传送门即可获取！