ProgressManager 开源项目教程

1. 项目介绍

项目概述

ProgressManager 是一个开源项目，旨在监听应用程序中所有网络链接的上传和下载进度，包括 Glide 图片加载进度。通过一行代码即可实现对网络请求进度的监听，适用于 Okhttp、Retrofit 和 Glide 等库。

主要功能

• 进度监听：支持对文件下载、上传以及图片加载的进度进行监听。
• 多平台支持：兼容 Okhttp、Retrofit 和 Glide。
• 低耦合：实际请求和进度接收器之间不存在直接或间接的依赖关系。
• 多端同步：支持同一数据源的上传或下载进度在多个端同步更新。

项目特点

• 易用性：只需一行代码即可实现进度监听。
• 低入侵：使用该框架不影响原有代码。
• 自动管理：自动管理监听器，无需手动取消。

2. 项目快速启动

安装步骤

1. 添加依赖：在项目的 build.gradle 文件中添加以下依赖：

   implementation 'me.jessyan:progressmanager:1.5.0'
   

2. 初始化配置：在构建 OkHttpClient 时，通过 ProgressManager 进行初始化配置：

   OkHttpClient okHttpClient = ProgressManager.getInstance().with(new OkHttpClient.Builder()).build();
   

使用示例

下载进度监听

// 添加下载监听
ProgressManager.getInstance().addResponseListener(DOWNLOAD_URL, getDownloadListener());

// 下载监听器
private ProgressListener getDownloadListener() {
    return new ProgressListener() {
        @Override
        public void onProgress(ProgressInfo progressInfo) {
            int progress = progressInfo.getPercent();
            // 更新进度UI
        }

        @Override
        public void onError(long id, Exception e) {
            // 处理错误
        }
    };
}

上传进度监听

// 添加上传监听
ProgressManager.getInstance().addRequestListener(UPLOAD_URL, getUploadListener());

// 上传监听器
private ProgressListener getUploadListener() {
    return new ProgressListener() {
        @Override
        public void onProgress(ProgressInfo progressInfo) {
            int progress = progressInfo.getPercent();
            // 更新进度UI
        }

        @Override
        public void onError(long id, Exception e) {
            // 处理错误
        }
    };
}

Glide 图片加载进度监听

// 添加Glide图片加载监听
ProgressManager.getInstance().addResponseListener(IMAGE_URL, getGlideListener());

// Glide监听器
private ProgressListener getGlideListener() {
    return new ProgressListener() {
        @Override
        public void onProgress(ProgressInfo progressInfo) {
            int progress = progressInfo.getPercent();
            // 更新进度UI
        }

        @Override
        public void onError(long id, Exception e) {
            // 处理错误
        }
    };
}

3. 应用案例和最佳实践

案例一：文件下载进度显示

在文件下载过程中，通过 ProgressManager 监听下载进度，并在 UI 上实时显示下载进度条。

案例二：图片加载进度显示

在图片加载过程中，通过 ProgressManager 监听图片加载进度，并在 UI 上实时显示加载进度条。

最佳实践

• 统一管理：将所有网络请求的进度监听统一管理，避免重复代码。
• 错误处理：在 onError 方法中统一处理网络请求错误，提升用户体验。

4. 典型生态项目

生态项目一：Retrofit

ProgressManager 与 Retrofit 结合使用，可以实现对 Retrofit 网络请求的进度监听。

生态项目二：Glide

ProgressManager 与 Glide 结合使用，可以实现对 Glide 图片加载的进度监听。

生态项目三：Okhttp

ProgressManager 与 Okhttp 结合使用，可以实现对 Okhttp 网络请求的进度监听。

通过以上步骤和案例，您可以快速上手并使用 ProgressManager 实现对网络请求进度的监听。