FileDownloader README

The project's README from github.com/lingochamp/FileDownloader. As one markdown file: README.md.

FileDownloader

Android multi-task file download engine.

Download Build Status

中文文档

FileDownloader2

Now, FileDownloader2-OkDownload is released, okdownload will contain all advantage on the FileDownloader and beyond.

Because of FileDownloader unit-test coverage is very low, so all farther features and enhances will be achieved on the okdownload instead of FileDownloader, and FileDownloader will only focuses on bug fixes.

DEMO

Installation

FileDownloader is installed by adding the following dependency to your build.gradle file:

dependencies {
    implementation 'com.liulishuo.filedownloader:library:1.7.7'
}

Snapshots of the development version are available in Sonatype's snapshots repository, you can include on your gradle project through:

repositories {
    maven { url "https://oss.sonatype.org/content/repositories/snapshots/" }
}

Open customize component

From now on, FileDownloader support following components to be customized by yourself:

Name Interface Default Impl
Connection FileDownloadConnection FileDownloadUrlConnection
OutputStream FileDownloadOutputStream FileDownloadRandomAccessFile
Database FileDownloadDatabase RemitDatabase
ConnectionCountAdapter ConnectionCountAdapter DefaultConnectionCountAdapter
IdGenerator IdGenerator DefaultIdGenerator
ForegroundServiceConfig ForegroundServiceConfig ForegroundServiceConfig
  • If you want to use okhttp as your connection component, the simplest way is this repo.
  • If you don't want to use any database on FileDownloader(the database on FileDownloader is used for persist tasks' breakpoint info) just using NoDatabaseImpl.java

How to valid it?

Just create your own DownloadMgrInitialParams.InitCustomMaker and put those customized component to it, finally init the FileDownloader with it: FileDownloader#init

Adaptation

Adapt to Android 8.0

The restriction of background service has been tightened since Android 8.0, for more details, please refer to here. So, after Android 8.0, the download service will be a foreground service when start downloading during app is in background and you will see a notification with a title named "FileDownloader" start from FileDownloader 1.7.6. You can refer to here to custom the notification.

Adapt to Android 9.0

Starting with Android 9.0 (API level 28), cleartext support is disabled by default, you can have a look at here to know about more details. FileDownloader demo has handled this problem start with 1.7.6.

According to the migration notes, the FOREGROUND_SERVICE permission has been added to the library manifest since FileDownloader 1.7.6.

Welcome PR

If you can improve the unit test for this project would be great.

Usage

By default, the FileDownloadService runs on the separate process, if you want to run it on the main process, just configure on the filedownloader.properties, and you can use FileDownloadUtils.isDownloaderProcess(Context) to check whether the FileDownloadService can run on the current process.

For more readable, Moved to Wiki.

LICENSE

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.

FileDownloader (lingochamp/FileDownloader)

Searching Database…

11.1K ·GitHub
FileDownloader
What is this?FileDownloader is an Android library for building multi-task file downloads, with breakpoint-resume, multi-thread (multi-connection) downloading per task, and high concurrency support.
Is this a library I add to my app, or a standalone app?It's an Android library you integrate via Gradle; it runs download work through an internal FileDownloadService rather than being a standalone app.
How do I add it to my Android project?Add the FileDownloader dependency to your build.gradle file; development snapshots are also available through Sonatype's snapshots repository.
Is this project still actively developed?No, it's effectively deprecated: the author moved new features to FileDownloader2-OkDownload and now only ships bug fixes here, largely because this project's unit-test coverage was very low.
Can I customize the network connection, storage, or database it uses?Yes. FileDownloader lets you plug in custom implementations for Connection, OutputStream, Database, ConnectionCountAdapter, IdGenerator, and ForegroundServiceConfig through a DownloadMgrInitParams.InitCustomMaker passed to FileDownloader#init.
Does it handle Android 8 and 9 restrictions automatically?Since version 1.7.6, the download service runs as a foreground service with a notification on Android 8+ and the manifest includes the FOREGROUND_SERVICE permission; the bundled demo also addresses Android 9's disabled-cleartext-traffic default.
Does the download service run in its own process?By default yes, FileDownloadService runs on a separate process; you can switch it to the main process via filedownloader.properties and check this with FileDownloadUtils.isDownloaderProcess(Context).
What makes it different from a basic download manager?It combines multitasking, per-task multi-thread/multi-connection downloads, and breakpoint-resume with high concurrency, aiming to stay simple to use despite the advanced feature set.
What are similar projects?Android-Universal-Image-Loader, RxPermissions, greenDAO, butterknife, Android-PickerView, ViewPagerIndicator, anko, okhttp-OkGo
Which topics is it in?download, multithreading, android-library, storage, concurrency, downloader, deprecated, java, database, mobile, networking, android
Creator
lingochamp
Size
39.8 MB
Stars
11.1K
Updated
CommitNov 08Releasev1.7.5Aug 03
Age
10y
Commits · 90 Days