一行代码实现 android 文件下载

6,032 阅读3分钟
原文链接: www.jianshu.com

起源

本文主要介绍开源项目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的事件监听器,你能很容易的获取到你想要的很多事件,如:

  • 暂停、恢复、完成、失败、取消下载等状态
  • 一句代码获取当前任务的下载速度
  • 一句代码获取当前任务的进度的百分比
  • 一句代码获取当前任务的的文件大小...

    private class MySchedulerListener extends Aria.DownloadSchedulerListener {
    
      @Override public void onTaskStart(DownloadTask task) {
        mSize.setText(task.getConvertFileSize());
      }
    
      @Override public void onTaskStop(DownloadTask task) {
        Toast.makeText(MainActivity.this, "停止下载", Toast.LENGTH_SHORT).show();
      }
    
      @Override public void onTaskCancel(DownloadTask task) {
        Toast.makeText(MainActivity.this, "取消下载", Toast.LENGTH_SHORT).show();
      }
    
      @Override public void onTaskFail(DownloadTask task) {
        Toast.makeText(MainActivity.this, "下载失败", Toast.LENGTH_SHORT).show();
      }
    
      @Override public void onTaskComplete(DownloadTask task) {
        Toast.makeText(MainActivity.this, "下载完成", Toast.LENGTH_SHORT).show();
      }
    
      @Override public void onTaskRunning(DownloadTask task) {
        //使用转换单位后的速度,需要在aria_config.xml配置文件中将单位转换开关打开
        //https://github.com/AriaLyy/Aria#配置文件设置参数
        mSpeed.setText(task.getConvertSpeed());
        mPb.setProgress(task.getPercent());
      }
    }

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

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

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

@Override protected void onResume() {
    super.onResume();
    Aria.download(this).addSchedulerListener(new MySchedulerListener());
  }

最终效果


最终效果

final

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

Aria下载地址

本文demo下载地址