最近項(xiàng)目需要做文件批量上傳的進(jìn)度監(jiān)聽(tīng)，這也就是一個(gè)常見(jiàn)的需求。但是項(xiàng)目中用的是Retrofit，官方并沒(méi)有提供此類的API，于是只能Google啦。找了一圈，資源很少，僅僅找到了幾篇單文件上傳的進(jìn)度監(jiān)聽(tīng)，不能直接ctrl+c ctrl+v啦，只有自己用笨辦法，稍微封裝一下。
PS:本人習(xí)慣在代碼中分析，總結(jié)性的文字很少。
由于沒(méi)有測(cè)試接口，于是就使用項(xiàng)目中的上傳接口。先貼一張最終實(shí)現(xiàn)的效果圖。
以上是公司的項(xiàng)目錄的gif，錄的不太流暢，信息都是事先填好的，湊活看看吧。由于是內(nèi)部使用的app，所以界面是真的丑啊。。。
廢話說(shuō)太多了，正式開(kāi)始吧。
批量上傳
從效果圖可以看到，客戶簽字完畢后，取車成功就是上傳操作了。需求是要將之前所有信息全部上傳到服務(wù)器，包含了文字和大量的圖片（所有字段都填滿，最多可以達(dá)到上百?gòu)垼ｊP(guān)于Retrofit的批量上傳，我使用的是Multipart，具體使用請(qǐng)自行百度Google，這里簡(jiǎn)要貼一下代碼。
先貼出Api接口代碼，info字段為將所有文字參數(shù)封裝成的json串上傳：
//上傳取車信息
@Multipart
@POST("reportgetcarlisttoservice.tag")
Observable<CheckBaseBean> uploadGetCarData(@Part("info") RequestBody info,
@PartMap Map<String, RequestBody> imgs);
（上傳部分代碼較長(zhǎng)，篩選了關(guān)鍵部分的代碼貼出來(lái)）
public void upload() {
//檢測(cè)上傳參數(shù)完整性 略
...
//開(kāi)啟一個(gè)線程 由于涉及大量圖片的信息，壓縮等耗時(shí)操作，開(kāi)啟一個(gè)線程處理是必須的
new Thread(() -> {
//文字參數(shù)
UploadGetCarDataRequest request = new UploadGetCarDataRequest();
request.orderkey = Session.currentOrderKey;
if (Integer.parseInt(Session.currentOrderStatus) >= 33 && Integer.parseInt(Session.currentOrderStatus) != 34) {
request.orderstate = Integer.parseInt(Session.currentOrderStatus);
} else {
request.orderstate = 33;
}
request.sgwxsm = spotData.getWeixiushuoming();
request.fsgwxsm = spotData.getFeiweixiushuoming();
...
request.remark = otherData.getBeizhu();
request.deleteimages = updateGetCarInfo.getDelete_imgs();
//使用Map存儲(chǔ)RequestBody，打包上傳圖片
Map<String, RequestBody> bodyMap = new HashMap<>();
//判斷圖片若以http開(kāi)頭，則表示服務(wù)器圖片（已經(jīng)上傳過(guò)），則不必上傳，反之本地圖片壓縮后上傳
if (!spotData.getMenpai().startsWith("http")) {
if (!new File(spotData.getMenpai()).exists()) {
Message m = Message.obtain();
m.what = 3;
m.obj = "接車門牌地址照片有問(wèn)題，請(qǐng)檢查";
mHandler.sendMessage(m);
return;
}
//checkFile方法為檢驗(yàn)圖片大小，若大于200k，則壓縮到200k以下，節(jié)省上傳流量和時(shí)間
File menpai = checkFile(new File(spotData.getMenpai()));
bodyMap.put("0" + "-0-0\";filename=\"" + menpai.getName(), new UploadFileRequestBody(RequestBody.create(MediaType.parse("image/png"), menpai), mProgressListener, Constant.GET_MEN_PAI + ""));
totalLength += menpai.length();
}
...
mSubscription = GoldKeyRetrofit.getDefaultRetrofit(mContext)
.create(GoldKeyService.class)
//文字參數(shù)轉(zhuǎn)換成json串上傳，RequestFactory是我自己封裝的將Request轉(zhuǎn)換為json的類
.uploadGetCarData(RequestBody.create(MediaType.parse("application/json"), RequestFactory.getInstance().getParams(request)), bodyMap)
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Observer<CheckBaseBean>() {
@Override
public void onCompleted() {
}
@Override
public void onError(Throwable e) {
mView.showToast("上傳失敗，請(qǐng)檢查網(wǎng)絡(luò)是否通暢");
mView.showUploadProgress(0, ProgressView.STATE_FAILURE);
isFinish = true;
}
@Override
public void onNext(CheckBaseBean checkBaseBean) {
if (checkBaseBean.sign) {
mView.showToast("上傳成功");
mView.showUploadProgress(100, ProgressView.STATE_SUCCESS);
mHandler.sendEmptyMessageDelayed(2, 2000);
isFinish = true;
clearDB();
clearCache();
// mView.backToMain();
} else {
mView.showUploadProgress(0, ProgressView.STATE_FAILURE);
mView.showToast("上傳失敗，請(qǐng)反饋給開(kāi)發(fā)人員，謝謝");
isFinish = true;
}
}
});
}).start();
}
}
批量上傳就先說(shuō)到這里，其實(shí)講了等于沒(méi)講，不懂的依然是不懂，哈哈。
上傳進(jìn)度監(jiān)聽(tīng)
仔細(xì)說(shuō)一下這一塊。
以前做上傳的時(shí)候，用的是Xutils框架，其提供了上傳和下載的進(jìn)度監(jiān)聽(tīng)，而強(qiáng)大的Retrofit居然沒(méi)有提供相關(guān)的Api，好蛋疼。
百度了一下相關(guān)的資料，發(fā)現(xiàn)大多數(shù)都是模仿Retrofit官方提供的ChunkingConverter，寫一個(gè)轉(zhuǎn)換器來(lái)監(jiān)聽(tīng)進(jìn)度。剛開(kāi)始我也是采用這種思路，想通過(guò)封裝一個(gè)Converter來(lái)監(jiān)聽(tīng)多文件上傳的進(jìn)度。但是開(kāi)發(fā)過(guò)程中碰到了幾個(gè)坑。首先，添加轉(zhuǎn)換器是通過(guò)Retrofit.Builder創(chuàng)建Retrofit實(shí)例時(shí)添加的，而這個(gè)實(shí)例我們通常使用的是單例，其他接口又沒(méi)必要添加這個(gè)轉(zhuǎn)換器，所以要使用上傳監(jiān)聽(tīng)必須重新new一個(gè)Retrofit實(shí)例，很麻煩。第二，Converter只能拿到單個(gè)RequestBody的數(shù)據(jù)，但是要實(shí)現(xiàn)多文件的監(jiān)聽(tīng)，很麻煩。第三，大姨夫來(lái)了，很煩。
于是換個(gè)思路，既然converter是通過(guò)監(jiān)聽(tīng)RequestBody獲取其已寫的字節(jié)，那么我們?yōu)槭裁床恢苯臃庋b一個(gè)RequsetBody，直接返回這些數(shù)據(jù)呢？
首先，先定義一個(gè)回調(diào)接口：
public interface ProgressListener {
//要是單文件上傳，就不必再根據(jù)字節(jié)去計(jì)算了，直接在requestbody中計(jì)算好進(jìn)度直接返回
void onProgress(int progress, String tag);
//處理多文件時(shí)，需要獲取每個(gè)文件的即時(shí)上傳量來(lái)計(jì)算整體的進(jìn)度
void onDetailProgress(long written, long total, String tag);
}
先貼出自己封裝的UploadFileRequestBody:
public class UploadFileRequestBody extends RequestBody {
private RequestBody mRequestBody;
private ProgressListener mProgressListener;
private BufferedSink bufferedSink;
//每個(gè)RequestBody對(duì)應(yīng)一個(gè)tag，存放在map中，保證計(jì)算的時(shí)候不會(huì)出現(xiàn)重復(fù)
private String tag;
public UploadFileRequestBody(File file, ProgressListener progressListener, String tag) {
this.mRequestBody = RequestBody.create(MediaType.parse("multipart/form-data"), file);
this.mProgressListener = progressListener;
this.tag = tag;
}
//其實(shí)只是添加一個(gè)回調(diào)和tag標(biāo)識(shí)，實(shí)際起作用的還是requestBody
public UploadFileRequestBody(RequestBody requestBody, ProgressListener progressListener, String tag) {
this.mRequestBody = requestBody;
this.mProgressListener = progressListener;
this.tag = tag;
}
//返回了requestBody的類型，想什么form-data/MP3/MP4/png等等等格式
@Override
public MediaType contentType() {
return mRequestBody.contentType();
}
//返回了本RequestBody的長(zhǎng)度，也就是上傳的totalLength
@Override
public long contentLength() throws IOException {
return mRequestBody.contentLength();
}
@Override
public void writeTo(BufferedSink sink) throws IOException {
if (bufferedSink == null) {
//包裝
bufferedSink = Okio.buffer(sink(sink));
}
//寫入
mRequestBody.writeTo(bufferedSink);
//必須調(diào)用flush，否則最后一部分?jǐn)?shù)據(jù)可能不會(huì)被寫入
bufferedSink.flush();
}
private Sink sink(Sink sink) {
return new ForwardingSink(sink) {
//當(dāng)前寫入字節(jié)數(shù)
long bytesWritten = 0L;
//總字節(jié)長(zhǎng)度，避免多次調(diào)用contentLength()方法
long contentLength = 0L;
@Override
public void write(Buffer source, long byteCount) throws IOException {
super.write(source, byteCount);
if (contentLength == 0) {
//獲得contentLength的值，后續(xù)不再調(diào)用
contentLength = contentLength();
}
//增加當(dāng)前寫入的字節(jié)數(shù)
bytesWritten += byteCount;
//回調(diào)上傳接口
mProgressListener.onProgress((int) ((double) bytesWritten / (double) contentLength) * 100, tag);
mProgressListener.onDetailProgress(bytesWritten, contentLength, tag);
}
};
}
}
在上傳過(guò)程中，我們可以通過(guò)ProgressListener接口實(shí)時(shí)拿到每個(gè)RequestBody上傳的字節(jié)數(shù)。我們的需求是計(jì)算出所有文件上傳的總進(jìn)度。其實(shí)就是要計(jì)算出 （所有文件已上傳的大小）/（所有文件的累加大小）。分母上文件總大小我們可以在創(chuàng)建RequestBody時(shí)，使用一個(gè)long變量，將每個(gè)file.length()累加，即可得到。分子上的已上傳大小是要由回調(diào)中的bytesWritten參數(shù)統(tǒng)計(jì)而得。我們使用一個(gè)Map來(lái)記錄每個(gè)文件的上傳大小，通過(guò)標(biāo)識(shí)tag來(lái)區(qū)分每個(gè)文件：
private Map<String, Long> mProgresses2 = new HashMap<>();
private void upload(){
...
File menpai = checkFile(new File(spotData.getMenpai()));
//創(chuàng)建UploadFileRequestBody對(duì)象，傳入tag（保證不同）
bodyMap.put("0" + "-0-0\";filename=\"" + menpai.getName(), new UploadFileRequestBody(RequestBody.create(MediaType.parse("image/png"), menpai), mProgressListener, Constant.GET_MEN_PAI + ""));
//totalLength記錄文件總大小 （記得在每次執(zhí)行上傳時(shí)，重置為0L）
totalLength += menpai.length();
...
}
由于進(jìn)度回調(diào)處理方式是可以統(tǒng)一處理的，所以所有的RequestBody都使用同一個(gè)mProgressListener:
mProgressListener = new ProgressListener() {
@Override
public void onProgress(int progress, String tag) {
}
@Override
public void onDetailProgress(long written, long total, String tag) {
//回調(diào)做的唯一事情就是實(shí)時(shí)更新這個(gè)Map
mProgresses2.put(tag, written);
}
};
我們遍歷整個(gè)map，累加所有的value值，便是當(dāng)前所有的上傳大小了，即拿到了最終要得到的上傳進(jìn)度。接下來(lái)要做的就是更新UI，顯示這個(gè)進(jìn)度了，我們可以開(kāi)啟一個(gè)線程循環(huán)更新，也可以通過(guò)handler。我這里采用的是handler：
private Handler mHandler = new Handler() {
@Override
public void handleMessage(Message msg) {
//isFinish是一個(gè)非常關(guān)鍵的標(biāo)記位，記錄是否還需要發(fā)送消息（在取消上傳，或者上傳成功失敗后，置為true），若沒(méi)有這個(gè)標(biāo)記位，將在后臺(tái)無(wú)限執(zhí)行handleMessage。
if (msg.what == 1 && !isFinish) {
//統(tǒng)計(jì)已上傳的大小
long sum = 0;
for (long p : mProgresses2.values()) {
sum += p;
}
//計(jì)算整體的進(jìn)度 注意這里涉及到兩個(gè)long類型相除的問(wèn)題，若不先轉(zhuǎn)換為float類型，則商為0 去尾操作保證了99.9%屬于并沒(méi)有上傳完成的范疇
int p = 0;
if (totalLength != 0) {
p = (int) Math.floor((float) sum / (float) totalLength * 100);
}
//通知View層更新ProgressView的狀態(tài)（自定義的一個(gè)進(jìn)度View）
mView.showUploadProgress(p, ProgressView.STATE_LOADING);
//每0.1秒更新一次UI
mHandler.sendEmptyMessageDelayed(1, 100);
} else if (msg.what == 2) {
//what=2代表上傳成功后 延遲兩秒自動(dòng)回到主頁(yè)的操作
isFinish = true;
mView.dismissDialog();
mView.backToMain();
} else if (msg.what == 3) {
//what=3為檢查出圖片有誤，取消上傳的操作
mView.showToast(msg.obj.toString());
mView.showUploadProgress(0, ProgressView.STATE_FAILURE);
isFinish = true;
//取消訂閱方法 即取消上傳請(qǐng)求
unSubscribe();
}
}
};
@Override
public void unSubscribe() {
if (mSubscription != null) {
if (!mSubscription.isUnsubscribed()) {
mSubscription.unsubscribe();
isFinish = true;
}
} else {
canStart = false;
isFinish = true;
}
}
上傳成功的即onNext回調(diào)只要執(zhí)行上傳成功的操作：
@Override
public void onNext(CheckBaseBean checkBaseBean) {
//sign服務(wù)器返回的狀態(tài)值true為成功
if (checkBaseBean.sign) {
mView.showToast("上傳成功");
mView.showUploadProgress(100, ProgressView.STATE_SUCCESS);
//延遲兩秒后回調(diào)主頁(yè)
mHandler.sendEmptyMessageDelayed(2, 2000);
//操作已完成 無(wú)需更新UI isFinish置為true
isFinish = true;
//上傳成功后清除本地?cái)?shù)據(jù)庫(kù)緩存
clearDB();
clearCache();
// mView.backToMain();
} else {
mView.showUploadProgress(0, ProgressView.STATE_FAILURE);
mView.showToast("上傳失敗，請(qǐng)反饋給開(kāi)發(fā)人員，謝謝");
isFinish = true;
}
}
小結(jié)
本人不善表達(dá)，水平也很臭，大家見(jiàn)諒。由于工作忙，難以擠出時(shí)間擇代碼，直接使用項(xiàng)目中的代碼，因此代碼很臃腫，并不能簡(jiǎn)潔地展示具體過(guò)程。本文僅僅提供一個(gè)思路，具體的實(shí)現(xiàn)相信大家都能自己將其封裝到自己的項(xiàng)目中，畢竟每個(gè)項(xiàng)目的需求不同，實(shí)現(xiàn)方式也會(huì)有差異。
