Retrofit2-如何上传文件到服务器

这篇文章主要是讲解如何上传文件到服务器。

原文地址

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<ResponseBody> 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<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());
        }
    });
}

上面的这个片段展示了如何初始化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类型的返回值,我们将接收到的信息当成返回值返回回去。在你看到成功的请求服务端解析返回之前,有一个 nullerr 对象,然后就是请求中的 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来实现这个功能。这篇文章就是引导在实现一个文件上传到服务器中所必需的一些步骤。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,921评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,635评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,393评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,836评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,833评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,685评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,043评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,694评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,671评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,670评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,779评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,424评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,027评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,984评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,214评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,108评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,517评论 2 343

推荐阅读更多精彩内容