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
Что это такое?FileDownloader — это библиотека для Android, которая позволяет организовать загрузку файлов сразу несколькими задачами. Поддерживается докачка с места остановки, многопоточная загрузка (несколько соединений) для каждой задачи и высокая степень параллельности.
Это библиотека, которую я добавляю в приложение, или отдельное приложение?Это библиотека для Android, которую вы подключаете через Gradle. Загрузки выполняются через внутренний сервис FileDownloadService, а не в отдельном приложении.
Как добавить её в мой проект для Android?Добавьте зависимость FileDownloader в файл build.gradle. Также доступны снапшоты для разработки из репозитория snapshots от Sonatype.
Проект всё ещё активно развивается?Нет, фактически он устарел: автор перенёс новые возможности в FileDownloader2-OkDownload, а здесь выпускает только исправления ошибок. Во многом это связано с тем, что покрытие этого проекта unit-тестами было очень низким.
Можно ли настроить сетевое соединение, хранилище или базу данных, которые он использует?Да. FileDownloader позволяет подключить собственные реализации Connection, OutputStream, Database, ConnectionCountAdapter, IdGenerator и ForegroundServiceConfig через DownloadMgrInitParams.InitCustomMaker, который передаётся в FileDownloader#init.
Учитывает ли он ограничения Android 8 и 9 автоматически?Начиная с версии 1.7.6, сервис загрузки работает как foreground-сервис с уведомлением на Android 8 и выше, а в манифесте есть разрешение FOREGROUND_SERVICE. Демо-приложение также учитывает значение по умолчанию в Android 9, при котором открытый текстовый трафик (cleartext) запрещён.
Работает ли сервис загрузки в отдельном процессе?По умолчанию да: FileDownloadService работает в отдельном процессе. Его можно перевести в основной процесс через filedownloader.properties, а проверить это можно с помощью FileDownloadUtils.isDownloaderProcess(Context).
Чем он отличается от обычного менеджера загрузок?Он сочетает многозадачность, многопоточную загрузку с несколькими соединениями для каждой задачи, докачку с места остановки и высокую параллельность. При этом он стремится оставаться простым в использовании, несмотря на богатый набор функций.
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