FreeLoad 下载库

发表于   |   分类于   |  

Freeload 是一款下载引擎。通过它你可以很方便的添加下载任务，并且实时获取下载过程。该引擎轻巧易于维护，并且拥有很好的扩展性。在新版的引擎中添加了多线程下载单资源的支持，能够支持双线程、三线程甚至四线程同步下载单资源。使用上支持链式编程，让代码编辑更加合理。

概括

Freeload 是一款下载引擎。通过它你可以很方便的添加下载任务，并且实时获取下载过程。该引擎轻巧易于维护，并且拥有很好的扩展性。在新版的引擎中添加了多线程下载单资源的支持，能够支持双线程、三线程甚至四线程同步下载单资源。使用上支持链式编程，让代码编辑更加合理。

使用说明

1、创建下载请求队列

1
2
private RequestQueue requestQueue = null;
requestQueue = Freeload.newRequestQueue(context);

2、创建下载请求并将下载请求添加到下载队列里

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
private DownloadManager request = null;
// 创建监听回调
request = DownloadManager.create()
    .setDownloadId(1)
    .setDownloadUrl(downloadUrl)
    .setDownloadThreadType(DownloadThreadType.DOUBLETHREAD)
    .setPepareListener(new Response.PepareListener<IReceipt>() {
        @Override
        public void onProgressPepare(IReceipt s) {
            receipt = s.getReceipt();
            System.out.println(receipt);
        }
    })
    .setListener(new Response.Listener<IReceipt>() {
        @Override
        public void onProgressChange(IReceipt s) {
            System.out.println(s.getReceipt());
        }
    })
    .addRequestQueue(requestQueue);
  1. DownloadRequestManager.create(id, Url)创建一个DownloadRequestManager对象，参数为下载的id和下载的url。
  2. setDownloadThreadType(DownloadThreadType.DOUBLETHREAD)设置下载的线程数，Freeload下载库支持多线程同步下载单资源与多资源。常见的有NORMALDownloadThreadType.单线程和DownloadThreadType.DOUBLETHREAD双线程两个。
  3. setListener(new Response.Listener<IReceipt>()设置监听对象，实时将下载信息同步传回。
  4. addRequestQueue(requestQueue)将任务添加到下载队列里。

3、反馈系统使用

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
//反馈凭条
private String receipt = "";
@Override
public void onProgressChange(IReceipt s) {
    receipt = s.getReceipt();
    System.out.println(s.getReceipt());
}
requestDoublie = DownloadManager.create()
        .setEscapeReceipt(receipt)
        .setDownloadThreadType(DownloadThreadType.DOUBLETHREAD)
        .setPepareListener(new Response.PepareListener<IReceipt>() {
            @Override
            public void onProgressPepare(IReceipt s) {
                receipt = s.getReceipt();
                System.out.println(receipt);
            }
        })
        .setListener(new Response.Listener<IReceipt>() {
            @Override
            public void onProgressChange(IReceipt s) {
                receipt = s.getReceipt();
                System.out.println(s.getReceipt());
            }
        })
        .addRequestQueue(requestQueue);
  1. 在监听函数里保存反馈的凭条，随意找个String内存保存即可。
  2. 在resume操作的时候使用setEscapeReceipt(receipt)函数将凭条输入。
  3. 系统会根据凭条的内容自行继续下载。

4、信息回调

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
public interface IReceipt {
    public String getReceipt();
    public DownloadReceipt.STATE getReceiptState();
    public long getDownloadedSize();
    public long getDownloadTotalSize();
    public String getDownloadFilePath();
}
new Response.Listener<IReceipt>() {
    @Override
    public void onProgressChange(IReceipt s) {
        receipt = s.getReceipt();
    }
}
new Response.PepareListener<IReceipt>() {
    @Override
    public void onProgressPepare(IReceipt s) {
        receipt = s.getReceipt();
        System.out.println(receipt);
    }
}

通过回调接口 IReceipt 可以获取下载的信息，例如下载进度，下载的状态等。

Response.PepareListener 接口可以获取在下载前的文件信息，例如大小，来判断是否要继续下。
Response.Listener 接口可以获取下载过程的进度。

返回的状态包含：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
public static enum STATE {
    NONE,                   // 0
    GETSIZE,                // 1
    FAILED_GETSIZE,         // 2
    CREATEFILE,             // 3
    FAILED_CREATEFILE,      // 4
    QUEST_PREPARE,          // 5
    FAILED_QUEST_PREPARE,   // 6
    START,                  // 7
    DOWNLOAD,               // 8
    CANCEL,                 // 9
    SUCCESS_DOWNLOAD,       // 10
    START_COMBIN_FILE,      // 11
    SUCCESS_COMBIN_FILE,    // 12
    FAILED,                 // 13
    TIMEOUT,                // 14
    CONNWRONG               // 15
}

5、在AndroidManifest里添加权限请求

1
2
3
4
5
6
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WRITE_INTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.MOUNT_UNMOUNT_FILESYSTEMS"/>

6、逻辑详解

  • 目前下载的逻辑会在文件下载完合并成最后文件前将同名文件删除。并在合并完成后将临时文件删除。
  • DownloadManager 里面封装了所有对外的下载任务接口，可以通过接口来配置任务的信息。