Fetch库技术文档

Fetch库技术文档

Fetch The best file downloader library for Android 项目地址: https://gitcode.com/gh_mirrors/fetch/Fetch

安装指南

添加依赖

Fetch库提供了对标准Android环境和AndroidX的支持。要将Fetch添加到您的项目中，请在app/build.gradle的dependencies部分加入以下代码之一：

implementation "com.tonyodev.fetch2:fetch2:3.0.12" // 对于非AndroidX项目
implementation "androidx.tonyodev.fetch2:xfetch2:3.1.6" // 对于AndroidX项目

如果您决定使用OkHttp作为下载客户端，还需要添加对应的依赖：

implementation "com.tonyodev.fetch2okhttp:fetch2okhttp:3.0.12" // 非AndroidX
implementation "androidx.tonyodev.fetch2okhttp:xfetch2okhttp:3.1.6" // AndroidX

并且启用RxJava2集成时使用：

implementation "com.tonyodev.fetch2rx:fetch2rx:3.0.12" // 非AndroidX
implementation "androidx.tonyodev.fetch2rx:xfetch2rx:3.1.6" // AndroidX

权限配置

确保您的应用manifest文件包含必要的权限以支持下载功能：

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>

<!-- 注意：对于Android 6.0（API级别23）及以上版本，需要在运行时请求存储权限 -->
<uses-permission android:name="android.permission.INTERNET"/>

对于Android 6.0以上版本，还需处理运行时权限。

项目使用说明

Fetch是一个简洁、强大且可定制化的Android文件下载管理器，它允许您轻松地执行后台下载任务并控制下载过程。

初始化Fetch

首先，在您的Activity或Application类中初始化Fetch实例，并设置下载并发限制：

FetchConfiguration fetchConfig = new FetchConfiguration.Builder(this)
    .setDownloadConcurrentLimit(3) // 设置最大并发数
    .build();
Fetch fetch = Fetch.Impl.getInstance(fetchConfig);

请求下载

通过创建一个Request对象来发起下载请求：

String downloadUrl = "http://example.com/file.zip";
String localPath = "/path/to/local/file.zip";

Request request = new Request(downloadUrl, localPath);
request.setPriority(Priority.HIGH); // 设置优先级
fetch.enqueue(request, /* 成功回调 */, /* 错误回调 */);

监听下载进度与状态

为了追踪下载的进度和状态，注册一个FetchListener：

fetch.addListener(new FetchListener() {
    // 实现各种状态的监听方法，如onProgress, onCompleted等
});

暂停与恢复下载

使用请求ID操作暂停和恢复下载：

long requestId = request.getId();
fetch.pause(requestId);
...
fetch.resume(requestId);

查询与管理下载

您可以查询所有下载、特定状态的下载或某个组内的下载：

fetch.getDownloads(downloads -> {
    for (Download download : downloads) {
        // 处理每个下载信息
    }
});

API使用文档

Fetch提供的API丰富，涵盖了从下载请求的创建到下载状态监控的整个流程。例如，您可以利用Fetch类的方法直接控制下载的生命周期、查询下载状态、错误处理等。

自定义下载者和服务器

Fetch还支持自定义下载客户端（比如使用OkHttp）以及一个轻量级的TCP文件服务器（FetchFileServer），便于设备间分享文件。

RxFetch特性

若您的应用基于RxJava2，可以通过引入fetch2rx依赖，利用响应式编程的方式管理和监听下载任务，进一步简化异步操作的复杂性。

---

Fetch库通过其强大的功能集合，使得复杂的文件下载任务变得简单易行，无论是基本的下载需求还是高级的定制化场景，都能得到很好的支持。遵循上述文档，即可顺利集成并充分利用Fetch的强大功能。

Fetch The best file downloader library for Android 项目地址: https://gitcode.com/gh_mirrors/fetch/Fetch