Retrofit2上传文件进度：轻松掌握文件上传进度

在移动开发中，文件上传是一个常见的需求，尤其是在社交媒体、云存储和企业应用中。Retrofit2作为一个强大的HTTP客户端库，提供了简洁而强大的API来处理网络请求。今天，我们将深入探讨如何使用Retrofit2来实现文件上传进度的监控和展示。

Retrofit2简介

Retrofit2是由Square公司开发的，基于OkHttp的REST API客户端。它通过注解的方式简化了HTTP请求的构建和处理，使得开发者可以更专注于业务逻辑而不是网络请求的细节。

文件上传的基本流程

在使用Retrofit2进行文件上传时，通常会涉及以下几个步骤：

创建Retrofit实例：配置基础URL和转换器工厂。
定义API接口：使用注解定义上传文件的接口。
实现上传逻辑：在Activity或Fragment中调用API接口进行文件上传。

监控上传进度

要监控文件上传的进度，我们需要利用OkHttp的ProgressRequestBody来包装原始的RequestBody，这样我们就可以在上传过程中获取进度信息。

public class ProgressRequestBody extends RequestBody {
    private final RequestBody requestBody;
    private final ProgressListener progressListener;

    public ProgressRequestBody(RequestBody requestBody, ProgressListener progressListener) {
        this.requestBody = requestBody;
        this.progressListener = progressListener;
    }

    @Override
    public MediaType contentType() {
        return requestBody.contentType();
    }

    @Override
    public long contentLength() throws IOException {
        return requestBody.contentLength();
    }

    @Override
    public void writeTo(BufferedSink sink) throws IOException {
        CountingSink countingSink = new CountingSink(sink);
        BufferedSink bufferedSink = Okio.buffer(countingSink);
        requestBody.writeTo(bufferedSink);
        bufferedSink.flush();
    }

    private final class CountingSink extends ForwardingSink {
        private long bytesWritten = 0;

        public CountingSink(Sink delegate) {
            super(delegate);
        }

        @Override
        public void write(Buffer source, long byteCount) throws IOException {
            super.write(source, byteCount);
            bytesWritten += byteCount;
            progressListener.onProgress(bytesWritten, contentLength());
        }
    }

    public interface ProgressListener {
        void onProgress(long bytesWritten, long contentLength);
    }
}

在Retrofit中使用

在Retrofit的API接口中，我们可以这样定义上传文件的接口：

public interface UploadService {
    @Multipart
    @POST("upload")
    Call<ResponseBody> uploadFile(
            @Part("description") RequestBody description,
            @Part MultipartBody.Part file
    );
}

然后在调用时，我们可以这样使用ProgressRequestBody：

File file = new File(filePath);
RequestBody requestFile = RequestBody.create(MediaType.parse("multipart/form-data"), file);
ProgressRequestBody progressRequestBody = new ProgressRequestBody(requestFile, new ProgressRequestBody.ProgressListener() {
    @Override
    public void onProgress(long bytesWritten, long contentLength) {
        // 更新UI显示进度
        int progress = (int) (100 * bytesWritten / contentLength);
        // 这里可以更新进度条
    }
});

MultipartBody.Part body = MultipartBody.Part.createFormData("file", file.getName(), progressRequestBody);
Call<ResponseBody> call = service.uploadFile(description, body);
call.enqueue(new Callback<ResponseBody>() {
    // 处理响应
});

应用场景

社交媒体：用户上传图片或视频时，显示上传进度。
云存储服务：上传文件到云端时，用户可以看到上传进度。
企业应用：上传文档、报告等文件时，提供进度反馈。

总结

通过Retrofit2和OkHttp的结合，我们可以轻松实现文件上传进度的监控和展示。这不仅提升了用户体验，还为开发者提供了更灵活的网络请求处理方式。希望本文能帮助大家在实际项目中更好地应用Retrofit2进行文件上传。