因项目重构需要,最近一直在研究Retrofit的使用,并且封装成适合自己项目的网络请求框架。因为我们的项目中已经和后台约定,所有请求都使用POST请求,并且只接受JSON格式的参数,返回结果也是JSON格式。因此,我要封装的网络请求框架只需考虑三种请求:
- Post with JSON, 就是向后台提交JSON数据
- Upload with progress,就是实现带进度回调的文件上传
- Download with progress,就是实现带进度回调的文件下载
第一种请求在Retrofit2提交JSON格式数据 已做简要说明,现在来说说第二种请求,上传文件。上传文件的需求一般包含但不仅限于
- 上传单文件(如 上传头像)
- 上传多文件(如 上传几张APP截图)
- 表单+多文件(PC Web时代经常使用,如 提交注册信息+身份证照片)
这里要说明的是,上传头像可能使用图片请求框架会专业一点,这个不是本文讨论的重点。重点是,你总要为自己的网络请求框架提供起码是上传单文件功能,就是不带描述信息,只有个默认的关键字“file”的那种。
在阅读了Retrofit推荐的入门教程Retrofit 2 — How to Upload Files to Server后,确实简单实现了自己的上传文件API。
public interface ApiService {
//接口定义
@Multipart
@POST
Call<ResponseBody> upload(@Url String url, @HeaderMap Map<String, String> headers, @Part MultipartBody.Part file);
}
使用时
MediaType mediaType = MediaType.parse("multipart/form-data");
RequestBody originalRequestBody = RequestBody.create(mediaType, mUploadedFile);
MultipartBody.Part body =MultipartBody.Part.createFormData("file", mUploadedFile.getName(), originalRequestBody);
HttpRequest.sApiService.upload(mUrl, mHeaderMap,body);
这样很简单,所以接下来是考虑上传进度。网上有人说使用拦截器,也有人说包装RequestBody。对于后者,大部分技术博客中的使用代码是这样的。
//把回调传进去,实现进度回调
FileRequestBody fileRequestBody = new FileRequestBody(originalRequestBody, mCallback);
MultipartBody.Part body =MultipartBody.Part