KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #typescript #developer-tools #claude-code #ai-agent #codex #deepseek-harness #ai-agents #cli #react #mcp

okdownloader

★ 45 Open GitHub ↗

A downloader library for Java and Android based on OkHttp.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

OkDownloader
============

A downloader library for Java and Android based on OkHttp.

* Easy to use: Simple API similar to OkHttp.
* Rich in features: Supports synchronous/asynchronous downloads, network restrictions, multithreading, task priorities, resource verification, and more.
* Modern: Written in Kotlin and based on OkHttp.
* Easy to extend: Supports adding interceptors through code and provides extension through the `SPI` mechanism.

Download
--------

OkDownloader is available on `mavenCentral()`.

```kotlin
implementation("io.github.ydxlt:okdownloader:1.0.0")
```

Quick Start
-----------

Build a downloader instance just like building an OkHttpClient.

```kotlin
val downloader = Downloader.Builder().build()
```

Start download

```kotlin
val request = Download.Request.Builder()
    .url(url)
    .into(path) // or into(file)
    .build()
val call = downloader.newCall(request)
val response = call.execute() // synchronous download
// use response here
```

```kotlin
call.enqueue() // Asynchronous download
```

Add callback listeners

```kotlin
call.enqueue(object : Download.Callback {
    // ...
    override fun onSuccess(call: Download.Call, response: Download.Response) {
        // do your job
    }

override fun onFailure(call: Download.Call, response: Download.Response) {
        // do your job
    }
})
```

Cancel download

```kotlin
call.cancel() // or call.cancelSafely()
```

Check out OkDownloader's [full documentation here](https://ydxlt.github.io/okdownloader/getting_started/).

How to Expand
-------------

Add interceptors through code

```kotlin
val downloader = Downloader.Builder()
    .addInterceptor(CustomInterceptor())
    .build()
```

Declare your interceptors in `META-INF/services/com.billbook.lib.Interceptor` using the `SPI` mechanism.

```kotlin
com.example.CustomInterceptor1
com.example.CustomInterceptor2
com.example.CustomInterceptor3
```

R8/Proguard
-----------

OkDownloader is fully compatible with R8 out of the box and doesn't require adding any extra rules. If you use Proguard, you may need to add rules for [OkHttp](https://github.com/square/okhttp/blob/master/okhttp/src/jvmMain/resources/META-INF/proguard/okhttp3.pro) and [Okio](https://github.com/square/okio/blob/master/okio/src/jvmMain/resources/META-INF/proguard/okio.pro).

License
=======

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.
```

okdownloader

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README