lingochamp/FileDownloader

版本迭代日志: Change
Log

英文文档: Wiki

特点

需要注意

=2_147_483_647 = 1.99GB

FileDownloadLargeFileListener

FileDownloadListener

getLargeFileSofarBytes()

getLargeFileTotalBytes()

filedownloader.properties

process.non-separate

true

使用okHttp并使用其中的一些默认属性

欢迎提交
Pull requests

I.
效果

II.
使用

compile 'com.liulishuo.filedownloader:library:0.3.2'

全局初始化在

Application.onCreate

中

OkHttpClient

public XXApplication extends Application{

...
@Override
public void onCreate() {
/**
* 仅仅是缓存Application的Context，不耗时
*/
FileDownloader.init(getApplicationContext);
}

...
}

启动单任务下载

FileDownloader.getImpl().create(url)
.setPath(path)
.setListener(new FileDownloadListener() {
@Override
protected void pending(BaseDownloadTask task, int soFarBytes, int totalBytes) {
}

@Override
protected void connected(BaseDownloadTask task, String etag, boolean isContinue, int soFarBytes, int totalBytes) {
}

@Override
protected void progress(BaseDownloadTask task, int soFarBytes, int totalBytes) {
}

@Override
protected void blockComplete(BaseDownloadTask task) {
}

@Override
protected void retry(final BaseDownloadTask task, final Throwable ex, final int retryingTimes, final int soFarBytes) {
}

@Override
protected void completed(BaseDownloadTask task) {
}

@Override
protected void paused(BaseDownloadTask task, int soFarBytes, int totalBytes) {
}

@Override
protected void error(BaseDownloadTask task, Throwable e) {
}

@Override
protected void warn(BaseDownloadTask task) {
}
}).start();

启动多任务下载

final FileDownloadListener queueTarget = new FileDownloadListener() {
@Override
protected void pending(BaseDownloadTask task, int soFarBytes, int totalBytes) {
}

@Override
protected void connected(BaseDownloadTask task, String etag, boolean isContinue, int soFarBytes, int totalBytes) {
}

@Override
protected void progress(BaseDownloadTask task, int soFarBytes, int totalBytes) {
}

@Override
protected void blockComplete(BaseDownloadTask task) {
}

@Override
protected void retry(final BaseDownloadTask task, final Throwable ex, final int retryingTimes, final int soFarBytes) {
}

@Override
protected void completed(BaseDownloadTask task) {
}

@Override
protected void paused(BaseDownloadTask task, int soFarBytes, int totalBytes) {
}

@Override
protected void error(BaseDownloadTask task, Throwable e) {
}

@Override
protected void warn(BaseDownloadTask task) {
}
};

// 第一种方式 :

//for (String url : URLS) {
//    FileDownloader.getImpl().create(url)
//            .setCallbackProgressTimes(0) // 由于是队列任务, 这里是我们假设了现在不需要每个任务都回调`FileDownloadListener#progress`, 我们只关系每个任务是否完成, 所以这里这样设置可以很有效的减少ipc.
//            .setListener(queueTarget)
//            .ready();
//}

//if(serial){
// 串行执行该队列
//    FileDownloader.getImpl().start(queueTarget, true);
// }

// if(parallel){
// 并行执行该队列
//    FileDownloader.getImpl().start(queueTarget, false);
//}

// 第二种方式:

final FileDownloadQueueSet queueSet = new FileDownloadQueueSet(downloadListener);

final List<BaseDownloadTask> tasks = new ArrayList<>();
for (int i = 0; i < count; i++) {
tasks.add(FileDownloader.getImpl().create(Constant.URLS[i]).setTag(i + 1));
}

queueSet.disableCallbackProgressTimes(); // 由于是队列任务, 这里是我们假设了现在不需要每个任务都回调`FileDownloadListener#progress`, 我们只关系每个任务是否完成, 所以这里这样设置可以很有效的减少ipc.

// 所有任务在下载失败的时候都自动重试一次
queueSet.setAutoRetryTimes(1);

if (serial) {
// 串行执行该任务队列
queueSet.downloadSequentially(tasks);
// 如果你的任务不是一个List，可以考虑使用下面的方式，可读性更强
//      queueSet.downloadSequentially(
//              FileDownloader.getImpl().create(url).setPath(...),
//              FileDownloader.getImpl().create(url).addHeader(...,...),
//              FileDownloader.getImpl().create(url).setPath(...)
//      );
}

if (parallel) {
// 并行执行该任务队列
queueSet.downloadTogether(tasks);
// 如果你的任务不是一个List，可以考虑使用下面的方式，可读性更强
//    queueSet.downloadTogether(
//            FileDownloader.getImpl().create(url).setPath(...),
//            FileDownloader.getImpl().create(url).setPath(...),
//            FileDownloader.getImpl().create(url).setSyncCallback(true)
//    );
}

全局接口说明(

FileDownloader

)

Task接口说明

FileDownloadListener#progress

FileDownloadListener#progress

FileDownloadListener#progress

If-Match

Range

If-Match

Range

{name}

监听器(

FileDownloadListener

)说明

pending -> started -> connected -> (progress <->progress) -> blockComplete -> completed

paused / completed / error / warn

isReusedOldFile

setForceReDownload(true)

blockComplete -> completed

FileDownloadListener

FileDownloader#enableAvoidDropFrame

BaseDownloadTask#setSyncCallback

FileDownloadMonitor

FileDownloadMonitor.IMonitor

pending

FileDownloadUtils

BaseDownloadTask#setPath

FileDownloadNotificationHelper

filedownloader.properties

assets

/demo/src/main/assets/filedownloader.properties

keyword=value

true

chunck

true

FileDownloadListener#error(BaseDownloadTask, Throwable)

FileDownloadHttpException

FileDownloadGiveUpRetryException

BaseDownloadTask#setAutoRetryTimes

filedownloader.properties

http.lenient=true

FileDownloadOutOfSpaceException

III.
低内存情况

非下载进程(一般是UI进程):

前台进程数据被回收:

后台进程数据被回收:

后台进程

服务进程

下载进程:

服务进程

空进程

后台进程

START_STICKY

FileDownloader#unBindService

FileDownloader#unBindServiceIfIdle