这篇文章主要是讲解如何上传文件到服务器。
原文地址
Retrofit 2 — How to Upload Files to Server
使用Retrofit 1.x上传文件
我们已经发布了一篇文章how to upload files using Retrofit 1.x，如果你使用的是1.x版本，可以观看链接的指南。
如果使用的是Retrofit 2，那么下面的就是你需要的内容。
使用Retrofit 2上传文件
这篇文章特意的将上传文件从Retrofit 1.x版本中分离出来，因为上传文件这个操作从1.x版本到2的改变实在是太大了，你需要理解Retrofit 2处理上传文件的方式。
在我们深入到Retrofit 2的上传逻辑之前，我们先简短的回顾一下前面的1.x版本是怎么做的，Retrofit 1使用了一个类 TypedFile 来进行文件上传给服务器。这个类已经在Retrofit 2中移除了，而且，Retrofit 2现在充分利用了 OkHttp 来进行所有的网络请求，所以上传也是用OkHttp的类。
使用Retrofit 2，你要么使用OkHttp的 RequestBody 或者是 MultipartBody.Part，然后把你要上传的文件封装成一个 request body。我们首先来看下面文件上传的接口定义，
public interface FileUploadService {
@Multipart
@POST("upload")
Call upload(@Part("description") RequestBody description,
@Part MultipartBody.Part file);
}
让我来解释上面的每一部分，首先是这个 description 的注解，这个 description 只是一个字符串被包装成了一个 RequestBody ，还有另外一个 @Part 注解中包含的是真正的文件。
我们使用的 MultipartBody.Part 可以让我们上传实际文件名后面的二进制数据。下面这段会展示如何正确的创建一个文件对象。
Android客户端代码
到这里，你已经定义了一个Retrofit必要的service interface，我们会使用 ServiceGenerator 来生成一个service client，我们已经在 Retrofit-开始并创建一个Android客户端 介绍了如何实现一个 ServiceGenerator。
下面的代码片段展示了 uploadFile(Uri fileUri) 方法，其中有一个 fileUri 作为参数，如果你通过一个intent来进行选择文件，那么就会在 onActivityResult() 中返回这个参数。在这个方法中，你会拿到你想要传给 uploadFile 中的存在的uri。
private void uploadFile(Uri fileUri) {
// create upload service client
FileUploadService service =
ServiceGenerator.createService(FileUploadService.class);
// https://github.com/iPaulPro/aFileChooser/blob/master/aFileChooser/src/com/ipaulpro/afilechooser/utils/FileUtils.java
// use the FileUtils to get the actual file by uri
File file = FileUtils.getFile(this, fileUri);
// create RequestBody instance from file
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("picture", file.getName(), requestFile);
// add another part within the multipart request
String descriptionString = "hello, this is description speaking";
RequestBody description =
RequestBody.create(
MediaType.parse("multipart/form-data"), descriptionString);
// finally, execute the request
Call call = service.upload(description, body);
call.enqueue(new Callback() {
@Override
public void onResponse(Call call,
Response response) {
Log.v("Upload", "success");
}
@Override
public void onFailure(Call call, Throwable t) {
Log.e("Upload error:", t.getMessage());
}
});
}
上面的这个片段展示了如何初始化upload的数据并且upload，就像前面所提到的，这个RequestBody 类来自于Okhttp，它的 create() 方法需要两个参数：第一，从 multipart/form-data 解析拿到的media type，第二，就是实际的数据。
记住Content-Type
请注意Retrofit 的content type，如果你拦截了底层的OkHttp而且将content type改成了 application/json，那么你的服务器就会出现反序列化的错误。所以确认你没有定义 header 来指示你发送的是 JSON 数据 而不是 multipart/form-data。
Hapi 上传文件服务示例
如果你已经有了后台的项目，你也依然可以看一下下面的代码示例。我们使用一个简单的 hapi server(译者注：Hapi.js 是一个用来构建基于 Node.js 的应用和服务的富框架，使得开发者把重点放在便携可重用的应用逻辑而不是构建架构。内建输入验证、缓存、认证和其他 Web 应用开发常用的功能。)，加上一个 POST 请求地址 /upload，另外，我们让hapi 不去解析前端来的请求，因为我们使用了一个Node.js的库 multiparty 来做上传文件的解析。在这个解析方法的回调里面，我们将每一块都log打出来看看输出。
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}));
});
}
}
Android 客户端需要一个String类型的返回值，我们将接收到的信息当成返回值返回回去。在你看到成功的请求服务端解析返回之前，有一个 null 是 err 对象，然后就是请求中的 description的数据，最后才是上传的图片的数据 。
Server Log 解析数据
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 } ] }
后记
文件上传是一个基本的功能，你可以在你的app中使用Retrofit来实现这个功能。这篇文章就是引导在实现一个文件上传到服务器中所必需的一些步骤。