Android multi-task file download engine.
This project dependency on square/okhttp
FileDownloader is installed by adding the following dependency to your build.gradle file:
dependencies {
compile 'com.liulishuo.filedownloader:library:0.1.2'
}
To begin using FileDownloader, have yourApplication#onCreate invoke the FileDownloader.init(this) such as:
public XXApplication extends Application{
...
@Override
public void onCreate() {
super.onCreate();
// Just cache ApplicationContext and initial EventPool Object
FileDownloader.init(this);
}
...
}
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();
To start tasks queue serial or parallel(download simultaneously)
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)
.setListener(queueTarget)
.ready();
}
if(serial){
// To form a queue with the same queueTarget and execute them linearly
FileDownloader.getImpl().start(queueTarget, true);
}
if(parallel){
// To form a queue with the same queueTarget and execute them in parallel
FileDownloader.getImpl().start(queueTarget, false);
}
Automatically resume breakpoint by last downloaded file if possible default.
FileDownloader will stop task but retain download status in db by invoke
Filedownloader#pause
| function | description |
|---|---|
| init(Application) | Just cache ApplicationContext and initial EventPool Object |
| create(url:String) | Create a download task |
| start(listener:FileDownloadListener, isSerial:boolean) | Start the download queue by the same listener |
| pause(listener:FileDownloadListener) | Pause the download queue by the same listener |
| pauseAll(void) | Pause all task |
| pause(downloadId) | Pause the download task by the downloadId |
| getSoFar(downloadId) | Get downloaded so far bytes by the downloadId |
| getTotal(downloadId) | Get file total bytes by the downloadId |
| bindService(void) | Bind & start :filedownloader process manually(Do not need, will bind & start automatically by Download Engine if real need) |
| unBindService(void) | Unbind & stop :filedownloader process manually(Do not need, will unbind & stop automatically by System if leave unused period) |
For example:
FileDownloader.create(URL).setPath(xxx).setListener(xxx).start()
| function | description |
|---|---|
| setPath(path:String) | Absolute path for save the download file |
| setListener(listener:FileDownloadListener) | For callback download status(pending,connected,progress,blockComplete,retry,error,paused,completed,warn) |
| setCallbackProgressTimes(times:int) | Set maximal callback times on callback FileDownloadListener#progress |
| setTag(tag:Object) | Sets the tag associated with this task, not be used by internal |
| setForceReDownload(isForceReDownload:boolean) | If set to true, will not check whether the file is downloaded by past, default false |
| setFinishListener(listener:FinishListener) | - |
| setAutoRetryTimes(autoRetryTimes:int) | Set the number of times to automatically retry when encounter any error, default 0 |
| ready(void) | Ready task( For queue task ) |
| start(void) | Start task |
| pause(void) | Pause task |
| getDownloadId(void):int | Get download id (generate by url & path) |
| getUrl(void):String | Get download url |
| getCallbackProgressTimes(void):int | Get maximal callback times on callback FileDownloadListener#progress |
| getPath(void):String | Get absolute path for save the download file |
| getListener(void):FileDownloadListener | Get current listener |
| getSoFarBytes(void):int | Get already downloaded bytes |
| getTotalBytes(void):int | Get file total bytes |
| getStatus(void):int | Get current status |
| isForceReDownload(void):boolean | Force re-download,do not care about whether already downloaded or not |
| getEx(void):Throwable | Get throwable |
| isReusedOldFile(void):boolean | Is reused downloaded old file |
| getTag(void):Object | Get the task's tag |
| isContinue(void):boolean | Is resume by breakpoint |
| getEtag(void):String | Get current ETag on header |
| getAutoRetryTimes(void):int | Get the number of times to automatically retry |
| getRetryingTimes(void):int | Get the current number of retry |
pending -> connected -> (progress <->progress) -> blockComplete -> completed
paused / completed / error / warn
blockComplete -> completed
| function | description | update |
|---|---|---|
| pending | Pending for download | soFarBytes、totalBytes |
| connected | Connected to the remote file server | ETag、IsResumeBreakpoint、 soFarBytes、totalBytes |
| progress | Download progress | soFarBytes |
| blockComplete | Callback before the 'completed callback' sync in the new thread | - |
| retry | Callback before automatically retry download | Throwable、RetryingTimes、soFarBytes |
| completed | Succeed download and completed | - |
| paused | Paused download and over | soFarBytes |
| error | Occur error and over | Throwable |
| warn | There is already an identical task(same url & same path) being downloaded(pending/connected/process/retry) | - |
- For the vast majority of the use of performance considerations, limited to the range of int, FileDownloader engine maximum support for the download file size does not exceed 1.99G(
2^31-1=2_147_483_647) - Default by okhttp: retryOnConnectionFailure: Unreachable IP addresses/Stale pooled connections/Unreachable proxy servers
- Default by okhttp: connection/read/write time out 10s
Copyright (c) 2015 LingoChamp Inc.
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.