Retrofit 2.0 超能实践（三），轻松实现文件/多图片上传/Json字符串

时间：2023-03-08 19:45:03

文：http://blog.****.net/sk719887916/article/details/51755427

Tamic 简书&****同步

通过前两篇姿势的入门

本文出自：http://blog.****.net/sk719887916/article/details/51755427 码小白

通过对Retrofit2.0的前两篇的基础入门和案例实践，掌握了怎么样使用Retrofit访问网络，加入自定义header，包括加入SSL证书，基本的调试基础，coolkie同步，但很多需求需要文件的上传，今天主题就来分享怎么用Retrofit2.0 上传文件和图片。

使用 Retrofit1.x上传文件

大家都知道在2.0以前版本上传图片的姿势

 public interface ApiManager {
    @Multipart
    @POST("/user/addCarInfo")
    void addCarInfo(@QueryMap Map<String, Object> options, @Part("file") TypedFile file, Callback<JsonElement> response);

}

使用 Retrofit 2.X 上传

Retrofit 2上传文件

使用2,0，我们发现TypedFile类型被私有化了 ，无法继续使用1.9的传方式无法再上层调用了，可以MultipartBody.Part代替

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

具体用法。

// 创建 RequestBody，用于封装 请求RequestBody
RequestBody requestFile =
        RequestBody.create(MediaType.parse("multipart/form-data"), file);

// MultipartBody.Part is used to send also the actual file name
MultipartBody.Part body =
        MultipartBody.Part.createFormData("image", file.getName(), requestFile);

// 添加描述
String descriptionString = "hello, 这是文件描述";
RequestBody description =
        RequestBody.create(
                MediaType.parse("multipart/form-data"), descriptionString);

// 执行请求
Call<ResponseBody> call = service.upload(description, body);
call.enqueue(new Callback<ResponseBody>() {
    @Override
    public void onResponse(Call<ResponseBody> call,
                           Response<ResponseBody> response) {
        Log.v("Upload", "success");
    }

    @Override
    public void onFailure(Call<ResponseBody> call, Throwable t) {
        Log.e("Upload error:", t.getMessage());
    }
});

}

上报一张图片

@Multipart
 @POST("you methd url upload/")
Call<ResponseBody> uploadFile(
        @Part("avatar\\\\"; filename=\\\\"avatar.jpg") RequestBody file);

上报多张图片

@POST("upload/")
Call<ResponseBody> uploadFiles(@Part("filename") String description,
                                     @Part("pic\\\\"; filename=\\\\"image1.png") RequestBody imgs1,
                                     @Part("pic\\\\"; filename=\\\\"image2.png") RequestBody imgs2,
                                     @Part("pic\\\\"; filename=\\\\"image3.png") RequestBody imgs3,
                                     @Part("pic\\\\"; filename=\\\\"image4.png") RequestBody imgs4);

如果图片数量不确定

  @Multipart
@POST("{url}")
Observable<ResponseBody> uploadFiles(
        @Path("url") String url,
        @Part("filename") String description,
        @PartMap() Map<String, RequestBody> maps);

或者：

@Multipart
@POST("{url}")
Observable<ResponseBody> uploads(
        @Path("url") String url,
        @Part("description") RequestBody description,
        @Part("filekey") MultipartBody.Part file);

图片和参数同时上报

  @Multipart
@POST("upload/")
Call<ResponseBody> register(

                                   @QueryMap Map<String , String> usermaps,
                                   @Part("avatar\\\\"; filename=\\\\"avatar.jpg") RequestBody avatar,
                                   );

此种方式让你很好的解决用户注册问题。包含用户全部信息

上面的代码片段中显示的代码初始化(RequestBody 和description),以及如何使用文件上传服务。正如已经提到的,从OkHttp RequestBody类用于描述。需要两个RequestBody.create（）方法

除了描述,必须将添加文件包装成MultipartBody的实例。这就是你需要使用适当的从客户端上传文件。此外,您可以添加createFormData中的uploadFile(Uri fileUri)方法和重用

设置 Content-Type

请注意设置的内容类型。如果你拦截底层OkHttp客户机和更改内容类型application / json, 你的服务器可能反序列化过程出现的问题。请确保你没有自定义multipart/form-data

upLoad图片也可以具体指明Content-Type 为 “image/jpg”格式的

   RequestBody requestFile =
            RequestBody.create(MediaType.parse("image/jpg"), mFile);

还有常用的:

上传Json

@POST("/uploadJson")
Observable<ResponseBody> uploadjson(
        @Body RequestBody jsonBody);

upLoadJson 也可以具体指明Content-Type 为 “application/json”格式的

具体组装我们的RequestBody则可以这样:

 RequestBody body=
               RequestBody.create(okhttp3.MediaType.parse("application/json; charset=utf-8"), jsonString);

接着可以这样调用：

// 执行请求
Call<ResponseBody> call = service.uploadJson(description, body);
call.enqueue(new Callback<ResponseBody>() {
    @Override
    public void onResponse(Call<ResponseBody> call,
                           Response<ResponseBody> response) {
        Log.v("Upload", "success");
    }

    @Override
    public void onFailure(Call<ResponseBody> call, Throwable t) {
        Log.e("Upload error:", t.getMessage());
    }
});

}

至于服务器返回什么类型的model, 开发者可以自定义 譬如你可以把APi 中的 ResponseBody 指定为你自己的javaBean,当然上层构建Callback的时候也必须是 Call<MyBean>

@POST("/uploadJson")
Observable<MyBean> uploadjson(
        @Body RequestBody jsonBody);

上传文件到服务端示例

如果你已经有你的后端项目, 您可以依靠下面的示例代码。我们使用一个简单api 上传服务器。此外我们告诉api 传入参数的请求,因为我们使用的是Node.js

解析的回调函数,我们记录每个字段来显示其输出。

method: 'POST',
 path: '/upload',
config: {
payload: {
    maxBytes: 209715200,
    output: 'stream',
    parse: false
},
handler: function(request, reply) {
    var multiparty = require('multiparty');
    var form = new multiparty.Form();
    form.parse(request.payload, function(err, fields, files) {
        console.log(err);
        console.log(fields);
        console.log(files);

        return reply(util.inspect({fields: fields, files: files}));
    });
}}

安卓客户端收到返回类型的字符串, 我们将接收到的上传成功的状态的回调。当然你可以处理也可以不处理。

下面你将看到一个成功的请求的输出端和有效载荷的解析。第一个空对象。之后,你可以看到字段只描述作为请求的一部分。接着可以收到文件描述，文件大小，文件昵称和保存路径。

服务器解析有效数据的日志

   Null
  { description: [ 'hello, this is description speaking' ] }
{ picture:
  [ { fieldName: 'picture',
    originalFilename: '20160312_095248.jpg',
    path:      '/var/folders/rq/q_m4_21j3lqf1lw48fqttx_80000gn/T/X_sxX6LDUMBcuUcUGDMBKc2T.jpg',
   headers: [Object],
   size: 39369 } ] }

回顾

文件上传是最新的应用程序中必不可少的功能,你可以将此功能集成在您的应用程序使用翻新。本文指导您完成你的Android设备上报文件到您的后端服务器的第一个步骤。

源码：https://github.com/Tamicer/Novate

Retrofit 2.0系列请阅读简书

更多技术文章请关注码小白

Retrofit 2.0系列请阅读

Retrofit 2.0 超能实践（三），轻松实现文件/多图片上传/Json字符串