|
|
|
|
@ -6,40 +6,30 @@ Aria项目源于工作中遇到的一个文件下载管理的需求，当时被 |
|
|
|
|
Aria有以下特点： |
|
|
|
|
+ 简单、方便 |
|
|
|
|
- 可以在Activity、Service、Fragment、Dialog、popupWindow、Notification等组件中使用 |
|
|
|
|
- 支持任务自动调度，使用者不需要关心任务状态切换的逻辑 |
|
|
|
|
- [通过Aria的事件，能很容易获取当前下载任务的下载状态](#下载状态获取) |
|
|
|
|
- [一句代码加可以获取当前的下载速度](#任务实体常用数据) |
|
|
|
|
- [一句代码就可以动态设置最大下载数](#代码中设置参数) |
|
|
|
|
- [一句代码实现速度限制](#常用接口) |
|
|
|
|
- [通过修改配置文件很容易就能修改下载线程数](#配置文件设置参数) |
|
|
|
|
- [优先下载某一个任务](#常用接口) |
|
|
|
|
- [支持任务组下载，多个任务可共享一个progress](#一组任务下载) |
|
|
|
|
- 一行代码实现HTTP\FTP断线续传、多任务自动调度 |
|
|
|
|
- 一行代码实现HTTP任务组\FTP文件夹下载 |
|
|
|
|
- 一行代码实现HTTP\FTP断点续传上传 |
|
|
|
|
+ 支持https地址下载 |
|
|
|
|
- 在配置文件中很容易就可以设置CA证书的信息 |
|
|
|
|
+ 支持300、301、302重定向下载链接下载 |
|
|
|
|
+ 支持上传操作 |
|
|
|
|
+ 支持FTP断点续传下载、上传 |
|
|
|
|
- [FTP 文件夹下载](#文件夹下载) |
|
|
|
|
- [FTP 单文件下载](#单文件下载) |
|
|
|
|
- [FTP 单文件上传](#单文件上传) |
|
|
|
|
|
|
|
|
|
如果你觉得Aria对你有帮助，您的star和issues将是对我最大支持.`^_^` |
|
|
|
|
[怎样使用Aria?](#使用) |
|
|
|
|
|
|
|
|
|
## 下载 |
|
|
|
|
[](https://bintray.com/arialyy/maven/AriaApi/_latestVersion) |
|
|
|
|
[](https://bintray.com/arialyy/maven/AriaCompiler/_latestVersion) |
|
|
|
|
```java |
|
|
|
|
compile 'com.arialyy.aria:aria-core:3.2.22' |
|
|
|
|
annotationProcessor 'com.arialyy.aria:aria-compiler:3.2.22' |
|
|
|
|
``` |
|
|
|
|
如果你觉得Aria对你有帮助，您的star和issues将是对我最大支持.`^_^` |
|
|
|
|
|
|
|
|
|
## 示例 |
|
|
|
|
 |
|
|
|
|
 |
|
|
|
|
 |
|
|
|
|
|
|
|
|
|
## 性能 |
|
|
|
|
 |
|
|
|
|
|
|
|
|
|
## 下载 |
|
|
|
|
[](https://bintray.com/arialyy/maven/AriaApi/_latestVersion) |
|
|
|
|
[](https://bintray.com/arialyy/maven/AriaCompiler/_latestVersion) |
|
|
|
|
```java |
|
|
|
|
compile 'com.arialyy.aria:aria-core:3.2.25' |
|
|
|
|
annotationProcessor 'com.arialyy.aria:aria-compiler:3.2.25' |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
*** |
|
|
|
|
## 使用 |
|
|
|
|
@ -50,243 +40,54 @@ annotationProcessor 'com.arialyy.aria:aria-compiler:3.2.22' |
|
|
|
|
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/> |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
## 使用Aria进行下载 |
|
|
|
|
### 普通任务下载 |
|
|
|
|
* 下载\恢复下载 |
|
|
|
|
|
|
|
|
|
## 使用Aria |
|
|
|
|
### 基本使用 |
|
|
|
|
例子为单任务下载，只需要很简单的代码，便可以实现下载功能 |
|
|
|
|
```java |
|
|
|
|
Aria.download(this) |
|
|
|
|
.load(DOWNLOAD_URL) //读取下载地址 |
|
|
|
|
.setDownloadPath(DOWNLOAD_PATH) //设置文件保存的完整路径 |
|
|
|
|
.start(); //启动下载 |
|
|
|
|
``` |
|
|
|
|
* 暂停 |
|
|
|
|
|
|
|
|
|
```java |
|
|
|
|
Aria.download(this).load(DOWNLOAD_URL).pause(); |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
* 取消下载 |
|
|
|
|
|
|
|
|
|
```java |
|
|
|
|
Aria.download(this).load(DOWNLOAD_URL).cancel(); |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
### 一组任务下载 |
|
|
|
|
任务组的下载和普通任务的下载基本上差不多，区别在于，任务组下载不需要对每一个子任务设置保存路径，**但是需要设置任务组保存文件夹路径，所有子任务都保存在该文件夹下** |
|
|
|
|
|
|
|
|
|
* 下载\恢复下载 |
|
|
|
|
|
|
|
|
|
```java |
|
|
|
|
Aria.download(this) |
|
|
|
|
.load(urls) //设置一主任务，参数为List<String> |
|
|
|
|
.setDownloadDirPath(groupDirPath) //设置任务组的文件夹路径 |
|
|
|
|
.start(); //启动下载 |
|
|
|
|
``` |
|
|
|
|
* 暂停 |
|
|
|
|
|
|
|
|
|
```java |
|
|
|
|
Aria.download(this).load(urls).pause(); |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
* 取消下载 |
|
|
|
|
|
|
|
|
|
```java |
|
|
|
|
Aria.download(this).load(urls).cancel(); |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
## 上传 |
|
|
|
|
* 添加任务(只添加，不上传) |
|
|
|
|
|
|
|
|
|
```java |
|
|
|
|
Aria.upload(this) |
|
|
|
|
.load(filePath) //文件路径 |
|
|
|
|
.setUploadUrl(uploadUrl) //上传路径 |
|
|
|
|
.setAttachment(fileKey) //服务器读取文件的key |
|
|
|
|
.add(); |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
* 上传 |
|
|
|
|
|
|
|
|
|
```java |
|
|
|
|
Aria.upload(this) |
|
|
|
|
.load(filePath) //文件路径 |
|
|
|
|
.setUploadUrl(uploadUrl) //上传路径 |
|
|
|
|
.setAttachment(fileKey) //服务器读取文件的key |
|
|
|
|
.start(); |
|
|
|
|
``` |
|
|
|
|
* 取消上传 |
|
|
|
|
|
|
|
|
|
```java |
|
|
|
|
Aria.upload(this).load(filePath).cancel(); |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
## FTP |
|
|
|
|
### 单文件下载 |
|
|
|
|
* 开始\恢复下载 |
|
|
|
|
```java |
|
|
|
|
Aria.download(this) |
|
|
|
|
.loadFtp("ftp://172.18.104.129:21/haha/large.rar") |
|
|
|
|
.login("lao", "123456") //登录FTP服务器 |
|
|
|
|
.setDownloadPath("/mnt/sdcard/") //设置文件保存文件夹 |
|
|
|
|
.start(); |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
* 暂停 |
|
|
|
|
```java |
|
|
|
|
Aria.download(this).loadFtp(URL).stop(); |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
* 删除任务 |
|
|
|
|
```java |
|
|
|
|
Aria.download(this).loadFtp(URL).cancel(); |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
### 文件夹下载 |
|
|
|
|
* 开始\恢复下载 |
|
|
|
|
|
|
|
|
|
```java |
|
|
|
|
Aria.download(this) |
|
|
|
|
.loadFtpDir("ftp://172.18.104.129:21/haha/") |
|
|
|
|
.setDownloadDirPath(downloadPath) |
|
|
|
|
.login("lao", "123456") |
|
|
|
|
.start(); |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
* 暂停 |
|
|
|
|
|
|
|
|
|
```java |
|
|
|
|
Aria.download(this).loadFtpDir(dir).stop(); |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
* 删除任务 |
|
|
|
|
|
|
|
|
|
```java |
|
|
|
|
Aria.download(this).loadFtpDir(dir).cancel(); |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
### 单文件上传 |
|
|
|
|
* 开始\恢复上传 |
|
|
|
|
|
|
|
|
|
```java |
|
|
|
|
Aria.upload(this) |
|
|
|
|
.loadFtp("/mnt/sdcard/gggg.apk") //上传文件路径 |
|
|
|
|
.setUploadUrl(URL) //上传的ftp服务器地址 |
|
|
|
|
.login("lao", "123456") |
|
|
|
|
.start(); |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
* 暂停 |
|
|
|
|
|
|
|
|
|
```java |
|
|
|
|
Aria.upload(this).loadFtp(FILE_PATH).stop(); |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
* 删除任务 |
|
|
|
|
|
|
|
|
|
```java |
|
|
|
|
Aria.upload(this).loadFtp(FILE_PATH).cancel(); |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
## 任务状态获取 |
|
|
|
|
如果你希望读取任务进度或任务的信息，那么你需要创建事件类，并在onResume(Activity、Fragment)或构造函数(Dialog、PopupWindow)，将该事件类注册到Aria管理器。 |
|
|
|
|
### 任务状态的获取 |
|
|
|
|
基于解耦合的考虑，Aria的下载功能是和状态获取相分离的，状态的获取并不会集成到链式代码中，但是Aria提供了另一种更简单更灵活的方案。 |
|
|
|
|
通过注解，你可以很容易获取任务的所有状态。 |
|
|
|
|
|
|
|
|
|
1. 将对象注册到Aria |
|
|
|
|
|
|
|
|
|
`Aria.download(this).register();`或`Aria.upload(this).register();` |
|
|
|
|
```java |
|
|
|
|
@Override |
|
|
|
|
protected void onCreate(Bundle savedInstanceState) { |
|
|
|
|
super.onCreate(savedInstanceState); |
|
|
|
|
Aria.download(this).register(); |
|
|
|
|
} |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
2. 使用 `@Download` 或 `@Upload` 或 `@DownloadGroup` 注解你的函数 |
|
|
|
|
|
|
|
|
|
2. 通过注解获取任务执行状态 |
|
|
|
|
**注意：** |
|
|
|
|
- 注解回掉采用Apt的方式实现，所以，你不需要担心这会影响你机器的性能 |
|
|
|
|
- 被注解的方法**不能被private修饰** |
|
|
|
|
- 被注解的方法**只能有一个参数，并且参数类型必须是`DownloadTask`或`UploadTask`或`DownloadGroupTask`** |
|
|
|
|
- 方法名可以为任意字符串 |
|
|
|
|
|
|
|
|
|
3. 除了在widget（Activity、Fragment、Dialog、Popupwindow）中使用注解方法外，你还可以在Service、Notification等组件中使用注解函数。 |
|
|
|
|
|
|
|
|
|
| 注解 | 说明 | 示例 | |
|
|
|
|
| ------| ------ | ------ | |
|
|
|
|
| `@Download.onPre` | 预处理的注解，在任务为开始前回调（一般在此处预处理UI界面） | `@Download.onPre void onPre(DownloadTask task) {}` | |
|
|
|
|
| `@Download.onTaskStart` | 任务开始时的注解，新任务开始时进行回调 | `@Download.onTaskStart void taskStart(DownloadTask task) {}`| |
|
|
|
|
| `@Download.onTaskResume` | 任务恢复时的注解，任务从停止恢复到运行前进行回调 | `@Download.onTaskResume void taskResume(DownloadTask task) {}` | |
|
|
|
|
| ` @Download.onTaskRunning` | 任务执行时的注解，任务正在执行时进行回调 | `@Download.onTaskRunning void running(DownloadTask task) {}` | |
|
|
|
|
| `@Download.onTaskStop` | 任务停止时的注解，任务停止时进行回调 | `@Download.onTaskStop void taskStop(DownloadTask task) {}` | |
|
|
|
|
| `@Download.onTaskCancel` | 任务被删除时的注解，任务被删除时进行回调 | `@Download.onTaskCancel void taskCancel(DownloadTask task) {}` | |
|
|
|
|
| `@Download.onTaskFail` | 任务失败时的注解，任务执行失败时进行回调 | `@Download.onTaskFail void taskFail(DownloadTask task) {}` | |
|
|
|
|
| ` @Download.onTaskComplete` | 任务完成时的注解，任务完成时进行回调 | ` @Download.onTaskComplete void taskComplete(DownloadTask task) {}` | |
|
|
|
|
| `@Download.onNoSupportBreakPoint` | 这是一个特殊的注解，用于处理不支持断点续传的任务 | `@Download.onNoSupportBreakPoint void onNoSupportBreakPoint(DownloadTask task) {}` | |
|
|
|
|
|
|
|
|
|
**TIP：如果你子希望对单个任务，或某一些特定任务设置监听器。** <br> |
|
|
|
|
**在注解中添加任务的下载地址，则表示只有该任务才会触发被注解的方法**。 |
|
|
|
|
|
|
|
|
|
```java |
|
|
|
|
@Download.onTaskRunning({ |
|
|
|
|
"https://test.xx.apk", |
|
|
|
|
"http://test.xx2.apk" |
|
|
|
|
}) void taskRunning(DownloadTask task) { |
|
|
|
|
mAdapter.setProgress(task.getDownloadEntity()); |
|
|
|
|
//在这里处理任务执行中的状态，如进度进度条的刷新 |
|
|
|
|
@Download.onTaskRunning(DOWNLOAD_URL) protected void running(DownloadTask task) { |
|
|
|
|
int p = task.getPercent(); //任务进度百分比 |
|
|
|
|
String speed = task.getConvertSpeed(); //转换单位后的下载速度，单位转换需要在配置文件中打开 |
|
|
|
|
String speed1 = task.getSpeed(); //原始byte长度速度 |
|
|
|
|
} |
|
|
|
|
``` |
|
|
|
|
在上面的例子中，只有下载地址是`https://test.xx.apk`和`http://test.xx2.apk`才会触发 |
|
|
|
|
`taskRunning(DownloadTask task)`方法。 |
|
|
|
|
|
|
|
|
|
## Aria参数配置 |
|
|
|
|
#### 配置文件设置参数 |
|
|
|
|
创建 [aria_config.xml](https://github.com/AriaLyy/Aria/blob/master/app/src/main/assets/aria_config.xml) 文件，将其放在`assets`目录下 |
|
|
|
|
|
|
|
|
|
#### 代码中设置参数 |
|
|
|
|
除了文件方式外修改Aria参数外，同样的，你也可以在代码中动态修改Aria参数</br> |
|
|
|
|
通过`Aria.get(this).getDownloadConfig()`或`Aria.get(this).getUploadConfig()`直接获取配置文件，然后修改参数</br> |
|
|
|
|
如以下所示： |
|
|
|
|
```java |
|
|
|
|
// 修改最大下载数，调用完成后，立即生效 |
|
|
|
|
// 如当前下载任务数是4，修改完成后，当前任务数会被Aria自动调度任务数 |
|
|
|
|
Aria.get(this).getDownloadConfig().setMaxTaskNum(3); |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
### 常用接口 |
|
|
|
|
| api | 说明 | |
|
|
|
|
| ------| ------ | |
|
|
|
|
| `Aria.download(this).stopAllTask();` | 停止所有正在下载的任务 | |
|
|
|
|
| `Aria.download(this).resumeAllTask();` | 恢复所有停止的任务 | |
|
|
|
|
| `Aria.download(this).removeAllTask();` | 删除所有任务</br> 1、如果任务为完成，会删除没有完成的文件</br> 2、如果使用`removeAllTask(true)`方法，会将已经下载完成和未完成的文件删除</br> 3、如果是上传任务，不会删除本地的上传文件，但如果使用`removeAllTask(true)`，同样会删除本地上传文件 | |
|
|
|
|
| `Aria.download(this).setMaxSpeed(speed)` | 限制单个任务的上传、下载的最大速度（单位为 kb） | |
|
|
|
|
| `Aria.download(this).load(DOWNLOAD_URL)`<br>`.setExtendField(str)` | 设置扩展字段，有的时候，你可能希望在下载的时候存放一些自己的数据，这时你可以调用该接口将数据保存下来（如果你数据比较多，或者数据比较复杂，你可以先把数据转换为**JSON**，然后再将其存到Aria的下载实体中） | |
|
|
|
|
| `Aria.download(this).load(DOWNLOAD_URL)`<br>`.getExtendField()` | 获取保存的扩展字段 | |
|
|
|
|
| `Aria.download(this).load(DOWNLOAD_URL)`<br>`.setDownloadPath(PATH).setHighestPriority();` | 将任务设置为最高优先级任务，最高优先级任务有以下特点：<br>1、在下载队列中，有且只有一个最高优先级任务<br> 2、最高优先级任务会一直存在，直到用户手动暂停或任务完成<br>3、任务调度器不会暂停最高优先级任务<br>4、用户手动暂停或任务完成后，第二次重新执行该任务，该命令将失效<br>5、如果下载队列中已经满了，则会停止队尾的任务，当高优先级任务完成后，该队尾任务将自动执行<br>6、把任务设置为最高优先级任务后，将自动执行任务，不需要重新调用start()启动任务 | |
|
|
|
|
|
|
|
|
|
### 任务实体常用数据 |
|
|
|
|
* 获取当前任务的下载速度<br> |
|
|
|
|
速度参数有点特殊，需要[下载事件支持](#下载状态获取) |
|
|
|
|
``` java |
|
|
|
|
@Override public void onTaskRunning(DownloadTask task) { |
|
|
|
|
//如果你打开了速度单位转换配置，将可以通过以下方法获取带单位的下载速度，如：1 mb/s |
|
|
|
|
String convertSpeed = task.getConvertSpeed(); |
|
|
|
|
//如果你有自己的单位格式，可以通过以下方法获取原始byte长度 |
|
|
|
|
long speed = task.getSpeed(); |
|
|
|
|
@Download.onTaskComplete(DOWNLOAD_URL) void taskComplete(DownloadTask task) { |
|
|
|
|
//在这里处理任务完成的状态 |
|
|
|
|
} |
|
|
|
|
``` |
|
|
|
|
[更多注解使用方法](https://github.com/AriaLyy/Aria/wiki/%E6%B3%A8%E8%A7%A3%E4%BD%BF%E7%94%A8) |
|
|
|
|
|
|
|
|
|
* 获取下载的文件大小、当前进度百分比</br> |
|
|
|
|
同样的，你也可以在DownloadTask对象中获取下载的文件大小 |
|
|
|
|
``` |
|
|
|
|
@Override public void onTaskRunning(DownloadTask task) { |
|
|
|
|
//获取文件大小 |
|
|
|
|
long fileSize = task.getFileSize(); |
|
|
|
|
//获取单位转换后的文件大小 |
|
|
|
|
String fileSize1 = task.getConvertFileSize(); |
|
|
|
|
//当前进度百分比 |
|
|
|
|
int percent = task.getPercent(); |
|
|
|
|
} |
|
|
|
|
``` |
|
|
|
|
### [HTTP任务组下载\FTP下载；HTTP\FTP文件上传](https://github.com/AriaLyy/Aria/wiki/Aria%E5%9F%BA%E6%9C%AC%E4%BD%BF%E7%94%A8) |
|
|
|
|
|
|
|
|
|
### [参数配置](https://github.com/AriaLyy/Aria/wiki/Aria%E5%8F%82%E6%95%B0%E9%85%8D%E7%BD%AE) |
|
|
|
|
|
|
|
|
|
### [更多说明，见WIKI](https://github.com/AriaLyy/Aria/wiki) |
|
|
|
|
|
|
|
|
|
## 混淆配置 |
|
|
|
|
``` |
|
|
|
|
@ -309,29 +110,6 @@ Aria.get(this).getDownloadConfig().setMaxTaskNum(3); |
|
|
|
|
|
|
|
|
|
*** |
|
|
|
|
|
|
|
|
|
## 后续版本开发规划 |
|
|
|
|
* ~~代码优化~~ |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## 开发日志 |
|
|
|
|
+ v_3.2.20 修复任务组文件删除，第二次下载进度不准确的问题 |
|
|
|
|
+ v_3.2.18 增加一个刷新文件信息的api接口 |
|
|
|
|
+ v_3.2.17 修复一个版本兼容性问题，线程中使用Aria出错问题 |
|
|
|
|
+ v_3.2.15 修复大型文件分段下载失败的问题，修复中文URL乱码问题 |
|
|
|
|
+ v_3.2.14 修复恢复所有任务的api接口，不能恢复下载组任务的问题 |
|
|
|
|
+ v_3.2.13 修复某些服务器头文件返回描述文件格式错误的问题、修复有时删除任务，需要两次删除的问题 |
|
|
|
|
+ v_3.2.12 实现FTP多线程断点续传下载，FTP断点续传上传功能 |
|
|
|
|
+ v_3.2.9 修复任务组下载完成两次回掉的问题，修复又是获取不到下载状态的问题 |
|
|
|
|
+ v_3.2.8 修复下载超过2G大小的文件失败的问题 |
|
|
|
|
+ v_3.2.7 移除设置文件名的api接口，修复断开网络时出现的进度条错误的问题 |
|
|
|
|
+ v_3.2.6 移除广播事件，增加任务组下载功能 |
|
|
|
|
+ v_3.1.9 修复stopAll队列没有任务时崩溃的问题，增加针对单个任务监听的功能 |
|
|
|
|
+ v_3.1.7 修复某些文件下载不了的bug，增加apt注解方法，事件获取更加简单了 |
|
|
|
|
+ v_3.1.6 取消任务时onTaskCancel回调两次的bug |
|
|
|
|
+ v_3.1.5 优化代码结构，增加优先下载任务功能。 |
|
|
|
|
+ v_3.1.4 修复快速切换，暂停、恢复功能时，概率性出现的重新下载问题，添加onPre()回调，onPre()用于请求地址之前执行界面UI更新操作。 |
|
|
|
|
+ v_3.1.0 添加Aria配置文件，优化代码 |
|
|
|
|
|
|
|
|
|
License |
|
|
|
|
------- |
|
|
|
|
|
|
|
|
|
@ -348,3 +126,13 @@ License |
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
|
|
|
See the License for the specific language governing permissions and |
|
|
|
|
limitations under the License. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
AriaLyy
7 years ago