一行代码实现android文件下载

作者: dorn19978 | 来源:发表于2017-05-25 09:30 被阅读4527次

起源

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

以下为Aria的使用示例,使用Aria开发图片中的所有功能,只需要很短的时间,很少的代码。

Aria示例

编写布局文件

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent">

  <com.arialyy.simple.widget.HorizontalProgressBarWithNumber
      android:id="@+id/progressBar"
      android:layout_width="wrap_content"
      android:layout_height="20dp"
      android:layout_alignParentLeft="true"
      android:layout_alignParentStart="true"
      android:layout_alignParentTop="true"
      android:layout_margin="16dp"
      android:layout_toLeftOf="@+id/size"
      android:max="100"
      style="?android:attr/progressBarStyleHorizontal"/>

  <TextView
      android:id="@+id/size"
      android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:layout_alignParentRight="true"
      android:layout_alignTop="@+id/progressBar"
      android:layout_marginRight="16dp"
      android:text="0mb"
      android:textSize="16sp"/>

  <LinearLayout
      android:id="@+id/handle_bar"
      android:layout_width="match_parent"
      android:layout_height="wrap_content"
      android:layout_below="@+id/progressBar"
      android:orientation="horizontal">

    <TextView
        android:id="@+id/speed"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginLeft="16dp"
        android:text="0kb/s"
        android:textColor="@android:color/black"/>

    <Button
        android:id="@+id/start"
        android:layout_width="0dp"
        android:layout_height="wrap_content"
        android:layout_weight="1"
        android:onClick="onClick"
        android:text="开始"
        style="?buttonBarButtonStyle"/>

    <Button
        android:id="@+id/stop"
        android:layout_width="0dp"
        android:layout_height="wrap_content"
        android:layout_weight="1"
        android:onClick="onClick"
        android:text="暂停"
        style="?buttonBarButtonStyle"/>

    <Button
        android:id="@+id/cancel"
        android:layout_width="0dp"
        android:layout_height="wrap_content"
        android:layout_weight="1"
        android:onClick="onClick"
        android:text="删除任务"
        style="?buttonBarButtonStyle"/>
  </LinearLayout>

</RelativeLayout>

调用Aria的api进行下载

@OnClick({ R.id.start, R.id.stop, R.id.cancel }) public void onClick(View view) {
   switch (view.getId()) {
     case R.id.start:
       Aria.download(this)
           .load(DOWNLOAD_URL)
           .setDownloadPath(Environment.getExternalStorageDirectory().getPath() + "/test.apk")
           .start();
       break;
     case R.id.stop:
       Aria.download(this).load(DOWNLOAD_URL).pause();
       break;
     case R.id.cancel:
       Aria.download(this).load(DOWNLOAD_URL).cancel();
       break;
   }
 }

在Aria的下载模块中,下载链接为下载任务的唯一标识符,控制一个任务的开始、暂停、恢复、取消下载等操作都需要DOWNLOAD_URL支持。
另外,在Aira中,可以调用start()方法开始下载或恢复下载。
为了方便起见,你也可以调用Aria.download(this).load(DOWNLOAD_URL).resume();实现恢复下载。

Aria 提供了大量的API,除了以上几个常用的API外,你还可以Aria Api;

下载事件的获取

在上文中,我们已经实现在android中下载文件的操作,是的,使用Aria,一行代码你就能实现复杂的断点续传功能。
除了正常的文件需求外,有的时候,我们还需要获取文件的下载状态用来更新界面的显示。
Aria中,使用Aria的事件监听器,你能很容易的获取到你想要的很多事件,如:

  • 暂停、恢复、完成、失败、取消下载等状态
  • 一句代码获取当前任务的下载速度
  • 一句代码获取当前任务的进度的百分比
  • 一句代码获取当前任务的的文件大小
  • 使用注解实现事件监听
    ...
@Download.onPre(DOWNLOAD_URL) protected void onPre(DownloadTask task) {
    mUpdateHandler.obtainMessage(DOWNLOAD_PRE, task.getDownloadEntity().getFileSize())
        .sendToTarget();
  }

  @Download.onTaskStart(DOWNLOAD_URL) void taskStart(DownloadTask task) {
    mUpdateHandler.obtainMessage(DOWNLOAD_START, task.getDownloadEntity().getFileSize())
        .sendToTarget();
  }

  @Download.onTaskRunning(DOWNLOAD_URL) protected void running(DownloadTask task) {
    mUpdateHandler.obtainMessage(DOWNLOAD_RUNNING, task).sendToTarget();
  }

  @Download.onTaskResume(DOWNLOAD_URL) void taskResume(DownloadTask task) {
    mUpdateHandler.obtainMessage(DOWNLOAD_START, task.getFileSize()).sendToTarget();
  }

  @Download.onTaskStop(DOWNLOAD_URL) void taskStop(DownloadTask task) {
    L.d(TAG, "task__stop");
  }

  @Download.onTaskComplete(DOWNLOAD_URL) void taskComplete(DownloadTask task) {
    mUpdateHandler.sendEmptyMessage(DOWNLOAD_COMPLETE);
  }

上文只列出了常见的下载事件,更多的下载状态事件见Aria下载事件监听器说明

在Aria中注册新创建的事件监听器

上文中,已经创建完了事件监听器,这时,事件监听器还没能生效,你还需要将事件监听器注册到Aria中

 @Override protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    Aria.download(this).register();
  }

最终效果

最终效果

final

以上,便是使用Aria进行文件下载的所有代码了,总的来说,Aria真的很简单。
很少的代码,你就能实现复杂的文件多线程断点续传功能,除此之外,Aria还支持多线程的配置,使用多少线程下载一个文件,由你决定,具体见多线程配置
Aria默认支持任务自动调度,从此,你再也不需要关心任务的暂停、恢复、完成、失败、取消等状态的调度。

Aria下载地址

本文demo下载地址

相关文章

网友评论

  • 痴迷_d6b5:这个框架可以下载zip压缩包吗楼主
  • 78d9f430022d:你好,请教下如果是多个文件下载,该怎么监听全部文件下载已经完成了?

    我在onCreate方法中添加了 Aria.download(this).register();

    然后调用 Aria.download(this).loadGroup(urls).setDirPath(path).start();可以下载文件

    但是没办法监听已经完成了,因为我的文件是压缩文件,在本地还需要解压

    @Download.onTaskComplete void taskComplete(DownloadTask task) {
    //在这里处理任务完成的状态
    }
    这个方法没有效果 不知道该怎么获取监听呢?
  • zero_4e7b:支持线程池管理、断点续传、下载完成校验、控制下载中断
    https://github.com/zerochl/ClassisDownload
  • 4b50080c967c:下载完成的监听会监听到其他下载的完成,这是怎么回事
    dorn19978:https://github.com/AriaLyy/Aria/wiki/%E6%B3%A8%E8%A7%A3%E4%BD%BF%E7%94%A8#%E6%B3%A8%E6%84%8F%E4%BA%8B%E9%A1%B9

    或者通过task获取下载地址,然后判断是否是希望监听的任务
  • AUL:下载了 demo toast 提示为 下载失败.... 按照文章中的注解方法同样是这样的原因 ...该怎么解决啊
    5cfe1478b05c:老板,救救我,我ViewPage配合Fragment,Fragment内是RecyclerView,,然后ViewPager里面的多个页面是同一个fragment,在接收回调的时候,在回调方法里面操作当前fragment内的变量,调到的竟然是position为0的那个fragment里面的那个变量的值,而不是当前fragment的值,这种问题怎么解决,是不是aria生成代理文件的时候只生成一个,所以调的时候都是调那个页面的值
    eaaf3d89035a:@Wanyummys 我也遇到和你一样的问题,能说一下是什么原因吗?
    AUL:抱歉...知道原因了...:relaxed:
  • 锋子Q:可以下载,但是我注解的监听onTaskRunning进度没效果,方法断点都进不去。
    dorn19978:使用3.2.0以上的版本
  • Mrbrent:请问怎Service 中怎么监听下载进度
    dorn19978:https://github.com/AriaLyy/Aria#下载状态获取
  • 羽落_d660:为啥我把你的下载地址 换成我们公司服务器的下载地址 就提示 任务【http://ryjz.4pole.cn/upload/software/20170613/6246b45cd338cb07ea77ad1da6e2a302.mp4】下载失败,文件长度小于0
    羽落_d660:@AriaLyy 用 addHeader("Accept-Encoding", "identity").这个 方法解决了 换成3.18版本的 提示 Could not find com.arialyy.aria:Aria:3.1.8.
    羽落_d660: @AriaLyy OK 明天我再去公司试试 谢谢啦😀
    dorn19978:请看这个issues
    https://github.com/AriaLyy/Aria/issues/36
    也可以使用3.1.8版本来处理该bug
  • 木子而东:你家网速好好啊
    dorn19978:一般吧,公司的百兆网10m/s。。
  • ZZZ_Hero:真的好强大,好方便,学习了
    dorn19978:@小拉布的大姐姐 对啊:smiley::smiley:
    ZZZ_Hero:@AriaLyy 这是您自己封装的方法吗,很厉害也,谢谢提供这么好的资源
    dorn19978:谢谢支持:smiley:
  • 程序猿isMe:支持recycleView列表的多任务下载吗?
    dorn19978:@程序猿isMe 支持,app里面,多任务下载使用的九十RecycleView,个人建议对于下载列表,RecycleView的性能明显优于ListView,因为RecycleView可以很容易只更新一个Item,并且RecycleView不容易出现错位问题
  • c616d8a992ee:我导入依赖了但是 com.arialyy.simple.widget.HorizontalProgressBarWithNumber progressBar; 在代码中这个包找不到啊 怎么解决一下
    dorn19978:HorizontalProgressBarWithNumber 是鸿洋写的一个自定义控件,我只是在例子代码中使用它而已..
    如果你也希望使用这个控件,可以看这个地址:http://blog.csdn.net/lmj623565791/article/details/43371299
  • c616d8a992ee:今天可以打开了
  • c616d8a992ee:下载不了:sweat:
    e0e874b66c76:注解无效:检查下你的工程中有没有使用apply plugin: 'android-apt',如果有的话将其转换为annotationProcessor。
    检查下annotationProcessor 和 compile 版本是否一致,不一致的话对导致生成代理文件失败
    如果你是Android studio的module中引用的Aria,那么你还需要再app模块中添加同样的导入代码
    dorn19978:github 应该又被天朝给屏蔽了,建议使用科学上网:cold_sweat:
  • c616d8a992ee:打不开GitHub 大哥
  • 乘风破浪的程序员:楼主,可以断点续传么
    dorn19978:支持的,stop就是暂停,start()、resume()分别为开始或恢复下载
  • 菜鸟程序员_:🙄🙄早点看到多好,之前在公司写下载模块搞了整整一天😪
    dorn19978:淡定,当年我也被下载折磨过:grin:
  • glhmtech:学习啦
    dorn19978:@glhmtech :blush:

本文标题:一行代码实现android文件下载

本文链接:https://www.haomeiwen.com/subject/zokoxxtx.html