Rx系列<第三十三篇>：Retrofit2之上传和下载

本文是RxJava<第三十二篇>：RxJava+Retrofit+OkHttp+MVP的扩展，着重分析单文件上传、单文件下载。

本章重点想展示一下上传和下载的进度是如何实现的，后续会推出一个完整封装：RxJava+RxBinding+Retrofit+OkHttp+MVP+Dagger2来实现get请求、post请求、单文件上传、单文件下载、多文件上传、多文件下载

（1）Retrofit+OkHttp实现文件上传

第一步 自定义带进度条文件体

/**
 * 带进度条的RequestBody封装
 */
public class ProgressRequestBody extends RequestBody {

    private File mFile;
    private String mMediaType;//文件类型
    private UploadResultListener mListener;//上传结果回调监听
    private int bufferSize = 1024;//缓存大小

    public ProgressRequestBody(final File file, String mediaType, final UploadResultListener listener) {
        mFile = file;
        mMediaType = mediaType;
        mListener = listener;
    }

    public ProgressRequestBody(final File file, String mediaType, int eachBufferSize, final UploadResultListener listener) {
        mFile = file;
        mMediaType = mediaType;
        bufferSize = eachBufferSize;
        mListener = listener;
    }

    @Override
    public MediaType contentType() {
        return MediaType.parse(mMediaType);
    }

    @Override
    public void writeTo(BufferedSink sink) throws IOException {
        long fileLength = mFile.length();
        byte[] buffer = new byte[bufferSize];
        FileInputStream in = new FileInputStream(mFile);
        long uploaded = 0;
        try {
            int read;
            Handler handler = new Handler(Looper.getMainLooper());
            while ((read = in.read(buffer)) != -1) {
                handler.post(new ProgressUpdate(uploaded, fileLength));
                uploaded += read;
                sink.write(buffer, 0, read);
            }
        } finally {
            in.close();
        }
    }

    private class ProgressUpdate implements Runnable {
        private long mUploaded;
        private long mTotal;
        public ProgressUpdate(long uploaded, long total) {
            mUploaded = uploaded;
            mTotal = total;
        }

        @Override public void run() {
            mListener.onProgressChange((int) (100 * mUploaded / mTotal));
        }
    }
}

第二步 上传文件结果回调监听

/**
 * 上传文件监听接口
 */
public interface UploadResultListener {

    void onProgressChange(int percent);//进度变化回调
    void onFinish();//上传完成回调
    void onInterrupted();//上传中断回调

}

第三步 retrofit接口定义

    public interface FileAPIService {
    
            //文件上传
            @Multipart
            @POST("FileUpload/FileUploadServlet")
            Call<ResponseBody> uploadFlie(@Part MultipartBody.Part file);
    
    
    }

第四步 实现

    UploadResultListener uploadResultListener = new UploadResultListener() {
        @Override
        public void onProgressChange(int percent) {
            //进度条更新
            Log.d("aaa", "percent:"+percent + "%");
            ((TextView)findViewById(R.id.result_text1)).setText("当前上传进度：" + percent + "%");
        }

        @Override
        public void onFinish() {
            //上传完成
            ((TextView)findViewById(R.id.result_text1)).setText("上传完成");
        }

        @Override
        public void onInterrupted() {
            //上传中断
            ((TextView)findViewById(R.id.result_text1)).setText("上传失败");
        }
    };

    findViewById(R.id.bt_1).setOnClickListener(new View.OnClickListener() {
        @Override
        public void onClick(View v) {
            //单文件上传

            Retrofit retrofit = new Retrofit.Builder()
                    .baseUrl("http://192.168.0.105:8080")
                    .build();
            FileAPIService fileAPIService = retrofit.create(FileAPIService.class);

            File file = new File(Environment.getExternalStorageDirectory() + File.separator + "myapk.apk");

            // 创建 RequestBody
            ProgressRequestBody progressRequestBody = new ProgressRequestBody(file, "application/otcet-stream", uploadResultListener);

            //新建Part
            MultipartBody.Part body = MultipartBody.Part.createFormData("myapk", file.getName(), progressRequestBody);

            Call<ResponseBody> call = fileAPIService.uploadFlie(body);
            call.enqueue(new Callback<ResponseBody>() {
                @Override
                public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {
                    if(response != null && response.isSuccessful()){
                        uploadResultListener.onFinish();
                    }else{
                        uploadResultListener.onInterrupted();
                    }
                }

                @Override
                public void onFailure(Call call, Throwable t) {
                    uploadResultListener.onInterrupted();
                }
            });

        }
    });

总体四步就可以实现文件的上传，其中第一步是带进度上传文件的核心。

效果如下：

图片.png

（2）Retrofit+OkHttp实现文件下载

第一步 下载结果回调监听

public interface DownloadResultListener {

    void onProgressChange(int percent);//进度变化回调
    void onFinish();//下载完成回调
    void onInterrupted();//下载中断回调

}

第二步 retrofit接口定义

public interface FileAPIService {


    @Streaming
    @GET("/1.apk")
    Call<ResponseBody> downloadFile();
}

第三步 实现

    DownloadResultListener downloadResultListener = new DownloadResultListener() {
        @Override
        public void onProgressChange(int percent) {
            //进度条更新
            ((TextView)findViewById(R.id.result_text2)).setText("当前下载进度：" + percent+ "%");
        }

        @Override
        public void onFinish() {
            //上传完成
            ((TextView)findViewById(R.id.result_text2)).setText("下载完成");
        }

        @Override
        public void onInterrupted() {
            //上传中断
            ((TextView)findViewById(R.id.result_text2)).setText("下载失败");
        }
    };

    findViewById(R.id.bt_2).setOnClickListener(new View.OnClickListener() {
        @Override
        public void onClick(View v) {
            //文件下载
            Retrofit retrofit = new Retrofit.Builder().baseUrl("http://192.168.0.105:8080").build();
            FileAPIService searchFileAPIService = retrofit.create(FileAPIService.class);
            Call<ResponseBody> call = searchFileAPIService.downloadFile();
            call.enqueue(new Callback<ResponseBody>() {
                @Override
                public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {
                    if(response != null && response.isSuccessful()){
                        new Thread(new Runnable() {
                            @Override
                            public void run() {
                                boolean writtenToDisk = writeResponseBodyToDisk(response.body(), downloadResultListener);
                                downloadResultListener.onFinish();
                            }
                        }).start();

                    }
                }

                @Override
                public void onFailure(Call<ResponseBody> call, Throwable t) {
                    downloadResultListener.onInterrupted();
                }
            });
        }
    });

//写入到磁盘根目录
private boolean writeResponseBodyToDisk(ResponseBody body, DownloadResultListener downloadResultListener) {
    try {
        File futureStudioIconFile = new File(Environment.getExternalStorageDirectory() + File.separator + "mydownloadapk.apk");
        InputStream inputStream = null;
        OutputStream outputStream = null;

        try {
            byte[] fileReader = new byte[4096];

            int fileSize = (int) body.contentLength();
            int 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;


                final int finalFileSizeDownloaded = fileSizeDownloaded;
                runOnUiThread(new Runnable() {
                    @Override
                    public void run() {
                        downloadResultListener.onProgressChange(100 * finalFileSizeDownloaded / fileSize);
                    }
                });
            }

            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;
    }
}

效果如下：

图片.png

补充：

上传文件时，如果还需要传参，写法如下：

//文件上传
//@Multipart
@POST("/{uploadUrl}")
Call<ResponseBody> uploadFlie(@Path(value = "uploadUrl") String uploadUrl, @Body RequestBody body);

注意，如果仅仅上传文件，不上传参数，那么直接使用@Multipart注解即可，那么如果一定要在上传文件的同时再上传参数，那么需要传递一个RequestBody，@Body不能和@Multipart一起使用，所以要去除@Multipart。

            File file = new File(Environment.getExternalStorageDirectory() + File.separator + "pic2.jpg");
            ProgressRequestBody progressRequestBody = new ProgressRequestBody(file, "multipart/form-data", uploadResultListener);
            RequestBody body=new MultipartBody.Builder()
                    .setType(MultipartBody.FORM)
                    .addFormDataPart("file",file.getName(),progressRequestBody)
                    .addFormDataPart("xxx","shareimage")
                    .addFormDataPart("ooo","weqwewq")
                    .addFormDataPart("qqq",String.valueOf(System.currentTimeMillis()))
                    .addFormDataPart("eee",String.valueOf(0))
                    .addFormDataPart("rrr",String.valueOf(1))
                    .build();
            Call<ResponseBody> call = fileAPIService.uploadFlie("upload.cgi", body);
            call.enqueue(new Callback<ResponseBody>() {

以上代码尤其要注意的是，需要和服务器确认所支持的mediaType有两个地方：

确认请求体本身的mediaType

              .setType(MultipartBody.FORM)//就是"multipart/form-data"

确认上传文件的mediaType（上传文件一般使用二进制流编码方式：multipart/form-data）

new ProgressRequestBody(file, "multipart/form-data", uploadResultListener);

以上两处mediaType都是需要和服务器相关人员确认的，如果服务器相关人员也不确认，那么只能我们自己去一一尝试了，再尝试之前，必须了解常用的mediaType有哪些？

下面说一说常用的mediaType：

流的形式：上传和下载

        //multipart/form-data:所有的数据以二进制流发送，此种方式多用于文件上传
        //application/otcet-stream:所有的数据以八进制流发送，目测下载文件有效

默认情况

一般默认mediaType如下

//application/x-www-form-urlencoded:默认值，不写就是这个，retrofit 的表单默认也是这个，不能用来传文件

但如果是上传文件的话，默认mediaType可能是

multipart/mixed

其它情况

          //text/plain:纯文本格式
          //application/json:body是一个json

[本章完...]

最后编辑于：2020.03.14 13:36:13

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 204,445评论 6赞 478
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 85,889评论 2赞 381
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 151,047评论 0赞 337
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 54,760评论 1赞 276
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 63,745评论 5赞 367
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 48,638评论 1赞 281
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 38,011评论 3赞 398
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 36,669评论 0赞 258
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 40,923评论 1赞 299
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 35,655评论 2赞 321
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 37,740评论 1赞 330
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 33,406评论 4赞 320
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 38,995评论 3赞 307
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 29,961评论 0赞 19
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 31,197评论 1赞 260
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 45,023评论 2赞 350
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 42,483评论 2赞 342

Rx系列<第三十三篇>：Retrofit2之上传和下载

（1）Retrofit+OkHttp实现文件上传

（2）Retrofit+OkHttp实现文件下载

推荐阅读更多精彩内容