142 lines
5.7 KiB
Markdown
142 lines
5.7 KiB
Markdown
# Aria
|
||
</br>
|
||
## [ENGLISH DOC](https://github.com/AriaLyy/Aria/blob/master/ENGLISH_README.md)</br>
|
||
Aria项目源于工作中遇到的一个文件下载管理的需求，当时被下载折磨的痛不欲生，从那时起便萌生了编写一个简单易用，稳当高效的下载框架，aria经历了1.0到3.0的开发，算是越来越接近当初所制定的目标了。
|
||
|
||
Aria有以下特点：
|
||
+ 简单、方便
|
||
- 可以在Activity、Service、Fragment、Dialog、popupWindow、Notification等组件中使用
|
||
- 支持HTTP\FTP断点续传、多任务自动调度
|
||
- 支持HTTP任务组\FTP文件夹，断点续传下载
|
||
- 支持HTTP表单上传
|
||
- 支持文件FTP断点续传上传
|
||
+ 支持https地址下载
|
||
- 在配置文件中很容易就可以设置CA证书的信息
|
||
+ 支持300、301、302重定向下载链接下载
|
||
|
||
[怎样使用Aria?](#使用)
|
||
|
||
如果你觉得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.3.3'
|
||
annotationProcessor 'com.arialyy.aria:aria-compiler:3.3.3'
|
||
```
|
||
|
||
***
|
||
## 使用
|
||
由于Aria涉及到文件和网络的操作，因此需要你在manifest文件中添加以下权限，如果你希望在6.0以上的系统中使用Aria，那么你需要动态向安卓系统申请文件系统读写权限，[如何使用安卓系统权限](https://developer.android.com/training/permissions/index.html?hl=zh-cn)
|
||
```xml
|
||
<uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/>
|
||
<uses-permission android:name="android.permission.INTERNET"/>
|
||
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
|
||
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
|
||
```
|
||
|
||
## 使用Aria
|
||
### 基本使用
|
||
例子为单任务下载，只需要很简单的代码，便可以实现下载功能
|
||
```java
|
||
Aria.download(this)
|
||
.load(DOWNLOAD_URL) //读取下载地址
|
||
.setDownloadPath(DOWNLOAD_PATH) //设置文件保存的完整路径
|
||
.start(); //启动下载
|
||
```
|
||
|
||
### 任务状态的获取
|
||
基于解耦合的考虑，Aria的下载功能是和状态获取相分离的，状态的获取并不会集成到链式代码中，但是Aria提供了另一种更简单更灵活的方案。
|
||
通过注解，你可以很容易获取任务的所有状态。
|
||
|
||
1. 将对象注册到Aria
|
||
```java
|
||
protected void onCreate(Bundle savedInstanceState) {
|
||
super.onCreate(savedInstanceState);
|
||
Aria.download(this).register();
|
||
}
|
||
```
|
||
|
||
2. 通过注解获取任务执行状态
|
||
**注意：**
|
||
- 注解回掉采用Apt的方式实现，所以，你不需要担心这会影响你机器的性能
|
||
- 被注解的方法**不能被private修饰**
|
||
- 被注解的方法**只能有一个参数，并且参数类型必须是`DownloadTask`或`UploadTask`或`DownloadGroupTask`**
|
||
- 方法名可以为任意字符串
|
||
|
||
```java
|
||
//在这里处理任务执行中的状态，如进度进度条的刷新
|
||
@Download.onTaskRunning(DOWNLOAD_URL) protected void running(DownloadTask task) {
|
||
int p = task.getPercent(); //任务进度百分比
|
||
String speed = task.getConvertSpeed(); //转换单位后的下载速度，单位转换需要在配置文件中打开
|
||
String speed1 = task.getSpeed(); //原始byte长度速度
|
||
}
|
||
|
||
@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)
|
||
|
||
### [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)
|
||
|
||
## 混淆配置
|
||
```
|
||
-dontwarn com.arialyy.aria.**
|
||
-keep class com.arialyy.aria.**{*;}
|
||
-keep class **$$DownloadListenerProxy{ *; }
|
||
-keep class **$$UploadListenerProxy{ *; }
|
||
-keep class **$$DownloadGroupListenerProxy{ *; }
|
||
-keepclasseswithmembernames class * {
|
||
@Download.* <methods>;
|
||
@Upload.* <methods>;
|
||
@DownloadGroup.* <methods>;
|
||
}
|
||
|
||
```
|
||
|
||
## 其他
|
||
有任何问题，可以在[issues](https://github.com/AriaLyy/Aria/issues)给我留言反馈。</br>
|
||
在提交问题前，希望你已经查看过[wiki](https://github.com/AriaLyy/Aria/wiki)或搜索过[issues](https://github.com/AriaLyy/Aria/issues)。</br>
|
||
Aria交流群：524329160（加群条件：对aria有过star、commit、issues）
|
||
|
||
***
|
||
|
||
License
|
||
-------
|
||
|
||
Copyright 2016 AriaLyy(https://github.com/AriaLyy/Aria)
|
||
|
||
Licensed under the Apache License, Version 2.0 (the "License");
|
||
you may not use this file except in compliance with the License.
|
||
You may obtain a copy of the License at
|
||
|
||
http://www.apache.org/licenses/LICENSE-2.0
|
||
|
||
Unless required by applicable law or agreed to in writing, software
|
||
distributed under the License is distributed on an "AS IS" BASIS,
|
||
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.
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|