Ketch下载 - Ketch源码下载

Ketch

其他源码

Release 2.0.2

下载

双桅帆船

基于 WorkManager 的 Android 文件下载器库，支持暂停和恢复

关于双桅帆船

Ketch 是一个简单、强大、可定制的 Android 文件下载器库，完全用 Kotlin 构建。它利用 WorkManager 的强大功能简化了 Android 应用程序中下载文件的过程。无论应用程序状态如何，Ketch 都会保证下载。

为什么使用双桅帆船

Ketch 可以下载任何类型的文件。（jpg、png、gif、mp4、mp3、pdf、apk 等）
Ketch 保证文件下载，除非明确取消或下载失败。
Ketch 提供所有下载信息，包括速度、文件大小、进度。
Ketch 提供暂停、恢复、取消、重试和删除下载文件的选项。
Ketch 提供了将下载项（或单个下载项）观察为流的选项。
Ketch 可以并行下载多个文件。
Ketch 支持大文件下载。
Ketch 提供各种定制，包括自定义超时、自定义 okhttp 客户端和自定义通知。
Ketch 很简单并且非常容易使用。
Ketch 为每次下载提供通知，提供下载信息（速度、剩余时间、总大小、进度）。
Ketch 包括暂停、恢复、重试和取消通知下载的选项。

如何使用双桅帆船

安装

要将 Ketch 库集成到您的 Android 项目中，请按照以下简单步骤操作：

使用以下依赖项更新您的 settings.gradle 文件。

dependencyResolutionManagement {
  repositoriesMode . set( RepositoriesMode . FAIL_ON_PROJECT_REPOS )
  repositories {
    google()
    mavenCentral()
    maven { url ' https://jitpack.io ' } // this one
  }
}

使用以下依赖项更新模块级 build.gradle 文件。

dependencies {
  implementation ' com.github.khushpanchal:Ketch:2.0.2 ' // Use latest available version
}

用法

使用 Ketch 最简单的方法：
- 在应用程序 onCreate 中创建 Ketch 实例。（Ketch 是一个单例类，实例将在第一次使用时自动创建）
```
  private lateinit var ketch : Ketch
  override fun onCreate () {
    super .onCreate()
    ketch = Ketch .builder().build( this )
  }
```
- 调用download()函数，传递url、文件名、路径并观察下载状态
```
  val id = ketch.download(url, fileName, path)
  lifecycleScope.launch {
    repeatOnLifecycle( Lifecycle . State . STARTED ) {
      ketch.observeDownloadById(id)
        .flowOn( Dispatchers . IO )
        .collect { downloadModel -> 
          // use downloadModel
        }
    }
  }
```
重要提示1：根据API级别添加适当的存储权限，否则将触发onFailure(error)回调。查看示例应用程序以供参考。
重要提示2：添加FOREGROUND_SERVICE_DATA_SYNC、WAKE_LOCK、INTERNET权限。查看示例应用程序以供参考。

取消下载

    ketch.cancel(downloadModel.id) // other options: cancel(tag), cancelAll()

暂停下载

    ketch.pause(downloadModel.id) // other options: pause(tag), pauseAll()

恢复下载

    ketch.resume(downloadModel.id) // other options: resume(tag), resumeAll()

重试下载

    ketch.retry(downloadModel.id) // other options: retry(tag), retryAll()

删除下载

    ketch.clearDb(downloadModel.id) // other options: clearDb(tag), clearAllDb(), clearDb(timeInMillis)
    ketch.clearDb(downloadModel.id, false ) // Pass "false" to skip the actual file deletion (only clear entry from DB)

观察：提供下载项的状态流（每个项携带下载信息，如 url、文件名、路径、标签、id、timeQueued、状态、进度、长度、速度、lastModified、metaData、failureReason、eTag）

  // To observe from Fragment
  viewLifecycleOwner.lifecycleScope.launch {
    repeatOnLifecycle( Lifecycle . State . STARTED ) {
      ketch.observeDownloads()
        .flowOn( Dispatchers . IO )
        .collect { 
           // set items to adapter
        }
    }
  }

要启用通知：

在清单文件中添加通知权限。

 <uses-permission android:name="android.permission.POST_NOTIFICATIONS"/>

请求用户许可（从 Android 13（API 级别 33）开始需要）。查看示例应用程序以供参考。

初始化时传递通知配置

ketch = Ketch .builder().setNotificationConfig(
         config = NotificationConfig (
           enabled = true ,
           smallIcon = R .drawable.ic_launcher_foreground // It is required to pass the smallIcon for notification.
         )
       ).build( this )

定制化

提供网络请求的标头。

ketch.download(url, fileName, path,
 headers = headers, // Default: Empty hashmap
)

标签：通过提供附加标签对各种下载进行分组。（此标签还可用于取消、暂停、恢复、删除下载）
```
ketch.download(url, fileName, path,
 tag = tag, // Default: null
)
```

下载配置：提供自定义连接和读取超时

  ketch = Ketch .builder().setDownloadConfig(
    config = DownloadConfig (
      connectTimeOutInMs = 20000L , // Default: 10000L
      readTimeOutInMs = 15000L // Default: 10000L
    )
  ).build( this )

自定义OKHttp：提供自定义okhttp客户端

  ketch = Ketch .builder().setOkHttpClient(
    okHttpClient = OkHttpClient
      . Builder ()
      .connectTimeout( 10000L )
      .readTimeout( 10000L )
      .build()
  ).build( this )

通知配置：提供自定义通知配置

  ketch = Ketch .builder().setNotificationConfig(
    config = NotificationConfig (
      enabled = true , // Default: false
      channelName = channelName, // Default: "File Download"
      channelDescription = channelDescription, // Default: "Notify file download status"
      importance = importance, // Default: NotificationManager.IMPORTANCE_HIGH
      smallIcon = smallIcon, // It is required
      showSpeed = true , // Default: true
      showSize = true , // Default: true
      showTime = true // Default: true
    )
  ).build( this )

博客

查看博客以了解 Ketch（高级设计）的工作原理：https://medium.com/@khush.panchal123/ketch-android-file-downloader-library-7369f7b93bd1

高层设计

联系我

领英
叽叽喳喳
邮箱

查看我的博客：https://medium.com/@khush.panchal123

如果这个项目对您有帮助，请在这个项目上添加一个来表达爱❤️ ✌️

为项目做出贡献

请随意提供反馈、报告问题或为 Ketch 做出贡献。前往 GitHub 存储库，创建问题或查找待处理的问题。欢迎所有请求？

执照

   Copyright (C) 2024 Khush Panchal

   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.

展开

附加信息