前言
HTTP 請(qǐng)求和 Json 解析幾乎是當(dāng)前 APP 開(kāi)發(fā)必備技能了凭需，而 OkHttp 框架又是 Android 開(kāi)發(fā)最常用的網(wǎng)絡(luò)請(qǐng)求框架之一荠卷，因此我基于它進(jìn)行了二次封裝逸月，旨在更高效疲扎、快速的完成 APP 應(yīng)用程序網(wǎng)絡(luò)請(qǐng)求功能的構(gòu)建絮蒿。
問(wèn)題出在哪
為什么要進(jìn)行二次封裝冲甘？了解過(guò) OkHttp 的應(yīng)該知道绩卤，要?jiǎng)?chuàng)建一個(gè) OkHttp 請(qǐng)求的過(guò)程有些繁瑣途样，第一你得創(chuàng)建一個(gè) OkHttpClient，額外的你得創(chuàng)建一個(gè)請(qǐng)求 Request濒憋，其次每次還得做一大堆配置何暇，十分繁瑣。
關(guān)于 Json凛驮，目前最好的兩個(gè)框架分別是 org.json 和 Gson裆站，兩者各有長(zhǎng)處，而 org.json 存在的最大的麻煩在于其解析或構(gòu)建 Json 都需要 捕獲異常黔夭，而即便是 Gson宏胯，對(duì)于空數(shù)據(jù)的情況依然也會(huì)束手無(wú)策。
基于快速開(kāi)發(fā)以及防后端撕逼原則本姥，對(duì)于 Json 解析我們是需要一些寬容度的肩袍，即：即便 Json 可能不完整，可能有問(wèn)題扣草，也不能讓我們的 App 崩（bei）潰（guo）了牛，基于上述原則，那么我們的封裝目的也就很明確了辰妙，那就是一方面要將網(wǎng)絡(luò)請(qǐng)求這事情變簡(jiǎn)單鹰祸，另一方面就是讓 Json 解析更為容易。
BaseOkHttpV3
這個(gè)框架就是對(duì)于上述問(wèn)題解決思路的封裝結(jié)果了密浑，先上 GitHub 地址：
https://github.com/kongzue/BaseOkHttpV3
先說(shuō)說(shuō)創(chuàng)建請(qǐng)求
一般而言蛙婴，對(duì)于的代碼編寫方式分為一鍵構(gòu)建法和流式構(gòu)建法，而 BaseOkHttpV3 兩者都支持尔破，習(xí)慣怎么用都可以：
//一鍵構(gòu)建法：
HttpRequest.POST(context, "http://www.example.com/femaleNameApi", new Parameter().add("page", "1"), new ResponseListener() {
@Override
public void onResponse(String response, Exception error) {
//返回?cái)?shù)據(jù) response
}
});
//流式寫法：
HttpRequest.build(context, "http://www.example.com/femaleNameApi")
.addHeaders("Charset", "UTF-8")
.addParameter("page", "1")
.addParameter("token", "A128")
.setResponseListener(new ResponseListener() {
@Override
public void onResponse(String response, Exception error) {
//返回?cái)?shù)據(jù) response
}
})
.doPost();
接下來(lái)說(shuō)說(shuō)請(qǐng)求成功和異常的處理街图，在 OkHttp 框架中，請(qǐng)求返回結(jié)果成功與失敗是分別放在不同的方法中執(zhí)行的懒构，且需要?jiǎng)?chuàng)建 Call 對(duì)象才能處理：
Call call = okHttpClient.newCall(request);
call.enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
//請(qǐng)求失敗
}
@Override
public void onResponse(Call call, Response response) throws IOException {
//請(qǐng)求成功餐济，注意這里還有個(gè)坑，response.body().string() 只能獲取一次
}
});
但我們經(jīng)常使用場(chǎng)景中胆剧，需要在請(qǐng)求開(kāi)始時(shí)彈出一個(gè) ProgressDialog（加載中提示框）來(lái)阻斷用戶重復(fù)請(qǐng)求的行為絮姆，而無(wú)論請(qǐng)求成功還是失敗，這個(gè)對(duì)話框都需要被關(guān)閉（dismiss）那么問(wèn)題來(lái)了秩霍，按照 OkHttp 框架原先的寫法篙悯，你需要在 onFailure 和 onResponse 兩個(gè)方法中都執(zhí)行 progressDialog.dismiss(); 代碼重復(fù)，利用率低铃绒。
在上述 BaseOkHttpV3 框架中鸽照，僅在同一個(gè) onResponse 方法中返回，開(kāi)發(fā)者只需要做判斷即可颠悬，error 和 response 同時(shí)只會(huì)有一個(gè)是 null矮燎，而 error == null 時(shí)即為請(qǐng)求成功定血，這樣無(wú)論請(qǐng)求成功與失敗都需要執(zhí)行的代碼就可以只寫一次了。
通常我們?cè)谕粋€(gè)程序中構(gòu)建大多數(shù)請(qǐng)求都是使用同一個(gè)域名地址的子接口地址的漏峰，那么能否減輕這塊的代碼重復(fù)量糠悼？即，配置全局請(qǐng)求地址浅乔。BaseOkHttpV3 框架中也有考慮這種問(wèn)題倔喂，在 BaseOkHttpV3 中提供了大量的全局配置方法，例如全局服務(wù)器地址 BaseOkHttp.serviceUrl靖苇，配制后所有請(qǐng)求編寫時(shí)席噩，僅需要寫子接口部分的地址即可，框架會(huì)自動(dòng)使用 BaseOkHttp.serviceUrl + 當(dāng)前創(chuàng)建的請(qǐng)求 url 進(jìn)行組合發(fā)送請(qǐng)求贤壁，要臨時(shí)取消這種組合單獨(dú)請(qǐng)求別的服務(wù)接口地址悼枢，僅需要在創(chuàng)建請(qǐng)求時(shí)傳入“http”開(kāi)頭的請(qǐng)求 url 即可自動(dòng)不帶全局服務(wù)器地址發(fā)送請(qǐng)求。
諸如此類的全局配置還有很多脾拆，例如全局 Header 請(qǐng)求頭馒索、全局參數(shù)、全局參數(shù)攔截器名船、全局返回?cái)r截器等等绰上，這都是為了方便更多請(qǐng)求場(chǎng)景需要且簡(jiǎn)化開(kāi)發(fā)成本所做的功能，具體請(qǐng)參考 Github 文檔渠驼。
最后蜈块，BaseOkHttpV3 返回請(qǐng)求結(jié)果時(shí)，區(qū)別于 OkHttp迷扇，默認(rèn)是在主線程返回的百揭，以方便直接對(duì)布局進(jìn)行操作，如需異步線程請(qǐng)手動(dòng)自行創(chuàng)建蜓席。
如何更好的利用 Json
Json 是目前最常用的數(shù)據(jù)封裝方式了器一，區(qū)別于以往的 XML，它更加輕便簡(jiǎn)潔厨内，其實(shí) org.json 和 Gson 對(duì)他的處理已經(jīng)相當(dāng)完善了祈秕，但我依然覺(jué)得有更進(jìn)一步的空間。
對(duì)于 Json 的解析隘庄，BaseOkHttpV3 提供了JsonUtil 工具類來(lái)完成踢步，JsonUtil 工具類是基于 org.json 庫(kù)的二次封裝癣亚，但 JsonUtil 的輸出不是 JsonObject 或 JsonArray 對(duì)象丑掺，而是基于 Map 和 List 的 JsonMap 和 JsonList 對(duì)象，且提供了獨(dú)立的 get 方法述雾，以保證讀取到的數(shù)據(jù)不會(huì)出現(xiàn)空指針異常街州。
JsonMap 和 JsonList 的優(yōu)勢(shì)主要在于其解析方便兼丰，不需要捕獲異常處理，且完全不會(huì)空指針唆缴。對(duì)于異常的 json 文本鳍征，例如以下文本：
{
"name":"abc",
"age":"",
"data":null
}
其中的 age 預(yù)期是 int 類型，如果使用 org.json 和 Gson 庫(kù)面徽，都可能遇到麻煩艳丛，但對(duì)于 BaseOkHttpV3 來(lái)說(shuō)是毫無(wú)問(wèn)題的，使用 getInt("age") 獲取到的值會(huì)是 0趟紊，如果你想做判斷氮双，可以設(shè)置默認(rèn)值為 -1，使用代碼 getInt("age", -1) 即可霎匈，在 BaseOkHttpV3 的 Json 解析框架中戴差，所有獲取到的值，無(wú)論 getString(key)铛嘱、getInt(key)暖释、getBoolean(key)還是其他類型，甚至對(duì)于上述使用 Json使用 getJsonMap("data").getString("message"); 的代碼墨吓，都不會(huì)出現(xiàn)空指針球匕，可以盡管放心大膽的解析。
如此設(shè)計(jì)的主要目的是為了方便解決對(duì)于可能出現(xiàn)的后端給出數(shù)據(jù)存在異常的情況下肛真，保證 App 不崩潰谐丢，且能夠高效構(gòu)建代碼。在 BaseOkHttpV3 的 Json 解析庫(kù)中蚓让，你甚至可以忽略類型乾忱，對(duì)于 boolean 的值可以直接解析成 string，對(duì)于 string 的值你也可以直接解析成 int历极，都不會(huì)出現(xiàn) App 的問(wèn)題窄瘟，盡管這確實(shí)有些不嚴(yán)謹(jǐn)，但卻能大大提升開(kāi)發(fā)的效率趟卸，縮短開(kāi)發(fā)周期蹄葱，減少不必要的麻煩。
另外锄列， JsonMap 和 JsonList 對(duì)象是 Map 和 List 的子類图云，也就是說(shuō)，對(duì)于一段 Json 集合邻邮，可以直接通過(guò) JsonUtil 解析成 JsonList 參與 ListView竣况、RecycleView 等組件的適配器 Adapter 構(gòu)建，快速完成從網(wǎng)絡(luò)請(qǐng)求數(shù)據(jù)到界面呈現(xiàn)的轉(zhuǎn)換筒严，省去構(gòu)造 JavaBean 的繁瑣步驟丹泉。
防撕逼情萤？我看行
BaseOkHttpV3 還有一個(gè)非常亮點(diǎn)的設(shè)計(jì)，那就是日志打印摹恨，這個(gè)設(shè)計(jì)也主要是為了防止出現(xiàn)責(zé)任不明的問(wèn)題筋岛，對(duì)于 BaseOkHttpV3 的請(qǐng)求，在開(kāi)啟日志打印開(kāi)關(guān)后 BaseOkHttp.DEBUGMODE = true; 你可以在控制臺(tái)看到非常完整規(guī)范的日志結(jié)果：
對(duì)于 Json 文本會(huì)自動(dòng)進(jìn)行格式化晒哄，且針對(duì)每一個(gè)接口的發(fā)送睁宰、返回、錯(cuò)誤都有明確的顯示寝凌，我相信這對(duì)于日常開(kāi)發(fā)查錯(cuò)來(lái)說(shuō)也會(huì)是極佳的助力勋陪。
總結(jié)
BaseOkHttpV3 的封裝主要是為了解決開(kāi)發(fā)過(guò)程中遇到的很多痛點(diǎn)和難點(diǎn)，本文著重講述了 BaseOkHttpV3 的封裝目的以及對(duì)于一般請(qǐng)求以及 Json 解析的良好支持硫兰，除此之外诅愚，BaseOkHttpV3 也對(duì) PUT、GET劫映、DELETE 請(qǐng)求违孝、HTTPS、WebSocket 以及 Cookie 做了封裝泳赋，有興趣可以移駕 Github 詳細(xì)查看：https://github.com/kongzue/BaseOkHttpV3
如有任何疑問(wèn)可以在 Github 提出您的 issues雌桑，也可以加入大話安卓討論群： 271127803 與我討論。寫文章不易祖今，如果覺(jué)得好還勞煩點(diǎn)個(gè)贊吧校坑！
