Kotlin协程+Retrofit下载文件并实现进度监听

使用Retrofit实现文件的上传和下载 在实现文件的下载时需要在接口类对象中添加@Streaming,从而防止内存泄漏。 阅读详情
AI摘要

本文介绍了如何使用Kotlin协程与Retrofit配合下载文件,并通过监听实现下载进度更新,同时展示了如何将此功能与WorkManager结合,以后台下载提高用户体验。

Kotlin协程+Retrofit下载文件并实现进度监听

1.前言

网上很多Retrofit+RxJava下载文件的功能,这里我使用kotlin+协程的方式使用一下,并且结合workmanager使用下载

  DownloadWorker.startDownload(
                this@MainActivity,
                "https://dldir1.qq.com/wework/work_weixin/wxwork_android_3.0.31.13637_100001.apk",
                this@MainActivity.cacheDir.path,
                "wxwork_android_3.apk"
            )

2. 实现过程

1. 构建下载的ApiService

import okhttp3.ResponseBody
import retrofit2.http.GET
import retrofit2.http.Streaming
import retrofit2.http.Url

interface ApiService {
 	@Streaming
 	@GET
 	suspend fun downloadFile(@Url fileUrl: String?): ResponseBody
 }

2. 声明相关监听方法

typealias download_error = suspend (Throwable) -> Unit
typealias download_process = suspend (downloadedSize: Long, length: Long, progress: Float) -> Unit
typealias download_success = suspend (uri: File) -> Unit

3. 构建Retrofit,并且获取ApiService

import retrofit2.Retrofit

object HttpKit {
    val retrofit = Retrofit.Builder()
        .baseUrl("http://www.xxx.com")
        .validateEagerly(true) //在开始的时候直接开始检测所有的方法
        .build()

    val apiService = retrofit.create(ApiService::class.java)
}				

4. 定义返回实体

/**
 * @author stj
 * @Date 2021/10/28-16:42
 * @Email 375105540@qq.com
 */

class HttpResult<out T> constructor(val value: Any?) {

    val isSuccess: Boolean get() = value !is Failure && value !is Progress

    val isFailure: Boolean get() = value is Failure

    val isLoading : Boolean get() = value is Progress

    fun exceptionOrNull(): Throwable? =
        when (value) {
            is Failure -> value.exception
            else -> null
        }
    /*
    .....代码省略
    */

    companion object {
        fun <T> success(value: T): HttpResult<T> =
            HttpResult(value)

        fun <T> failure(exception: Throwable): HttpResult<T> =
            HttpResult(createFailure(exception))

        fun <T> progress(currentLength: Long, length: Long, process: Float):HttpResult<T> =
            HttpResult(createLoading(currentLength, length, process))
    }

    data class Failure(val exception: Throwable)

    data class Progress(val currentLength: Long, val length: Long, val process: Float)
}


private fun createFailure(exception: Throwable): HttpResult.Failure =
    HttpResult.Failure(exception)


private fun createLoading(currentLength: Long, length: Long, process: Float) =
    HttpResult.Progress(currentLength, length, process)



inline fun <R, T> HttpResult<T>.fold(
    onSuccess: (value: T) -> R,
    onLoading:(loading: HttpResult.Progress) ->R,
    onFailure: (exception: Throwable?) -> R
): R {
    return when {
        isFailure -> {
            onFailure(exceptionOrNull())
        }
        isLoading -> {
            onLoading(value as HttpResult.Progress)
        }
        else -> {
            onSuccess(value as T)
        }
    }
}


5. 构建下载请求,已经处理

import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.flow.collect
import kotlinx.coroutines.flow.flow
import kotlinx.coroutines.flow.flowOn
import me.shetj.download.http.HttpKit.apiService
import java.io.BufferedInputStream
import java.io.File
import java.io.FileOutputStream

object KCHttpV2 {

    @JvmOverloads
    suspend fun download(
        url: String, outputFile: String,
        onError: download_error = {},
        onProcess: download_process = { _, _, _ -> },
        onSuccess: download_success = { }
    ) {
        flow {
            try {
                val body = apiService.downloadFile(url)
                val contentLength = body.contentLength()
                val inputStream = body.byteStream()
                val file = File(outputFile)
                val outputStream = FileOutputStream(file)
                var currentLength = 0
                val bufferSize = 1024 * 8
                val buffer = ByteArray(bufferSize)
                val bufferedInputStream = BufferedInputStream(inputStream, bufferSize)
                var readLength: Int
                while (bufferedInputStream.read(buffer, 0, bufferSize)
                        .also { readLength = it } != -1
                ) {
                    outputStream.write(buffer, 0, readLength)
                    currentLength += readLength
                    emit(
                        HttpResult.progress(
                            currentLength.toLong(),
                            contentLength,
                            currentLength.toFloat() / contentLength.toFloat()
                        )
                    )
                }
                bufferedInputStream.close()
                outputStream.close()
                inputStream.close()
                emit(HttpResult.success(file))
            } catch (e: Exception) {
                emit(HttpResult.failure<File>(e))
            }
        }.flowOn(Dispatchers.IO)
            .collect {
                it.fold(onFailure = { e ->
                    e?.let { it1 -> onError(it1) }
                }, onSuccess = { file ->
                    onSuccess(file)
                }, onLoading = { progress ->
                    onProcess(progress.currentLength, progress.length, progress.process)
                })
            }
    }
}

5. 请求示例

  lifecycleScope.launch{
  		apiService.download(downloadUrl, saveFile, 
			onProcess = { currentLength, length, process ->
             Log.i("download","${(process * 100).toInt()}%")
        	}, onSuccess = {
             Log.i("download","${it.absolutePath}%")
        	},onError = {
             it?.printStackTrace()
        	})
  }

3.配合workManager使用

1. 引入workManager

   def work_version = "2.7.0"
   implementation "androidx.work:work-runtime-ktx:$work_version"

2. 构建DownloadWorker


import android.app.NotificationChannel
import android.app.NotificationManager
import android.content.Context
import android.graphics.Color
import android.os.Build
import androidx.annotation.RequiresApi
import androidx.core.app.NotificationCompat
import androidx.core.app.NotificationManagerCompat
import androidx.work.*
import me.shetj.download.demo.R
import me.shetj.download.http.KCHttpV2
import java.util.*


/**
 * 测试下载
 */
class DownloadWorker(context: Context, parameters: WorkerParameters) :
        CoroutineWorker(context, parameters) {

    override suspend fun doWork(): Result {
        val inputUrl = inputData.getString(KEY_INPUT_URL)
                ?: return Result.failure()
        val outputUrl = inputData.getString(KEY_OUT_PUT_URL)
                ?: return Result.failure()
        val filename = inputData.getString(KEY_OUTPUT_FILE_NAME)
                ?: return Result.failure()
        val progress = "Starting Download"
        setForeground(createForegroundInfo(progress))
        download(inputUrl, outputUrl, filename)
        return Result.success()
    }

    private suspend fun download(downloadUrl: String, outputFile: String, fileName: String) {
        KCHttpV2.download(downloadUrl, "$outputFile/$fileName", onProcess = { _, _, process ->
            setForeground(createForegroundInfo("${(process * 100).toInt()}%"))
            setProgress(Data.Builder().let {
                it.putInt("progress", (process * 100).toInt())
                it.build()
            })
        }, onSuccess = {
            setForeground(createForegroundInfo("download ok"))
        },onError = {
            it.printStackTrace()
        })
    }
    private fun createForegroundInfo(progress: String): ForegroundInfo {
        val intent = WorkManager.getInstance(applicationContext)
                .createCancelPendingIntent(id)

        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
            createChannel()
        }

        val notification = NotificationCompat.Builder(applicationContext, getChannelID())
                .setContentTitle(getTitle())
                .setTicker(getTitle())
                .setContentText(progress)
                .setSmallIcon(R.mipmap.ic_launcher)
                .setOngoing(true) //防止滑动删除
                .addAction(R.mipmap.picture_icon_delete_photo , "取消", intent)
                .build()

        return ForegroundInfo("下载文件".hashCode(), notification)
    }

    @RequiresApi(Build.VERSION_CODES.O)
    private fun createChannel() {
        if (NotificationManagerCompat.from(applicationContext).getNotificationChannel(
                        getChannelID()
                ) == null) {
            val name = "文件下载"
            val description = "文件下载"
            val importance = NotificationManager.IMPORTANCE_LOW
            val mChannel = NotificationChannel(getChannelID(), name, importance)
            mChannel.description = description
            mChannel.enableLights(true)
            mChannel.lightColor = Color.RED
            mChannel.enableVibration(true)
            return NotificationManagerCompat.from(applicationContext).createNotificationChannel(mChannel)
        }
    }

    private fun getTitle(): String {
        return "文件下载"
    }

    private fun getChannelID(): String {
        return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
            "文件下载"
        } else {
            ""
        }
    }

    companion object {
        const val KEY_INPUT_URL = "KEY_INPUT_URL"
        const val KEY_OUT_PUT_URL = "KEY_OUT_URL"
        const val KEY_OUTPUT_FILE_NAME = "KEY_OUTPUT_FILE_NAME"

        fun startDownload(context: Context, downloadUrl: String, outputFile: String, fileName: String): UUID {
            val inputData: Data = Data.Builder().apply {
                putString(KEY_INPUT_URL, downloadUrl)
                putString(KEY_OUTPUT_FILE_NAME, fileName)
                putString(KEY_OUT_PUT_URL, outputFile)
            }.build()
            val request = OneTimeWorkRequestBuilder<DownloadWorker>().setInputData(inputData).build()
            WorkManager.getInstance(context).enqueue(request)
            return request.id
        }
    }
}

3. 使用示例

   DownloadWorker.startDownload(
                this@MainActivity,
                "https://dldir1.qq.com/wework/work_weixin/wxwork_android_3.0.31.13637_100001.apk",
                this@MainActivity.cacheDir.path,
                "wxwork_android_3.apk"
            )

demo下载

因为之前没有添加demo,现在加上
downloadDemo

Android中使用Kotlin协程(Coroutines)和Retrofit进行网络请求(二)之文件下载 写在前面 下载功能是非常常用的功能,今天我们要通过kotlin协程和retrofit来是实现文件下载的功能.retorfit本身可以将请求结果以InputStream的形式返回,拿到InputStream,我们再将数据写入文件的outputStream,就可以实现文件的下载了.在java时我们也是这么做的.但问题是,我们在IO操作时都是在子线程操作,而下载过程中我还需要在UI显示下载状态,所以... 阅读详情

相关推荐

告别原生DownloadManager:用Kotlin协程+Retrofit打造更优雅的Android应用内更新模块

本文介绍了如何利用Kotlin协程与Retrofit重构Android应用内更新模块,替代传统的DownloadManager方案。通过协程实现断点续传、多线程分块下载和实时进度反馈,显著提升下载效率和用户体验。特别适配了不同Android版本的APK安装流程,为开发者提供更灵活、高性能的更新解决方案。

weixin_27032989的博客 207

Retrofit上传/下载文件 (一)

Retrofit上传/下载文件

QG 6171

RxJava + Retrofit Android工程化实战:线程、背压与生命周期深度解析

在Android开发中,网络请求本质是受限资源下的异步状态流管理问题。Retrofit作为类型安全的REST抽象层,将HTTP语义映射为接口契约;RxJava则提供响应式数据流模型,通过subscribeOn/observeOn实现确定性线程调度,以map、flatMap等操作符完成声明式数据转换。其技术价值在于解耦业务逻辑与协议处理、消除回调地狱、统一错误与生命周期管理。典型应用场景包括快速列表滚动时的请求取消(switchMap)、带进度的文件上传(Streaming+ProgressRequestBo

weixin_33863087的博客 361

Android 使用Retrofit+协程实现超简单大文件下载并回显进度条

找到自己APP的包名点开进入下载目录,可以看到文件已经被下载到指定的位置。可以看到已经在下载了,下载完成后可以如图打开目录。在ApiService 中添加下载接口。创建弹窗工具类,使用刚才创建好的布局。,用到了挂起函数必须在协程中使用。编写具体调用下载接口的代码。先定义一个下载参数实体。别忘了加上网络请求权限。一个圆角白色背景样式。

工宗浩生财指南针 4324

Android网络请求开发指南:权限配置与HTTP客户端选型

网络请求是移动应用与服务器交互的基础技术,Android平台通过权限机制和多种HTTP客户端实现这一功能。从技术原理看,Android网络请求涉及网络安全配置、线程管理和性能优化等核心概念。开发者需要掌握INTERNET和ACCESS_NETWORK_STATE等基础权限配置,了解HttpsURLConnection、OkHttp和Ktor等主流HTTP客户端的特性差异。在工程实践中,合理选择网络库能显著提升应用性能,特别是在文件上传下载、网络状态监测等场景。OkHttp作为行业标准解决方案,其连接池复用和

weixin_30660027的博客 327

RxJava+Retrofit+OkHttp实现多文件下载之断点续传

本篇文章主要介绍了RxJava+Retrofit+OkHttp实现多文件下载之断点续传,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

kotlin中关于下载查看PDF并更新下载进度问题

文章目录定义接口发起请求将PDF写入本地并更新进度基于腾讯内核自定义webview进度条weiview打开本地PDF文件 定义接口 @Streaming @GET fun downLoadPDF(@Url url: String):Call<ResponseBody> 发起请求 getService(ServerApi::class.java).downLo...

The blog of 优快云 in 杨天福 6474

华为/H3C/锐捷交换机配置命令对比表:一张图搞定VLAN划分与端口设置

本文详细对比了华为、H3C、锐捷三大品牌交换机在VLAN划分与端口设置中的配置命令差异,提供从基础配置到高级功能的横向对比表,帮助网络工程师快速掌握多品牌设备混用环境下的配置技巧,提升工作效率。

rust6ferris的博客 702

使用OkHttp实现下载的进度监听和断点续传

1. 导入依赖包// retrofit, 基于Okhttp,考虑到项目中经常会用到retrofit,就导入这个了。 compile 'com.squareup.retrofit2:retrofit:2.1.0' // ButterKnife compile 'com.jakewharton:butterknife:7.0.1'2. 继承ResponseBody,生成带进度监听的Pro

Kevins优快云的博客 2万+

k8s学习笔记(3)--- kubernetes核心技术概念

kubernetes核心技术概念 1.API对象         API对象是K8s集群中的管理操作单元。K8s集群系统每支持一项新功能,引入一项新技术,一定会新引入对应的API对象,支持对该功能的管理操作。例如副本集Replica Set对应的API对象是RS。 2.集群(Cluster)         集群是指由...

梦谜的博客 1293

Windows下SVN服务器迁移全攻略:从备份到恢复的完整流程(附常见错误解决)

本文详细介绍了在Windows环境下进行SVN服务器迁移的完整流程,从迁移前的健康检查与备份准备,到使用svnadmin dump/load命令进行核心数据迁移,再到迁移后的权限恢复与数据验证。文章重点解析了操作中的常见错误与解决方案,为系统管理员提供了一份安全可靠的迁移指南,确保版本历史与团队协作的平稳过渡。

m3n5b7v8c9x的博客 490

Android中Kotlin协程http并发请求的正确开启方式

关于Kotlin协程在实际使用中的一点个人经验总结,下面是一个协程使用案例,requestHeWeather6()方法中有详细说明,这个方法是使用Kotlin协程 + Retrofit同步实现并发请求。 package com.coolweather.android import android.annotation.SuppressLint import android.graphics.Co...

喝烧酒的兔子 2467

Visual Studio 6.0 镜像下载全指南:从企业版到中文版

本文提供Visual Studio 6.0企业版和中文版的镜像下载全指南,包括详细版本解析、已验证的下载链接及校验信息。针对现代系统的安装技巧和兼容性处理方案,帮助开发者高效获取并运行这一经典开发工具,特别适合维护遗留系统的专业人员。

weixin_33712987的博客 1147

基于Ok+Rxjava+retrofit 实现断点续传下载

1、基于Ok+Rxjava实现断点续传下载 2、基于Ok+Rxjava+Retrofit实现断点续传下载 上一篇博客中介绍了基于Ok+Rxjava实现断点续传下载,这一篇给大家介绍下基于Ok+Rxjava+Retrofit实现断点续传下载, demo下载地址,效果图跟上一篇图片一样,哈哈 ...

Super_Ks的博客 1017

电脑技巧:Hyper-V安装UOS操作系统图文教程

今天给大家分享微软官方Hyper-v虚拟机管理软件安装UOS操作系统图文教程,感兴趣的朋友也可以下载试一试,当然有啥问题也可以互相沟通交流!

IT技术分享社区 4707

大数据开发工程师必备面试题与解答

大数据开发岗位一直是互联网行业的热门方向,面试过程中既考察基础知识,也关注实际项目经验和问题解决能力。本文整理了等核心组件相关的高频面试题及参考解答,帮助大家高效准备面试。大数据面试不仅考察基础理论,更看重项目经验与问题解决能力。本文涵盖了等核心知识点及调优思路,希望能帮助你在面试中游刃有余。

X2829352498的博客 306

RxHttp ,比Retrofit 更优雅的协程体验

1、前言 Hello,各位小伙伴,又见面了,回首过去,RxHttp 就要迎来一周年生日了(19年4月推出),这一年,走过来真心…真心不容易,代码维护、写文章、写文档等等,经常都是干到零点之后,也是我首次花费大部分业余时间来维护一个开源项目,全程一个人维护,要知道,网络请求库不同于其它开源项目,各位同僚对这类项目的要求都非常高,而且前面有一座大山Retrofit,如何在这种情况下,杀出重围?那就只有死磕细节,做到人无我有,人有我精。 幸运的是,RxHttp它做到了,截止本文发表,在Github上,已达到160

刘敬兴的博客 1336

Python爬虫实战:利用Selenium与Playwright抓取美团外卖数据

在当今大数据时代,网络数据采集已成为商业分析和市场研究的重要手段。本文以美团外卖平台为例,详细介绍如何使用Python最新爬虫技术(Selenium、Playwright)进行数据采集,并探讨相关技术原理、反爬应对策略及数据存储方案。通过5000+字的详细讲解和完整代码示例,帮助读者掌握现代网络爬虫开发的核心技能。本文详细介绍了使用Python最新爬虫技术采集美团外卖数据的完整流程,涵盖了从环境配置、页面分析到数据存储的全链路解决方案。

2201_76125261的博客 2551

Kotlin网络框架最佳实践( Retrofit + OkHttp 深度整合方案)

掌握Kotlin网络框架高效开发之道,深度整合Retrofit与OkHttp实现网络请求优化。适用于Android应用开发,支持协程、拦截器配置和统一错误处理,提升性能与可维护性。最佳实践方案值得收藏。

CodeTrick的博客 433

054_小驰私房菜_Camx i2c读写相关备忘

Camera 对Ae、Af这些控制,实际都是,最终实际都是落实到hal下发相关的指令给驱动,那hal这边是怎么给驱动下发相关命令的呢?#小驰私房菜054# #Qcom Camx#可以参考看下下面相关代码内容。

152

数学建模模型总结

这是本人在两年内准备参加数学建模竞赛搜集到的模型资料,已经经过了本人的筛选和整理,希望能够对准备参加数学建模竞赛的学弟学妹们提供一些帮助!

java re7下载,retofit + rxjava + kotlin 下载进度回调(721)

下载回调换一种写法DownLoadListener先写好监听接口interface MyDownloadListener {fun onStartDownload()fun onProgress(progress: Int)fun onFinishDownload()fun onFail(errorInfo: String)}DownloadInterceptor封装拦截器class Downlo...

weixin_34368102的博客 149

WINCC7.3破解文件

WINCC7.3硬件够破解文件,有需要的下载!WINCC7.3硬件够破解文件,有需要的下载!

DownloadX 开源项目教程

DownloadX 开源项目教程 1. 项目介绍 DownloadX 是一个基于 Kotlin 和协程(Coroutine)的多线程下载工具。它旨在提供一个高效、可靠的下载解决方案,适用于 Android 应用开发。DownloadX 支持多线程下载、断点续传、下载进度监控等功能,并且易于集成到现有的 Android 项目中。 2. 项目快速启动 2.1 添加依赖 首先,在你的 build.gra...

gitblog_00390的博客 873

华为的C语言编程规范.pdf

华为技术有限公司内部技术规范。本规范制定了编写C语言程序的基本原则、规则和建议。从代码的清晰、简洁、可测试、安全、程序效率、可移植各个方面对C语言编程作出了具体指导。

蓝牙模块HM-10手册

蓝牙模块HM-10手册,该手册对蓝牙模块HM-10进行了详细的介绍和使用方法以及一些AT指令。

Rxdownload:断点续传,rxjava,retrofit,okhttp,room,aidl

Rxdownload:断点续传,rxjava,retrofit,okhttp,room,aidl 描述: rxdowload是一个下载器,使用简单,支持断点续传,用到aidl ipc通信模式,rxjava okhttp retrofit 目前流行的网络请求和异步操作。 kotlin语法 //下载地址GitHub - linzhikuan/RxDowload 基本使用: implementation 'com.lzk.rxdownload:rxdowloadlib:1.4.0'//添加到gradle app

qq_16516401的博客 686

【亲测免费】 ProgressManager 项目常见问题解决方案

ProgressManager 是一个开源项目,旨在帮助开发者监听 OkHttp 网络请求的上传和下载进度,同时兼容 Retrofit 和 Glide。该项目的主要编程语言是 Java 和 Kotlin。通过使用 ProgressManager,开发者可以轻松地在应用中的任何地方监听网络链接的上传和下载进度,包括 Glide 的图片加载进度。 ## 新手使用注意事项及解决方案 ### 1. 依...

gitblog_00565的博客 1026

RxHttp:新一代Android网络请求框架的终极指南

还在为Android网络请求的复杂性而烦恼吗?RxHttp基于OkHttp深度封装,支持Kotlin协程、RxJava2、RxJava3,让你30秒上手,彻底告别网络请求的繁琐配置! ## ???? 读完本文你将掌握 - ✅ RxHttp核心架构与设计理念 - ✅ 四种编程范式(协程/Flow/RxJava)的完整用法 - ✅ 文件上传下载与进度监听的最佳实践 - ✅ 全局配置与错误统一处理方案 ...

gitblog_00279的博客 367

Android毕业设计实战:宠物社区APP开发全流程解析

移动应用开发是计算机与软件工程领域的重要方向,其核心在于将创意转化为功能完整、体验流畅的应用程序。从技术原理层面看,现代Android开发通常采用MVVM架构模式,通过数据绑定实现UI与业务逻辑的分离,提升代码的可维护性和可测试性。在工程实践中,合理的技术选型与模块化设计是项目成功的关键,例如使用Retrofit处理网络请求、Room管理本地数据,能有效支撑社区类应用的高频数据交互需求。这类技术组合尤其适用于需要处理用户生成内容、实现实时信息展示与互动的场景,例如社交平台、信息论坛等。本文以宠物社区平台为例

congbao6525的博客 308
上一篇: Flow 和 LiveData 之操作符:throttleFirst、 throttleLast 、throttleLatest、debounce
下一篇: 工作总结-问题解决流程
TieJun~
博客等级 码龄11年 1118粉丝 26原创
评论 8
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

TieJun~

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值