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

link之家
链接快照平台
输入网页链接，自动生成快照
标签化管理网页链接
安卓自带的进度条弹窗过时了，这里简单创建一个进度条弹窗

在 drawable 文件夹创建 progress_dialog_bg_style.xml 一个圆角白色背景样式
<?xml version="1.0" encoding="utf-8"?>
<shape xmlns:android="http://schemas.android.com/apk/res/android"
    android:shape="rectangle">
    <corners android:radius="10dp"/>
    <solid android:color="@color/white" />
</shape>
创建alert_dialog_download_progress.xml布局 
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="500dp"
    android:layout_height="240dp"
    android:padding="20dp"
    android:orientation="vertical"
    android:gravity="center"
    android:background="@drawable/progress_dialog_bg_style">
    <TextView
        android:id="@+id/d_title"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:textSize="30sp"
        android:layout_marginBottom="50dp"
        android:text="标题" />
    <ProgressBar
        android:id="@+id/d_progress_bar"
        style="@style/Widget.AppCompat.ProgressBar.Horizontal"
        android:layout_width="match_parent"
        android:max="100"
        android:layout_height="wrap_content"/>
</LinearLayout>
创建弹窗工具类，使用刚才创建好的布局 
object DialogUtil {
     * 下载进度条弹窗
    fun showDownloadProgress(
        context: Context,
        title: String? = null
    ): AlertDialog = context.let {
        AlertDialog.Builder(it).create().apply {
            // 设置点击dialog的外部能否取消弹窗
            setCanceledOnTouchOutside(false)
            // 设置能不能返回键取消弹窗
            setCancelable(false)
            show()
            window?.run {
                setLayout(
            setContentView(
                View.inflate(it, R.layout.alert_dialog_download_progress, null).apply {
                    // 设置成顶层视图
                    bringToFront()
                    title?.let { text ->
                        findViewById<TextView>(R.id.d_title).text = text
简单封装一个下载工具类 
先定义一个下载参数实体DownloadDTO 
import okhttp3.ResponseBody
import java.io.File
 * 下载参数
data class DownloadDTO (
    val filename: String,
    val filepath: String,
    val body: ResponseBody,
    val callback: DownloadCallback
    // 下载回调接口，用来返回下载情况
    interface DownloadCallback {
        fun onSuccess(file: File)
        fun onProgress(progress: Int)
        fun onFailure(e: Exception)
编写下载工具类DownloadFileUtil，用到了挂起函数必须在协程中使用 
object DownloadFileUtil {
     * 文件下载
    suspend fun download(dto: DownloadDTO) = coroutineScope {
        async(Dispatchers.IO) {
            try {
                val filepath = File(dto.filepath)
                if (!filepath.exists()) {
                    filepath.mkdirs()
                val file = File(filepath.canonicalPath, dto.filename)
                if (file.exists()) {
                    file.delete()
                try {
                    val buffer = ByteArray(1024)
                    val contentLength: Long = dto.body.contentLength()
                    var lastProgress = 0
                    dto.body.byteStream().use { input ->
                        FileOutputStream(file).use { fos ->
                            var length: Int
                            var sum: Long = 0
                            while (input.read(buffer).also { length = it } != -1) {
                                fos.write(buffer, 0, length)
                                sum += length.toLong()
                                val progress = (sum * 100 / contentLength).toInt()
                                if (progress > lastProgress) {
                                    lastProgress = progress
                                    dto.callback.onProgress(progress)
                            fos.flush()
                    dto.callback.onSuccess(file)
                    LogUtil.yd("DownloadFileUtil.download filepath: ${file.path}")
                } catch (e: Exception) {
                    if (file.exists()) {
                        file.delete()
                    dto.callback.onFailure(e)
            } catch (e: Exception) {
                dto.callback.onFailure(e)
    }.await()
开始使用写好的工具来下载文件 
在ApiService 中添加下载接口 
import okhttp3.ResponseBody
import retrofit2.http.*
interface ApiService {
     * 下载文件
    @Streaming
    suspend fun downloadFile(@Url fileUrl: String): ResponseBody
 编写具体调用下载接口的代码 
// 开头说的文章有HttpRequest的封装过程
HttpRequest.executeAsync {
    // 开始请求，这里链接用的是自己服务器上的就不放出来了
    val downloadFile = it.downloadFile("http://xxxx/xxx.rar")
    // 显示进度条弹窗
    val dialog = DialogUtil.showDownloadProgress(this@MainActivity, "正在下载...")
    val view = dialog.findViewById<ProgressBar>(R.id.d_progress_bar)
    delay(500)
    // 下载并返回进度
    DownloadFileUtil.download(
          DownloadDTO(
              "文件名.rar",
              // 下载保存路径
               "${applicationContext.filesDir.absolutePath}${File.separator}test${File.separator}",
              downloadFile,
              object : DownloadDTO.DownloadCallback {
                  override fun onSuccess(file: File) { 
                      // 下载完成
                      dialog.cancel()
                  override fun onProgress(progress: Int) {
                      // 更新下载进度
                      view.progress = progress
                  override fun onFailure(e: Exception) {
                      // 下载失败
                      dialog.cancel()
                      e.printStackTrace()
别忘了加上网络请求权限 
<uses-permission android:name="android.permission.INTERNET" />
可以看到已经在下载了，下载完成后可以如图打开目录  
找到自己APP的包名点开进入下载目录，可以看到文件已经被下载到指定的位置  
                    找到自己APP的包名点开进入下载目录，可以看到文件已经被下载到指定的位置。可以看到已经在下载了，下载完成后可以如图打开目录。在ApiService 中添加下载接口。创建弹窗工具类，使用刚才创建好的布局。，用到了挂起函数必须在协程中使用。编写具体调用下载接口的代码。先定义一个下载参数实体。别忘了加上网络请求权限。一个圆角白色背景样式。
				retrofit下载apk文件，retrofit下载apk文件retrofit下载apk文件retrofit下载apk文件retrofit下载apk文件retrofit下载apk文件retrofit下载apk文件retrofit下载apk文件retrofit下载apk文件retrofit下载apk文件retrofit下载apk文件retrofit下载apk文件retrofit下载apk文件retrofit下载apk文件retrofit下载apk文件retrofit下载apk文件retrofit下载apk文件retrofit下载apk文件retrofit下载apk文件retrofit下载apk文件retrofit下载apk文件retrofit下载apk文件retrofit下载apk文件retrofit下载apk文件
				在保存文件时，调用ForwardingSource的read方法，通过RxBus发送实时的FileLoadEvent对象。
FileCallBack订阅RxBus发送的FileLoadEvent。通过接收到FileLoadEvent中的下载进度和文件总大小对UI进行更新。
在下载保存文件完成后，取消订阅，防止内存泄漏。
RxBus 名字看起来像一个库，但它并不是一个库，而是一种模式，它的思想是使用 RxJava 来实现了 EventBus ，而让你不再需要使用OTTO或者 EventBus。
基于MVVM模式用了 kotlin+协程+retrofit+livedata+DataBinding
封装了BaseActivity、BaseFragment、BaseViewModel基于协和的网络请方式更加方便，考虑到有些小伙伴不太喜欢用DataBinding在xml中绑定数据的方式，也提供了相应的适配，两种方式自行选择。Retrofit2.6及以上版本提供了对协程的支持，使用起来更加方便，不用考虑类型的转换了。
使用Rxjava 处理不好的话会有内存泄露的风险，我们会用使用AutoDispose、RxLifecycle等方式来处理，但是使用协程来请求数据，完全不用担心这个问题，
implementation 'androidx.lifecycle:lifecycle-viewmodel-ktx:2.2.0'
implementation 'androidx.lifecycle:lifecycle-livedata-ktx:2.2.0'
implementation 'com.squareup.retrofit2:retrofit:2.8.1'
implementation 'com.squareup.retrofit2:converter-gson:2.8.1'
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.9'
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.9'
2. 创建 Retrofit 接口：
```kotlin
interface ApiService {
    @GET("users/{user}/repos")
    suspend fun getRepos(@Path("user") user: String): List<Repo>
3. 创建数据模型：
```kotlin
data class Repo(val name: String)
4. 创建 Repository：
```kotlin
class MainRepository(private val apiService: ApiService) {
    suspend fun getRepos(user: String): List<Repo> {
        return apiService.getRepos(user)
5. 创建 ViewModel：
```kotlin
class MainViewModel(private val repository: MainRepository) : ViewModel() {
    private val _repos = MutableLiveData<List<Repo>>()
    val repos: LiveData<List<Repo>> = _repos
    fun getRepos(user: String) {
        viewModelScope.launch {
            _repos.value = repository.getRepos(user)
6. 创建 Activity/Fragment：
```kotlin
class MainActivity : AppCompatActivity() {
    private lateinit var viewModel: MainViewModel
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        val apiService = Retrofit.Builder()
            .baseUrl("https://api.github.com/")
            .addConverterFactory(GsonConverterFactory.create())
            .build()
            .create(ApiService::class.java)
        val repository = MainRepository(apiService)
        viewModel = ViewModelProvider(this, MainViewModelFactory(repository))[MainViewModel::class.java]
        viewModel.repos.observe(this, Observer { repos ->
            // do something with repos
        viewModel.getRepos("octocat")
以上就是一个使用 Kotlin + 协程 + Retrofit + MVVM 实现网络请求的示例。希望对您有所帮助！