Retrofit实现文件上传和下载【二】

概述

通过前一篇的博客介绍,我们已经对Retrofit的使用有了一个大概的了解,今天来讲讲利用Retrofit进行文件的上传和下载

文件上传

服务器使用的是SSH框架,因此这里是以struts2的方式来获取数据的,我这里定义了三个字段用来接收上传过来的数据

private File file;//获取单个文件
private File[] files;//获取多个文件
private String description;

单文件上传

先定义咱们的接口

@Multipart
@POST("user!getFile")
//description表示key
Call<RequestBody> upFile(@Part("description") RequestBody description, @Part MultipartBody.Part file);

解释:@Multipart表示请求发送multipart数据，需要配合@Part一起使用，MultipartBody.Part用来封装需要上传的文件,RequestBody用来封装一段文字

下面来看看具体实现

 //把file封装到RequestBody中
RequestBody requestFile = RequestBody.create(MediaType.parse("multipart/form-data"), files[0]);
//再把RequestBody封装到MultipartBody.Part中,第一个参数file就是和服务器约定的key
MultipartBody.Part body = MultipartBody.Part.createFormData("file", files[0].getName(), requestFile);
String descriptionString = "hello, 这是文件描述";
RequestBody description = RequestBody.create(MediaType.parse("multipart/form-data"), descriptionString);
Call<RequestBody> call = fileService.upFile(description, body);

多文件上传

在介绍多文件上传前,先对RequestBody、MultipartBody、MultipartBody.Builder、MultipartBody.Part这几个类作一个简单说明,方便我们对下面的代码有一个清晰的认识

1.RequestBody是MultipartBody的父类
2.MultipartBody.Part通过createXXX方法来创建请求用的数据
3.MultipartBody.Part可以传入RequestBody对象来创建请求用的数据
4.MultipartBody.Builder可以添加多个MultipartBody.Part
5.通过MultipartBody.Builder的build()方法返回MultipartBody对象
6.RequestBody的create(MediaType contentType, File file)方法,把File封装到请求体中
详细内容可以去看看okhttp的API

多文件的上传大致有三种形式:
1.第一种方法(太Low不可取)

@Multipart
@POST("user!getFiles")
Call<RequestBody> upFile(@Part("description") RequestBody description, @Part MultipartBody.Part file1,@Part MultipartBody.Part file2,@Part MultipartBody.Part file3);

这种实现方式和单文件差不多，这里就不再赘述了
2.第二种方法

@Multipart
@POST("user!getFiles")
Call<RequestBody> upFiles(@Part("files") MultipartBody files);

@Multipart
@POST("user!getFiles")
Call<RequestBody> upFiles(@Part("files") RequestBody files);

解释:这两种形式其实就是一种啦,下面介绍MultipartBody的实现方式,files对应服务器里的key

MultipartBody.Builder builder = new MultipartBody.Builder();
for(int i = 0; i < files.length; ++i){
    RequestBody requestFile = RequestBody.create(MediaType.parse("multipart/form-data"), files[i]);
    builder.addFormDataPart("file", files[i].getName(), requestFile);
}
Call<RequestBody> call = fileService.upFiles(builder.build());

解释:这里的file不是服务器的key
3.第三种方法

@Multipart
@POST("user!getFiles")
Call<RequestBody> upFiles(@PartMap Map<String,RequestBody> files);

Map里的String里存了key,但不仅仅有Key,还包括了别的

Map<String, RequestBody> map = new HashMap<>();
for (int i = 0; i < files.length; ++i) {
    RequestBody requestFile = RequestBody.create(MediaType.parse("multipart/form-data"), files[i]);
    //files 对应服务器那边的key,具体写法就是下面这种形式
    map.put("files\"; filename=\"" + files[i].getName(), requestFile);
}
Call<RequestBody> call = fileService.upFiles(map);

文件下载

@GET("user!downloadFile")
//需要注意这里传入的是ResponseBody而不是之前的RequestBody
Call<ResponseBody> downloadFile();

具体实现和普通请求差不多,最后通过response.body().byteStream()获取到InputStream以后,通过流的方式把文件写到本地,需要注意的是当文件过大的时候,需要在下载文件的方法上添加@Streaming注解