Aria

Project Url: AriaLyy/Aria
Introduction: 下载可以很简单
More: Author   ReportBugs   
Tags:

图标

ENGLISH DOC

中文文档

Aria 项目源于工作中遇到的一个文件下载管理的需求,当时被下载折磨的痛不欲生,从那时起便萌生了编写一个简单易用,稳当高效的下载框架,aria 经历了 1.0 到 3.0 的开发,算是越来越接近当初所制定的目标了。

Aria 有以下特点:

  • 简单、方便
    • 可以在 Activity、Service、Fragment、Dialog、popupWindow、Notification 等组件中使用
    • 支持 HTTP\FTP 断点续传下载、多任务自动调度
    • 支持多文件打包下载,多文件共享同一进度(如:视频 + 封面 + 字幕)
    • 支持下载 FTP 文件夹
    • 支持 HTTP 表单上传
    • 支持文件 FTP 断点续传上传
    • 支持 FTPS 断点续传,see
    • 支持 SFTP 断点续传,sftp 下载sftp 上传
  • 支持 https 地址下载
    • 在配置文件中很容易就可以设置 CA 证书的信息
  • 支持多线程分块下载,能更有效的发挥机器 IO 性能
  • 支持 300、301、302 重定向下载链接下载
  • 支持 m3u8、hls 协议的文件下载m3u8 下载
  • 支持 m3u8 边下边看的下载支持,点击查看详情
  • 下载支持文件长度动态增加,文件下载初始化时将不再占用过多的内存空间,见动态长度配置

怎样使用 Aria?

如果你觉得 Aria 对你有帮助,你的 star 和 issues 将是对我最大支持,当然,也非常欢迎你能 PR,PR 方法^_^

示例

  • 多任务下载

多任务下载

  • 速度限制

网速下载限制

  • 多文件打包下载

  • m3u8 下载

m3u8 点播文件边下边看

引入库

license Core Compiler FtpComponent FtpComponent M3U8Component

repositories {
  google()
  mavenCentral()
}

dependencies {
  implementation 'me.laoyuyu.aria:core:3.8.16'
  annotationProcessor 'me.laoyuyu.aria:compiler:3.8.16'
  implementation 'me.laoyuyu.aria:ftp:3.8.16' # 如果需要使用 ftp,请增加该组件
  implementation 'me.laoyuyu.aria:sftp:3.8.16' # 如果需要使用 ftp,请增加该组件
  implementation 'me.laoyuyu.aria:m3u8:3.8.16' # 如果需要使用 m3u8 下载功能,请增加该组件
}

如果你使用的是 kotlin,请使用 kotlin 官方提供的方法配置 apt,kotlin kapt 官方配置传送门

⚠️注意:3.5.4 以下版本升级时,需要更新配置文件!!

__⚠️注意:3.8 以上版本已经适配了 AndroidX 和 support 库都可以使用


使用

由于 Aria 涉及到文件和网络的操作,因此需要你在 manifest 文件中添加以下权限,如果你希望在 6.0 以上的系统中使用 Aria,那么你需要动态向安卓系统申请文件系统读写权限,如何使用安卓系统权限

<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.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

使用 Aria

基本使用

例子为单任务下载,只需要很简单的代码,便可以实现下载功能。

  • 创建任务
    long taskId = Aria.download(this)
        .load(DOWNLOAD_URL)     //读取下载地址
        .setFilePath(DOWNLOAD_PATH) //设置文件保存的完整路径
        .create();   //创建并启动下载
    
  • 停止\恢复任务

    Aria.download(this)
        .load(taskId)     //读取任务 id
        .stop();       // 停止任务
        //.resume();    // 恢复任务
    

任务状态的获取

基于解耦合的考虑,Aria 的下载功能是和状态获取相分离的,状态的获取并不会集成到链式代码中,但是 Aria 提供了另一种更简单更灵活的方案。 通过注解,你可以很容易获取任务的所有状态。

  1. 将对象注册到 Aria

    protected void onCreate(Bundle savedInstanceState) {
     super.onCreate(savedInstanceState);
     Aria.download(this).register();
    }
    
  2. 通过注解获取任务执行状态 注意:

    • 注解回掉采用 Apt 的方式实现,所以,你不需要担心这会影响你机器的性能
    • 被注解的方法不能被 private 修饰
    • 被注解的方法只能有一个参数,并且参数类型必须是DownloadTaskUploadTaskDownloadGroupTask
    • 方法名可以为任意字符串
//在这里处理任务执行中的状态,如进度进度条的刷新
@Download.onTaskRunning protected void running(DownloadTask task) {
    if(task.getKey().eques(url)){
        ....
        可以通过 url 判断是否是指定任务的回调
    }
    int p = task.getPercent();    //任务进度百分比
    String speed = task.getConvertSpeed();    //转换单位后的下载速度,单位转换需要在配置文件中打开
       String speed1 = task.getSpeed(); //原始 byte 长度速度
}

@Download.onTaskComplete void taskComplete(DownloadTask task) {
    //在这里处理任务完成的状态
}

文档地址

QQ 群:524329160

版本日志

更多版本记录

混淆配置

-dontwarn com.arialyy.aria.**
-keep class com.arialyy.aria.**{*;}
-keep class **$$DownloadListenerProxy{ *; }
-keep class **$$UploadListenerProxy{ *; }
-keep class **$$DownloadGroupListenerProxy{ *; }
-keep class **$$DGSubListenerProxy{ *; }
-keepclasseswithmembernames class * {
    @Download.* <methods>;
    @Upload.* <methods>;
    @DownloadGroup.* <methods>;
}

感谢

感谢小伙伴们提供的 PR `^_^ DaveBoy liuxiaowei chenfei0928

其他

有任何问题,可以在issues给我留言反馈。
在提交问题前,希望你已经查看过wiki或搜索过issues
我的博客

捐赠

Aria 是作业利用业余时间开发的一个项目,如果你喜欢我写的软件,可以考虑给我捐赠以支持我的工作


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.
Apps
About Me
GitHub: Trinea
Facebook: Dev Tools