RxRetrofit - 終極封裝 - 深刻淺出 & 文件上傳

時間 2019-11-15

標籤 rxretrofit 終極封裝深刻文件上傳欄目軟件設計简体版

原文原文鏈接

背景

在實際運用中上傳是一個必不可少的功能，因此咱們在封裝二的基礎上加入上傳的功能，同時須要附帶上傳進度！html

效果

實現

1.定義service接口

注意：Multipart是指定大文件上傳過程當中的標示，通常上傳圖片的過程當中咱們須要附帶信息，因此咱們須要用到@part指定傳遞的數值，MultipartBody.Part是指定傳遞的文件；java

/*上傳文件*/
    @Multipart
    @POST("AppYuFaKu/uploadHeadImg")
    Observable<BaseResultEntity<UploadResulte>> uploadImage(@Part("uid") RequestBody uid, @Part("auth_key") RequestBody  auth_key,                                                         @Part MultipartBody.Part file);複製代碼

2.加入進度條

retrofit是基於okhttp的處理，因此咱們能夠自定義RequestBody，複寫writeTo(BufferedSink sink)方法，獲得傳遞的進度數據api

public class ProgressRequestBody extends RequestBody {
    //實際的待包裝請求體
    private final RequestBody requestBody;
    //進度回調接口
    private final UploadProgressListener progressListener;
    //包裝完成的BufferedSink
    private BufferedSink bufferedSink;

    public ProgressRequestBody(RequestBody requestBody, UploadProgressListener progressListener) {
        this.requestBody = requestBody;
        this.progressListener = progressListener;
    }
    /** * 重寫調用實際的響應體的contentType * @return MediaType */
    @Override
    public MediaType contentType() {
        return requestBody.contentType();
    }
    /** * 重寫調用實際的響應體的contentLength * @return contentLength * @throws IOException 異常 */
    @Override
    public long contentLength() throws IOException {
        return requestBody.contentLength();
    }
    /** * 重寫進行寫入 * @param sink BufferedSink * @throws IOException 異常 */
    @Override
    public void writeTo(BufferedSink sink) throws IOException {
        if (null == bufferedSink) {
            bufferedSink = Okio.buffer(sink(sink));
        }
        requestBody.writeTo(bufferedSink);
        //必須調用flush，不然最後一部分數據可能不會被寫入
        bufferedSink.flush();
    }
    /** * 寫入，回調進度接口 * @param sink Sink * @return Sink */
    private Sink sink(Sink sink) {
        return new ForwardingSink(sink) {
            //當前寫入字節數
            long writtenBytesCount = 0L;
            //總字節長度，避免屢次調用contentLength()方法
            long totalBytesCount = 0L;
            @Override
            public void write(Buffer source, long byteCount) throws IOException {
                super.write(source, byteCount);
                //增長當前寫入的字節數
                writtenBytesCount += byteCount;
                //得到contentLength的值，後續再也不調用
                if (totalBytesCount == 0) {
                    totalBytesCount = contentLength();
                }
                Observable.just(writtenBytesCount).observeOn(AndroidSchedulers.mainThread()).subscribe(new Action1<Long>() {
                    @Override
                    public void call(Long aLong) {
                        progressListener.onProgress(writtenBytesCount, totalBytesCount);
                    }
                });
            }
        };
    }
}複製代碼

3.自定義接口，回調progress進度

public interface UploadProgressListener {
    /** * 上傳進度 * @param currentBytesCount * @param totalBytesCount */
    void onProgress(long currentBytesCount, long totalBytesCount);
}複製代碼

4.建立RequestBody對象，加入進度

File file=new File("/storage/emulated/0/Download/11.jpg");
      RequestBody requestBody=RequestBody.create(MediaType.parse("image/jpeg"),file);
      MultipartBody.Part part= MultipartBody.Part.createFormData("file_name", file.getName(), new ProgressRequestBody(requestBody,
              new UploadProgressListener() {
          @Override
          public void onProgress(long currentBytesCount, long totalBytesCount) {
              tvMsg.setText("提示:上傳中");
              progressBar.setMax((int) totalBytesCount);
              progressBar.setProgress((int) currentBytesCount);
          }
      }));複製代碼

5.傳遞附帶信息

和封裝二中post請求的方式同樣，咱們須要繼承baseentity，複寫裏面的方法，而後設置須要傳遞的參數，由於是測試接口，因此個人參數直接寫死在entity裏面,part文件動態指定ide

/** * 上傳請求api * Created by WZG on 2016/10/20. */

public class UplaodApi extends BaseEntity {
    /*須要上傳的文件*/
    private MultipartBody.Part part;


    public UplaodApi(HttpOnNextListener listener, RxAppCompatActivity rxAppCompatActivity) {
        super(listener, rxAppCompatActivity);
        setShowProgress(true);
    }

    public MultipartBody.Part getPart() {
        return part;
    }

    public void setPart(MultipartBody.Part part) {
        this.part = part;
    }

    @Override
    public Observable getObservable(HttpService methods) {
        RequestBody uid= RequestBody.create(MediaType.parse("text/plain"), "4811420");
        RequestBody key = RequestBody.create(MediaType.parse("text/plain"), "21f8d9bcc50c6ac1ae1020ce12f5f5a7");
        return methods.uploadImage(uid,key,getPart());
    }
}複製代碼

6.post請求處理

請求和封裝二中的請求同樣，經過傳遞一個指定的HttpOnNextListener 對象來回調來監聽結果信息，一一對應post

private void uploadeDo(){
      File file=new File("/storage/emulated/0/Download/11.jpg");
      RequestBody requestBody=RequestBody.create(MediaType.parse("image/jpeg"),file);
      MultipartBody.Part part= MultipartBody.Part.createFormData("file_name", file.getName(), new ProgressRequestBody(requestBody,
              new UploadProgressListener() {
          @Override
          public void onProgress(long currentBytesCount, long totalBytesCount) {
              tvMsg.setText("提示:上傳中");
              progressBar.setMax((int) totalBytesCount);
              progressBar.setProgress((int) currentBytesCount);
          }
      }));
      UplaodApi uplaodApi = new UplaodApi(httpOnNextListener,this);
      uplaodApi.setPart(part);
      HttpManager manager = HttpManager.getInstance();
      manager.doHttpDeal(uplaodApi);
  }


    /** * 上傳回調 */
    HttpOnNextListener httpOnNextListener=new HttpOnNextListener<UploadResulte>() {
        @Override
        public void onNext(UploadResulte o) {
            tvMsg.setText("成功");
            Glide.with(MainActivity.this).load(o.getHeadImgUrl()).skipMemoryCache(true).into(img);
        }

        @Override
        public void onError(Throwable e) {
            super.onError(e);
            tvMsg.setText("失敗："+e.toString());
        }

    };複製代碼