Retrofit2文件上传与下载

Retrofit2文件上传与下载通俗易懂教程。

之前在使用retrofit的时候,遇到文件上传和下载的功能,搜索了好久才完成功能,搜索的有很多都让人困惑,更有些写的让人绝望,我就想着自己写一篇简单易懂的,请继续往下看。

源码地址

点击即达
https://github.com/QiaoYang0923/RetrofitDownloadAndUpLoading

文件上传:(包括多文件上传)

第一步:创建服务返回数据的bean类;(此处服务器返回的是json字符串);

public class BaseBean{

/**
 * Code : 1
 * Msg : 操作成功
 * Data : null
 */

/**
 * 状态码
 */
private int Code;
/**
 * 提示信息
 */
private String Msg;
/**
 * 组合信息
 */
private String Data;
//...setget方法

}

第二步:创建用于描述网络请求的接口

public interface Api {

/**
 * 上传
 * Multipart 这个注解代表多表单上传
 * @param partList 表单信息
 * @return .
 */
@Multipart
@POST("服务器地址(就创建retrofit设置的基站地址后面的具体地址)")
Call upLoading(@Part List partList);

}

第三步:创建表单,里面存储服务器本接口所需要的数据;

参数添加

    MultipartBody.Builder builder = new MultipartBody.Builder()
            .setType(MultipartBody.FORM)
            //在这里添加服务器除了文件之外的其他参数
            .addFormDataPart("参数1", "值1")
            .addFormDataPart("参数2", "值2");

创建文件(你需要上传到服务器的文件)

    File file = new File(file1Location); //file1Location文件的路径 ,我是在手机存储根目录下创建了一个文件夹,里面放着了一张图片;                   

设置文件的格式

    RequestBody imageBody = RequestBody.create(MediaType.parse("multipart/form-data"), file);
    //添加文件(uploadfile就是你服务器中需要的文件参数)
    builder.addFormDataPart("uploadfile", file.getName(), imageBody);           

生成接口需要的list

    List parts = builder.build().parts();

创建设置OkHttpClient

    OkHttpClient okHttpClient = new OkHttpClient.Builder()
            .connectTimeout(20, TimeUnit.SECONDS)
            .readTimeout(20, TimeUnit.SECONDS)
            .writeTimeout(20, TimeUnit.SECONDS)
            //允许失败重试
            .retryOnConnectionFailure(true)
            .build();

创建retrofit实例对象

    Retrofit retrofit = new Retrofit.Builder()
            //设置基站地址(基站地址+描述网络请求的接口上面注释的Post地址,就是要上传文件到服务器的地址,
            // 这只是一种设置地址的方法,还有其他方式,不在赘述)
            .baseUrl("你的基站地址")
            //设置委托,使用OKHttp联网,也可以设置其他的;
            .client(okHttpClient)
            //设置数据解析器,如果没有这个类需要添加依赖:
            .addConverterFactory(GsonConverterFactory.create())
            //设置支持rxJava
            // .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
            .build();

实例化请求接口,把表单传递过去;

    Call call = retrofit.create(Api.class).upLoading(parts);
    //开始请求
    call.enqueue(new Callback() {
        @Override
        public void onResponse(Call call, Response response) {
            //联网有响应或有返回数据
            System.out.println(response.body().toString());
        }

        @Override
        public void onFailure(Call call, Throwable t) {
            //连接失败,多数是网络不可用导致的
            System.out.println("网络不可用");
        }
    });
}

这就ok了,单个文件上传完毕!

多文件上传(以两个文件为例)

对比一个文件,这个只需要在[设置文件的格式] 这一步,多添加一个即可;

    RequestBody imageBody = RequestBody.create(MediaType.parse("multipart/form-data"), file);
    RequestBody imageBody1 = RequestBody.create(MediaType.parse("multipart/form-data"), file1);
    //添加文件(uploadfile就是你服务器中需要的文件参数)
    builder.addFormDataPart("uploadfile", file.getName(), imageBody);
    builder.addFormDataPart("uploadfile1", file1.getName(), imageBody1);

接下来看文件下载ღ

文件下载:

首先还是要在API接口创建一个方法;

 /**
 * 下载文件
 * 如果下载大文件的一定要加上   @Streaming  注解
 *
 * @param fileUrl 文件的路径
 * @return 请求call
 */
@GET
Call download(@Url String fileUrl);

然后就是创建一个retrofit对象,跟上面一样(由于每次创建retrofit对象会用到很多重复的代码,可以抽取成一个公共方法)

实例化请求接口:

 //我在百度上找到一张图片,把他的地址拆分了一下,最后一个斜杠之前的url设置为了baseUrl,斜杠之后设置在这里;
 //地址拆分:    .baseUrl("https://gss3.bdstatic.com/-Po3dSag_xI4khGkpoWK1HF6hhy/baike/w%3D268%3Bg%3D0/sign=e3dc64d05a3d26972ed30f5b6dc0d5c6/")
  //整体地址https://gss3.bdstatic.com/Po3dSag_xI4khGkpoWK1HF6hhy/baike/w%3D268%3Bg%3D0/sign=e3dc64d05a3d26972ed30f5b6dc0d5c6/
  (在这里拆分了)241f95cad1c8a7868a2713146c09c93d70cf509e.jpg
    Call download = retrofit.create(Api.class).download("241f95cad1c8a7868a2713146c09c93d70cf509e.jpg");
    download.enqueue(new Callback() {
        @Override
        public void onResponse(Call call, Response response) {
            if (response != null && response.isSuccessful()) {
            // writeResponseBodyToDisk 是我写的下载保存本地工具类,可以参考一下
                boolean toDisk = writeResponseBodyToDisk(response.body());
                if (toDisk) {
                    System.out.println("下载成功请查看");
                } else {

                    System.out.println("下载失败,请稍后重试");
                }
            } else {
                System.out.println("服务器返回错误");
            }
        }

        @Override
        public void onFailure(Call call, Throwable t) {
            //连接失败,多数是网络不可用导致的
            System.out.println("网络不可用");
        }
    });

writeResponseBodyToDisk

 /**
 * 下载到本地
 *
 * @param body 内容
 * @return 成功或者失败
 */
private boolean writeResponseBodyToDisk(ResponseBody body) {
    try {
        //判断文件夹是否存在
        File files = new File(SD_HOME_DIR);//跟目录一个文件夹
        if (!files.exists()) {
            //不存在就创建出来
            files.mkdirs();
        }
        //创建一个文件
        File futureStudioIconFile = new File(SD_HOME_DIR + "download.jpg");
        //初始化输入流
        InputStream inputStream = null;
        //初始化输出流
        OutputStream outputStream = null;

        try {
            //设置每次读写的字节
            byte[] fileReader = new byte[4096];

            long fileSize = body.contentLength();
            long fileSizeDownloaded = 0;
            //请求返回的字节流
            inputStream = body.byteStream();
            //创建输出流
            outputStream = new FileOutputStream(futureStudioIconFile);
            //进行读取操作
            while (true) {
                int read = inputStream.read(fileReader);

                if (read == -1) {
                    break;
                }
                //进行写入操作
                outputStream.write(fileReader, 0, read);
                fileSizeDownloaded += read;

            }
            //刷新
            outputStream.flush();
            return true;
        } catch (IOException e) {
            return false;
        } finally {
            if (inputStream != null) {
                //关闭输入流
                inputStream.close();
            }

            if (outputStream != null) {
                //关闭输出流
                outputStream.close();
            }
        }
    } catch (IOException e) {
        return false;
    }
}

下载下来的图片展示

如有问题请留言!

全文完!!!