什么是分層
app的架構,不管是MVC,MVP,MVVM,架構演變中,貫穿始終的概念都是分層和解耦.那么這個分層和解耦怎么體現出來?
簡單地說就是,我這一層接收上一層的輸入,上一層的你別管我怎么處理,我最終會給你一個輸出/返回值,你完全不用理會我是怎么處理的,只要有輸入,就會有輸出,而且一般是通過一個簡單的方法的調用來實現.
那么,對于app中常用的網絡層來說,怎么樣的封裝才是最合理的?
我們的口號是:一行代碼完成網絡請求!
其實非常簡單,看接口文檔你就知道了怎么做了:就傳那些個參數,返回就是那個json之類的.把接口文檔轉化為我們調用的一個方法,這網絡層與上層的接口就可以說是設計好了.
最常見的字符流請求:
接口文檔寫了什么:(百度圖片隨便找的一個)
所以,我們網絡層應該封裝成這樣一個方法:
傳入:
請求方式,url路徑,請求的參數key和值
注: 對于多個POST請求參數key-value,有的接口會定義成Map形式,有的會定義成Json形式.其實本質上都是一樣的,都是在requestBody上POST一個字符串(字符流)出去,只不過前者的形式是a=4&t=5的形式,而后者是一個json形式.
總體上來講,還是前者比較多見,畢竟參數拼接形式與GET請求一致,服務器端處理比較方便.
輸出/返回:
對于返回字符流數據的情況,可以歸納為返回一個String對象,怎么處理就看具體情況了.
app中常見的是返回json格式的字符串.當然,一般app里需要的是解析好的javabean,那么網絡框架接口應該能直接返回一個解析好的javabean.
當然,更進一步來看,大多數規范的api(看看各大api市場,比如聚合api之類的)返回的json格式都具備以下特點:
一般為三個字段,分別表示狀態碼,相關提示信息,以及一個用于攜帶數據的字段.(比如:{"code":0,"msg":"登錄成功","data":{...}}).攜帶數據的字段可以攜帶任何類型的數據,null,數字,字符串,jsonObject,JsonArray都可以.
在這里,我把這種三個字段的json稱為"標準格式的json"
封裝好的方法:
getString(String url, Map map, MyNetListener listener)//get請求,返回一個string,拿到這個string
postString( String url, Map map, MyNetListener listener)
getCommonJson(String url, Map map, Class clazz, MyNetListener listener)//get請求,返回一個json,將整個json解析成javabean
postCommonJson(String url, Map map, Class clazz, MyNetListener listener)
getStandardJson(String url, Map map, Class clazz, MyNetListener listener)//get請求,返回一個標準格式的json
postStandardJson(String url, Map map, Class clazz, MyNetListener listener) //post請求,返回一個標準格式的json,通過傳入的clazz,直接解析返回data字段的javabean
//如果參數以json形式發出,那么再調用方法setParamsAsJson()即可.
上傳和下載
下載:
一般是GET請求,傳入url.請求參數可有可無.最終下載得到一個文件(路徑可預先指定),并且在下載的過程中有進度的回調.
注意: 我上面一層不需要知道你的什么網絡流啊,斷點下載啊,分片多線程下載之類的細節.
download(String url, String savedpath, MyNetListener callback)
上傳
POST請求,傳入url,請求參數,文件相關的key名,文件的地址,最終返回一個結果(成功或失敗),并且在上傳的過程中有進度回調.
同樣的,上一層不需要知道里面具體的header設置啊,斷點續傳啊,分片上傳之類的細節.
注意: http是支持多文件上傳的.
upLoad(String url, Map<String,String> params,Map<String,String> files, MyNetListener callback)
你說還有很常見的拉取網絡圖片并顯示在imageview中?
那就是圖片加載框架的事兒了,不應該交給網絡框架處理.推薦fresco,以及我的這個FrescoUtils.
以上api的思維導圖概覽
返回的數據:統一的回調
回調采用抽象類的形式,而不是接口的形式
public void onPreExecute() {}//統一的開始
public void onFinish(){}//統一的結束
public void onEmpty(){}//內容為空時--一般用在返回空的jsonArray時([]).
//成功的幾種情況:
public abstract void onSuccess(T response,String resonseStr);//主回調
public void onSuccessArr(List<T> response,String resonseStr){}//主回調,需要時復寫
public void onSuccessObj(T response,String responseStr,String data,int code,String msg){
onSuccess(response,responseStr);
}
public void onSuccessArr(List<T> response, String responseStr, String data, int code, String msg){
onSuccessArr(response,responseStr);
}
//失敗的回調
public void onError(String msgCanShow) {}//主回調
public void onUnFound() {
onError("沒有找到該內容");
}
public void onUnlogin(){
onError("您還沒有登錄");
}
public void onCodeError(String msgCanShow,String hiddenMsg,int code) {
if (TextUtils.isEmpty(msgCanShow)){
onError("錯誤碼為:"+code);
}else {
onError(msgCanShow);
}
}
//進度回調
public void onProgressChange(long fileSize, long downloadedSize) {}
自定義請求時的一些參數
沒什么好說的,直接看圖,清晰明了
一個請求示例
Map map8 = new HashMap<>();
map8.put("versionName","1.0.0");
map8.put("appType",0);
MyNetApi.postStandardJson("http://app.xxtt.com:9090/app/appVersion/getLatestVersion",
map8, VersionInfo.class, new MyNetListener<VersionInfo>() {
@Override
public void onSuccess(VersionInfo response, String resonseStr) {
Logger.e(resonseStr);
}
@Override
public void onError(String msgCanShow) {
super.onError(msgCanShow);
Logger.e(msgCanShow);
}
})
.setParamsAsJson()
.setIsAppendToken(false)
.setCustomCodeValue(1,2,3)
.start();
代碼
https://github.com/hss01248/NetWrapper
附圖:整體層次圖
ps.是的,我沒有用逼格比較高的Rxjava,主要是因為比較習慣回調模式,這種模式下,代碼的聚合度比較高.
