Flutter 下载器 | flutter_download_manager源码解析

睡觉谁叫

发布于 2023-03-08 20:33:08

9340

发布于 2023-03-08 20:33:08

文章被收录于专栏：Flutter性能监控Flutter性能监控

前言

内容类应用中图片或文件下载，一般应用中应用更新和升级，这些都是经典的下载场景。下载是项目中基础且重要的模块。

从代码逻辑复用性和人力成本考虑，一直想实现一个纯Dart实现的下载库，作为技术储备。

最近发现了一个纯Dart实现的下载库flutter_download_manager,相对来说各方面还算满足需求，支持断点续传，暂停，取消等我比较看重的功能。但是有些地方还需要改进。

话不多说，首先简单介绍下这个库吧。

flutter_download_manager 简介

地址： flutter_download_manager

版本： 0.5.4

特点：

纯 Dart 实现
通过 url 管理下载任务
能够通知状态和进度更改
部分下载功能
队列下载
暂停、取消或恢复下载
并行文件下载（2 个或可以更改）
支持批量下载

支持平台： Linux | MacOS | Windows | Android | iOS

使用方法

简单下载一个文件

var dl = DownloadManager();
var url = "adasdad.com/asda.sdas";
dl.addDownload(url, "./test.sdas");

DownloadTask? task = dl.getDownload(url4);

task?.status.addListener(() {
  print(task.status.value);
});

task?.progress.addListener(() {
  print(task.progress.value);
});

await dl.whenDownloadComplete(url4);

获取下载状态

DownloadTask? task = dl.getDownload(url4);
task?.status.addListener(() {
  print(task.status.value);
});

获取下载进度

DownloadTask? task = dl.getDownload(url4);
task?.progress.addListener(() {
  print(task.progress.value);
});

等待任务完成

DownloadTask? task = dl.getDownload(url4);
await task.whenDownloadComplete();

取消下载任务

var dl = DownloadManager();
dl.cancelDownload(url5);

暂停下载任务

var dl = DownloadManager();
dl.pauseDownload(url5);

恢复下载任务

var dl = DownloadManager();
dl.resumeDownload(url5);

效果展示

Record_2023-02-24-18-20-47_082aea295e0e2b19157fadadca43d2cc.gif

源码解析

类图

任务管理类：DownloadManager

整个核心就类 DownloadManager, 而每个下载任务的抽象是 DownloadTask，所谓 Manager 当然是要管理这些 Task 了。那么如何管理呢？游离的没法管控，只有先找到才能调配，通过 Map 持有 Task 句柄达到“找到”目的，其中_cache 中以<下载 URL,下载任务>方式在内存中缓存每个任务状态；而_queue 则是新添加的下载任务请求，这两者关系后面流程中会具体讲到。

任务的抽象：DownloadTask

重点说下 status 和 progress 字段设计，不论是批量下载还是单任务下载，进度监听不是通过传统传入一个回调给 download 或者 addDownload 来进行的，而是用了系统的 ValueNotifier。笔者考虑这样设计原因是配合 flutter 系统提供的 ValueListenerBuilder 更容易组织 UI。(这样的设计是不是看起来更 Dart)

任务请求抽象：DownloadRequest

重点说下 cancelToken，该字段在暂停，取消，恢复下载任务实现中起了关键作用。像放出去的风筝，想收回时可以收回。怎么收回呢？通过线，这条线的作用就是 cancelToken。而风筝就像是一个个任务请求，放风筝的人就是 Manager，放风筝这件事就是 Task。

每个请求都必须带个 cancelToken，方便取消请求。(不带线的风筝，难道让你上天？)

未标明方法说明

图中 DownloadManager 中方法只写了单任务下载相关方法，批量相关方法差不多就省略了，类似(add | pause | cancel | resume | remove ).BatchDownload 等，最终通过循环执行了单实现的方法。

原理解析

如何管理任务

这里不具体阐述代码流程，为方便理解直接拿生活中惯用做事逻辑举例，代码实现可自行查阅，也是按照这个套路来滴，首先有两个集合：

任务请求列表，里面是想做的事情，每件事情如果非要定义状态的话，可以说是“规划中”。

后续简称任务列表均指请求列表。

任务管理表，里面的事情一般不会去记，在脑子里面。软件开发中，PM 该表格维护者。

完成某任务一般流程如下：

生成一个任务请求表达意愿。
查询任务管理表中任务状态并决定是否有资格真正添加到请求列表。

已完成任务：3 天前已经摸过了一次鱼，一周最多摸鱼一次，直接返回任务结果，否掉这种不切实际的想法，没脸加入请求列表。
未开始任务：一周没玩 lol，可以将游戏添加到请求列表中，并更新到任务管理列表中。
未执行完任务：搬砖上次搬了 50%下周继续搬。此时看你怎么处理了，若 50%的砖还在，你可以继续搬，将任务添加到请求列表，从 50%开始直到完成。若没搬的砖堆得横七竖八不想继续码，可删除任务管理表中记录，当一次新任务添加请求列表和管理列表中。
新规划任务：任务管理列表中无该记录的情况，当新任务重新添加到请求列表中。

循环执行请求列表中各任务并适时更新管理列表中状态，直至请求列表为空。

流程图如下：

如何实现暂停恢复取消

关键是对 DownloadRequest 中 cancelToken 的控制。

暂停任务

恢复任务

取消任务

暂停和取消任务骗谁呢？

一般理解暂停表示之前下载了 50%，恢复后继续从 50%下载；取消表示之前下载 50%点击恢复重头再来。

暂停和取消逻辑除更新状态不一样其他基本一样，是在忽悠我么？

莫慌！在下载时候还有处理呢？

通过上述恢复实现与如下下载中逻辑归纳整个暂停实现流程：

恢复下载中 ③④⑤ 会赋予暂停中 url 新的 CancelToken 重新添加到请求列表中，并开启请求列表的自遍历执行。
请求列表的自遍历执行是给暂停掉 Task 重新执行的机会，Cancel 掉的任务就没法再执行了(下述第 6 行)。
下载过程中如果之前暂停未下载完毕的文件，通过设置 header 中 range:bytes 来实现断点续传,将后续请求到文件存放到.temp中，然后追加到原未下载完成文件后。（下述第 29 行）。

优点和缺点

优点

逻辑复用：Dart 侧支持暂停，取消，恢复，下载流程，一般下载框架会用桥接实现，涉及到多端实现和通用性问题，比较耗人力。要么就是 dio 简单实现下载，没有暂停恢复等实现。
任务管理，一般应用都是单任务下载，没有管理过程。
代码简单明了可读性强，类抽象合理符合单一职责。

缺点

任务管理列表只实现了内存缓存未实现磁盘缓存,应用退出再进入啥都没了。
网络库不支持扩展，太过依赖 dio。

import 'package:dio/dio.dart';

class DownloadRequest {
  var cancelToken = CancelToken();
 }

------------------------------------------------
import 'package:dio/dio.dart';
class DownloadManager {
  var dio = Dio();

Future<void> download(String url, String savePath, cancelToken,
      {forceDownload = false}) async {
//...
if(fileExist){
}else(partialFileExist)
{
   var response = await dio.download(...);
}else{
   var response = await dio.download(...);
}