如何使用OkHTTP3/Retrofit2实现分段上传多个文件并获取上传进度？

Question

我正在使用Retrofit2在单个multipart请求中上传动态数量的文件。我的Retrofit接口如下 -

public interface FileUploadService {  
    @Multipart
    @POST("upload")
    Call<ResponseBody> uploadMultipleFilesDynamic(
            @Part List<MultipartBody.Part> files);
}

现在我想追踪这个多文件上传的进度。 这个解决方案 解释了如何通过扩展 RequestBody 在多部分请求中上传单个文件时获取进度。尽管我似乎无法理解如何将其应用于我的多个文件请求。我能想到的一个解决方案是创建ProgressRequestBody，它通过扩展OkHTTP MultipartBody类而不是RequestBody，但是OkHTTP3将MultipartBody实现为最终类，因此无法扩展。有人可以指点我正确的方向吗？因为无法向用户显示文件上传的进度对我来说是一个巨大的障碍。或者有没有任何变通方法可以实现这个功能？

- shubham1g5

---

我需要相同的解决方案，你找到了吗？ - Khizar Hayat

@KhizarHayat，您可以通过将ProgressRequestBody作为参数传递部分编号和进度监听器来实现此目标。然后，ProgressRequestBody可以调用进度监听器，将部分编号和传输的字节数作为参数传递。监听器实现将考虑当前部分编号、所有部分的大小以及到目前为止传输的部分的大小，从而进行多部分请求的综合进度计算。 - shubham1g5

感谢@shubam1g5的回复。你能分享一些代码吗？ - Khizar Hayat

您可以查看此链接。 - Vivek Barai

对于那些仍然困在Retrofit 1.x上的人，这是一个易于使用的工作解决方案，我们最终采用了这个：https://dev59.com/DWAg5IYBdhLWcg3wpMWz#24772058 - Joshua Pinter

Answer 1

我遵循了这篇博客文章：https://medium.com/@PaulinaSadowska/display-progress-of-multipart-request-with-retrofit-and-rxjava-23a4a779e6ba，然后进行了以下调整以显示总进度而不是单独文件的进度：

  private fun prepareFileParts(reportAttachments: MutableList<ReportAttachment>, emitter: FlowableEmitter<Double>): List<MultipartBody.Part> {
    val multiPartBodyList = mutableListOf<MultipartBody.Part>()

    var offset = 0L
    var totalLength = 0L

    // calculate the total length of all files
    for (attachment in reportAttachments) {
        val file = File(attachment.filePath)
        totalLength += file.length()
    }

    // create requestbody for each file and calculate the progression offset
    for (attachment in reportAttachments) {
        val file = File(attachment.filePath)
        val mimeType = attachment.mimeType

        val countingRequestBody = createCountingRequestBody(file, mimeType, emitter, offset, totalLength)
        offset += file.length()

        val multipartBody = MultipartBody.Part.createFormData("file", file.name, countingRequestBody)
        multiPartBodyList.add(multipartBody)
    }

    return multiPartBodyList
}

private fun createCountingRequestBody(file: File, mimeType: String, emitter: FlowableEmitter<Double>, offset: Long, totalLength: Long): RequestBody {
    val requestBody = RequestBody.create(MediaType.parse(mimeType), file)
    return CountingRequestBody(requestBody, object : CountingRequestBody.Listener {
        override fun onRequestProgress(bytesWritten: Long, contentLength: Long) {
            val progress: Double = 1.0 * (offset + bytesWritten) / totalLength
            emitter.onNext(progress)
        }
    })
}

如果你想的话，你也可以创建一个拦截器并将其添加到你的OkHttpClient中。这样默认情况下就会跟踪所有的出站API调用。它看起来会像这样：

class UploadProgressInterceptor(private val progressListener: CountingRequestBody.Listener) : Interceptor {

override fun intercept(chain: Interceptor.Chain): Response {
    val originalRequest = chain.request()

    if (originalRequest.body() == null) {
        return chain.proceed(originalRequest)
    }

    val requestBody = originalRequest.body()
    requestBody?.let {
        val progressRequest = originalRequest.newBuilder()
                .method(originalRequest.method(), CountingRequestBody(it, progressListener))
                .build()
        return chain.proceed(progressRequest)
    }
    return chain.proceed(originalRequest)
}

- Tim