From 21f2124cc27e193038cae3c52aa2cde69eefbbcc Mon Sep 17 00:00:00 2001 From: AriaLyy <511455842@qq.com> Date: Tue, 4 Jul 2017 23:39:13 +0800 Subject: [PATCH] =?UTF-8?q?=E7=BF=BB=E8=AF=91=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 293 +++++++++++++++++++++--------------------------------- 1 file changed, 112 insertions(+), 181 deletions(-) diff --git a/README.md b/README.md index 4d0df592..c9940fbc 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,35 @@ # Aria -![图标](https://github.com/AriaLyy/DownloadUtil/blob/v_2.0/app/src/main/res/mipmap-hdpi/ic_launcher.png)
-Aria项目源于工作中遇到的一个文件下载管理的需求，当时被下载折磨的痛不欲生，从那时起便萌生了编写一个简单易用，稳当高效的下载框架，aria经历了1.0到3.0的开发，算是越来越接近当初所制定的目标了。 - -Aria有以下特点： - + 简单、方便 - - 可以在Activity、Service、Fragment、Dialog、popupWindow、Notification等组件中使用 - - 支持任务自动调度，使用者不需要关心任务状态切换的逻辑 - - [通过Aria的事件，能很容易获取当前下载任务的下载状态](#下载状态获取) - - [一句代码加可以获取当前的下载速度](#常用接口) - - [一句代码就可以动态设置最大下载数](#代码中设置参数) - - [一句代码实现速度限制](#常用接口) - - [通过修改配置文件很容易就能修改下载线程数](#配置文件设置参数) - - [优先下载某一个任务](#常用接口) - - + 支持https地址下载 - - 在配置文件中很容易就可以设置CA证书的信息 - + 支持300、301、302重定向下载链接下载 - + 支持上传操作 - - -Aria怎样使用？ -* [下载](#使用) -* [上传](#上传) - -如果你觉得Aria对你有帮助，您的star和issues将是对我最大支持.`^_^` - -## 下载 +![图标](https://github.com/AriaLyy/DownloadUtil/blob/master/app/src/main/res/mipmap-hdpi/ic_launcher.png)
+ +## [中文文档](https://github.com/AriaLyy/Aria/blob/master/README.md) + +Aria project is from the moment taht the work encountered in a file download management needs adn i was tortured at the time of the pain.
+Since then i have a idea which is to program a simple and easy to use,stable and efficient download framework. +Aria experienced 1.0 to 3.0 development, be more and more close to the original set by the target. + +Aria has the following characteristics： + + simple and convenient + - can be used in Activity, Service, Fragment, Dialog, popupWindow, Notification and other components + - support the task of automatic scheduling, the user does not need to care about the state of the task switch logic + - [Through the Aria event, it is easy to get the download status of the current download task](#Get download status) + - [a code plus can get the current download speed](#Common interface) + - [a code can be dynamically set the maximum number of downloads](#Set the parameters in the code) + - [code to achieve speed limit](#Common interface) + - [It is easy to modify the number of download threads by modifying the configuration file](https://github.com/AriaLyy/Aria/blob/master/app/src/main/assets/aria_config.xml) + - [priority to download a task](#Common interface) + + + Support https address download + - It is easy to set the CA certificate information in the configuration file + + Support 300,301,302 redirect download link download + + Support upload operation + +How do we to use Aria? +* [download](#Using) +* [upload](#Upload) + +If you feel that Aria is helpful to you, your star and issues will be the greatest support for me.`^_^` + +## Download [![Download](https://api.bintray.com/packages/arialyy/maven/AriaApi/images/download.svg)](https://bintray.com/arialyy/maven/AriaApi/_latestVersion) [![Download](https://api.bintray.com/packages/arialyy/maven/AriaCompiler/images/download.svg)](https://bintray.com/arialyy/maven/AriaCompiler/_latestVersion) ```java @@ -33,61 +37,61 @@ compile 'com.arialyy.aria:aria-core:3.2.0' annotationProcessor 'com.arialyy.aria:aria-compiler:3.2.0' ``` -## 示例 -![多任务下载](https://github.com/AriaLyy/DownloadUtil/blob/master/img/download_img.gif) -![网速下载限制](https://github.com/AriaLyy/DownloadUtil/blob/master/img/max_speed.gif) +## For example +![Multi-task download](https://github.com/AriaLyy/DownloadUtil/blob/master/img/download_img.gif) +![download speed limit](https://github.com/AriaLyy/DownloadUtil/blob/master/img/max_speed.gif) -## 性能 -![性能展示](https://github.com/AriaLyy/DownloadUtil/blob/master/img/performance.png) +## performance +![Performance display](https://github.com/AriaLyy/DownloadUtil/blob/master/img/performance.png) *** -## 使用 -由于Aria涉及到文件和网络的操作，因此需要你在manifest文件中添加以下权限 +## Using +Since Aria involves the operation of files and networks, you need to add the following permissions to the manifest file. ```xml ``` -## 使用Aria进行下载 -* 添加任务（不进行下载），当其他下载任务完成时，将自动下载等待中的任务 +## Use Aria to download +* Add a task (do not download), when other download tasks are completed, will automatically download the waiting task ```java Aria.download(this) .load(DOWNLOAD_URL) - .setDownloadPath(DOWNLOAD_PATH) //文件保存路径 + .setDownloadPath(DOWNLOAD_PATH) //file save path .add(); ``` -* 下载 +* download ```java Aria.download(this) - .load(DOWNLOAD_URL) //读取下载地址 - .setDownloadPath(DOWNLOAD_PATH) //设置文件保存的完整路径 - .start(); //启动下载 + .load(DOWNLOAD_URL) //load download url + .setDownloadPath(DOWNLOAD_PATH) //file save path + .start(); //start download ``` -* 暂停 +* Pause ```java Aria.download(this).load(DOWNLOAD_URL).pause(); ``` -* 恢复下载 +* Resume download ```java Aria.download(this).load(DOWNLOAD_URL).resume(); ``` -* 取消下载 +* Cancel download ```java Aria.download(this).load(DOWNLOAD_URL).cancel(); ``` -### 下载状态获取 -如果你希望读取下载进度或下载信息，那么你需要创建事件类，并在onResume(Activity、Fragment)或构造函数(Dialog、PopupWindow)，将该事件类注册到Aria管理器。 +### Get download status +If you want to read the download progress or download the information, then you need to create an event class and register the event class into the Aria manager in the onResume (Activity, Fragment) or constructor (Dialog, PopupWindow). -1. 将对象注册到Aria +1. Register the object to Aria - `Aria.download(this).register();`或`Aria.upload(this).register();` + `Aria.download(this).register();` or `Aria.upload(this).register();` ```java @Override protected void onCreate(Bundle savedInstanceState) { @@ -96,14 +100,14 @@ annotationProcessor 'com.arialyy.aria:aria-compiler:3.2.0' } ``` -2. 使用`@Download`或`@Upload`注解你的函数
- **注意：** - - 注解回掉采用Apt的方式实现，所以，你不需要担心这会影响你机器的性能 - - 被注解的方法**不能被private修饰** - - 被注解的方法**只能有一个参数，并且参数类型必须是`DownloadTask`或`UploadTask`** - - 方法名可以为任意字符串 +2. Use`@Download` or `@Upload` to annotate your function
+ **note：** + - Annotation is done by using `Apt`, so you do not need to worry that this will affect your machine's performance + - The annotated method**can not be modified by private** + - The annotated method**can have only one argument, and the parameter type must be either`DownloadTask` or `UploadTask`** + - Method name can be any string -3. 除了在widget（Activity、Fragment、Dialog、Popupwindow）中使用注解方法外，你还可以在Service、Notification等组件中使用注解函数。 +3. In addition to using annotation methods in widget (Activity, Fragment, Dialog, Popupwindow), you can also use annotation functions in components such as Service, Notification, and so on. ```java @Download.onPre(DOWNLOAD_URL) @@ -134,8 +138,8 @@ annotationProcessor 'com.arialyy.aria:aria-compiler:3.2.0' public void onNoSupportBreakPoint(DownloadTask task) {} ``` -4. 如果你希望对单个任务，或某一些特定任务设置监听器。
- **在注解中添加任务的下载地址，则表示只有该任务才会触发被注解的方法**。 +4. If you want to set up a listener for a single task, or for some specific task.
+ **Adding a download address for a task in an annotation means that only the task triggers the annotated method.** ```java @Download.onTaskRunning({ @@ -145,173 +149,110 @@ annotationProcessor 'com.arialyy.aria:aria-compiler:3.2.0' mAdapter.setProgress(task.getDownloadEntity()); } ``` -在上面的例子中，只有下载地址是`https://test.xx.apk`和`http://test.xx2.apk`才会触发 -`taskRunning(DownloadTask task)`方法。 - -### Aria参数配置 -#### 配置文件设置参数 -创建`aria_config.xml`文件，将其放在`assets`目录下，添加以下内容 -```xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -``` - -#### 代码中设置参数 -除了文件方式外修改Aria参数外，同样的，你也可以在代码中动态修改Aria参数
-通过`Aria.get(this).getDownloadConfig()`或`Aria.get(this).getUploadConfig()`直接获取配置文件，然后修改参数
-如以下所示： +In the above example，only the download address is`https://test.xx.apk` and `http://test.xx2.apk`will trigger the`taskRunning(DownloadTask task)`method。 + +### Aria parameter configuration +#### [Configuration file setting parameters](https://github.com/AriaLyy/Aria/blob/master/app/src/main/assets/aria_config.xml) +#### Set the parameters in the code +In addition to the file mode to modify the Aria parameter, the same, you can also modify the code in the Aria parameters
+Get the configuration file directly through`Aria.get(this).getDownloadConfig()`or`Aria.get(this).getUploadConfig()`
+and then modify the parameters： ```java // 修改最大下载数，调用完成后，立即生效 // 如当前下载任务数是4，修改完成后，当前任务数会被Aria自动调度任务数 Aria.get(this).getDownloadConfig().setMaxTaskNum(3); ``` -### 常用接口 -* 停止所有任务 +### Common interface +* Stop all tasks ```java Aria.download(this).stopAllTask(); ``` -* 恢复所有停止的任务 +* Restore all stopped tasks ```java Aria.download(this).resumeAllTask(); ``` -* 删除所有任务 +* Delete all tasks ```java Aria.download(this).removeAllTask(); ``` -* 最大下载速度限制 +* Maximum download speed limit ```java //单位为 kb Aria.download(this).setMaxSpeed(speed); ``` -* 获取当前任务的下载速度
-速度参数有点特殊，需要[下载事件支持](#下载状态获取) +* Get download speed for current tasks
+Speed parameters a bit special，need to [download the event support](#下载状态获取) ``` java @Override public void onTaskRunning(DownloadTask task) { - //如果你打开了速度单位转换配置，将可以通过以下方法获取带单位的下载速度，如：1 mb/s + //If you turn on the speed unit conversion configuration, you can get the download speed with units in the following ways, such as: 1 mb/s String convertSpeed = task.getConvertSpeed(); - //如果你有自己的单位格式，可以通过以下方法获取原始byte长度 + //If you have your own unit format, you can get the original byte length by the following method long speed = task.getSpeed(); } ``` -* 获取下载的文件大小、当前进度百分比
-同样的，你也可以在DownloadTask对象中获取下载的文件大小 +* Get the downloaded file size, the current progress percentage
+Likewise, you can also get the downloaded file size in the DownloadTask object ``` @Override public void onTaskRunning(DownloadTask task) { -  //获取文件大小 +  //Get the file size long fileSize = task.getFileSize(); - //获取单位转换后的文件大小 + //Get the file size after conversion String fileSize1 = task.getConvertFileSize(); - //当前进度百分比 + //The current percentage of progress int percent = task.getPercent(); } ``` -* 设置高优先级任务
- 如果你希望优先下载某一个任务，你可以 +* Set the high priority task
+ If you want to give priority to download a task, you can ``` java Aria.download(this).load(DOWNLOAD_URL).setDownloadPath(PATH).setHighestPriority(); ``` -* 设置扩展字段
- 有的时候，你可能希望在下载的时候存放一些自己的数据
-**TIP**: 如果你数据比较多，或者数据比较复杂，你可以先把数据转换为**JSON**，然后再将其存到Aria的下载实体中 +* Set the extension field
+ Sometimes, you may want to store some of your own data when you download it
+**TIP**: If you have more data, or the data is more complex, you can first convert the data to JSON, and then save it to Aria's download entity ```java Aria.download(this).load(DOWNLOAD_URL).setExtendField(str) ``` -## 上传 - * 添加任务(只添加，不上传) +## Upload + + * Add a task (add only, do not upload) ```java Aria.upload(this) - .load(filePath) //文件路径 - .setUploadUrl(uploadUrl) //上传路径 - .setAttachment(fileKey) //服务器读取文件的key + .load(filePath) //file path + .setUploadUrl(uploadUrl) // upload the path + .setAttachment(fileKey) //The server reads the file's key .add(); ``` - * 上传 + * Upload ```java Aria.upload(this) - .load(filePath) //文件路径 - .setUploadUrl(uploadUrl) //上传路径 - .setAttachment(fileKey) //服务器读取文件的key + .load(filePath) //file path + .setUploadUrl(uploadUrl) //upload the path + .setAttachment(fileKey) //The server reads the file's key .start(); ``` - * 取消上传 + * cancel upload ```java Aria.upload(this).load(filePath).cancel(); ``` -## 混淆配置 +## Confused configuration ``` -dontwarn com.arialyy.aria.** -keep class com.arialyy.aria.**{*;} @@ -324,8 +265,8 @@ Aria.download(this).load(DOWNLOAD_URL).setExtendField(str) ``` -## 其他 - 有任何问题，可以在[issues](https://github.com/AriaLyy/Aria/issues)给我留言反馈。 +## others + Have any questions that can give me a message in the[issues](https://github.com/AriaLyy/Aria/issues)。 *** @@ -334,26 +275,16 @@ Aria.download(this).load(DOWNLOAD_URL).setExtendField(str) * ~~实现上传队列调度功能~~ -## 开发日志 - + 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配置文件，优化代码 - + v_3.0.3 修复暂停后删除任务，闪退问题，添加删除记录的api - + v_3.0.2 支持30x重定向链接下载 - + v_3.0.0 添加上传任务支持，修复一些已发现的bug - + v_2.4.4 修复不支持断点的下载链接拿不到文件大小的问题 - + v_2.4.3 修复404链接卡顿的问题 - + v_2.4.2 修复失败重试无效的bug - + v_2.4.1 修复下载慢的问题，修复application、service 不能使用的问题 - + v_2.4.0 支持https链接下载 - + v_2.3.8 修复数据错乱的bug、添加fragment支持 - + v_2.3.6 添加dialog、popupWindow支持 - + v_2.3.3 添加断点支持、修改下载逻辑，让使用更加简单、修复一个内存泄露的bug - + v_2.3.1 重命名为Aria，下载流程简化 - + v_2.1.1 增加，选择最大下载任务数接口 +## Development log + + v_3.1.9 Repair the stopAll queue without task when the problem of collapse, increase the function for a single task monitor + + v_3.1.7 repair some files can not download the bug, increase the apt annotation method, the incident is more simple + + v_3.1.6 When the task is canceled ontaskCancel callback twice + + v_3.1.5 Optimize the code structure, increase the priority download task function. + + v_3.1.4 Repair the fast switching, pause, and restore functions, the probability of re-download problems, add onPre () callback, onPre () used to request the interface before the implementation of interface UI update operation. + + v_3.1.0 Add the Aria configuration file to optimize the code + + v_3.0.3 Repair the pause after deleting the task, flashing the problem, add the api to delete the record + + v_3.0.2 supports 30x redirect link download + + v_3.0.0 add upload task support to fix some bugs that have been discovered License -------