OKHttp

參考:https://blog.csdn.net/fightingxia/article/details/70947701

一,OKHttp介紹

okhttp是一個第三方類庫峡迷,用于android中請求網(wǎng)絡(luò)。
如果想了解原碼可以在github上下載票编,地址是:https://github.com/square/okhttp

在線集成依賴包并添加網(wǎng)絡(luò)權(quán)限:
app\build.grade中:
dependencies里添加
implementation 'com.squareup.okhttp3:okhttp:3.9.1'
manifest中:
<uses-permission android:name="android.permission.INTERNET"></uses-permission>

二,get請求的使用方法

使用OKHttp進(jìn)行網(wǎng)絡(luò)請求支持兩種方式,一種是同步請求闺魏,一種是異步請求非洲。下面分情況進(jìn)行介紹鸭限。

1,get的同步請求

對于同步請求在請求時需要開啟子線程两踏,請求成功后需要跳轉(zhuǎn)到UI線程修改UI败京。
使用示例如下:
public void getDatasync(){
new Thread(new Runnable() {
@Override
public void run() {
try {
OkHttpClient client = new OkHttpClient();//創(chuàng)建OkHttpClient對象
Request request = new Request.Builder()
.url("http://www.baidu.com")//請求接口。如果需要傳參拼接到接口后面梦染。
.build();//創(chuàng)建Request 對象
Response response = null;
response = client.newCall(request).execute();//得到Response 對象
if (response.isSuccessful()) {
Log.d("kwwl","response.code()=="+response.code());
Log.d("kwwl","response.message()=="+response.message());
Log.d("kwwl","res=="+response.body().string());
//此時的代碼執(zhí)行在子線程赡麦,修改UI的操作請使用handler跳轉(zhuǎn)到UI線程。
}
} catch (Exception e) {
e.printStackTrace();
}
}
}).start();
}

此時打印結(jié)果如下:
response.code()==200帕识;
response.message()==OK泛粹;
res=={“code”:200,”message”:success};

注意事項:
1,Response.code是http響應(yīng)行中的code渡冻,如果訪問成功則返回200.這個不是服務(wù)器設(shè)置的戚扳,而是http協(xié)議中自帶的。res中的code才是服務(wù)器設(shè)置的族吻。注意二者的區(qū)別帽借。
2,response.body().string()本質(zhì)是輸入流的讀操作超歌,所以它還是網(wǎng)絡(luò)請求的一部分砍艾,所以這行代碼必須放在子線程。
3巍举,java.lang.IllegalStateException: closed
調(diào)用了兩次response.body().string()脆荷。流已經(jīng)關(guān)閉,所以無法再進(jìn)行操作。
ResponseBody 類的string()方法的源代碼如下:
public final String string() throws IOException {
BufferedSource source = source();
try {
Charset charset = Util.bomAwareCharset(source, charset());
return source.readString(charset);
} finally {
Util.closeQuietly(source);
}
}
注意finally中的Util.closeQuietly(source);它是一個關(guān)閉流的工具方法懊悯。
2蜓谋,get的異步請求

這種方式不用再次開啟子線程,但回調(diào)方法是執(zhí)行在子線程中炭分,所以在更新UI時還要跳轉(zhuǎn)到UI線程中桃焕。
使用示例如下:
private void getDataAsync() {
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("http://www.baidu.com")
.build();
client.newCall(request).enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
}
@Override
public void onResponse(Call call, Response response) throws IOException {
if(response.isSuccessful()){//回調(diào)的方法執(zhí)行在子線程。
Log.d("kwwl","獲取數(shù)據(jù)成功了");
Log.d("kwwl","response.code()=="+response.code());
Log.d("kwwl","response.body().string()=="+response.body().string());
}
}
});
}

異步請求的打印結(jié)果與注意事項與同步請求時相同捧毛。最大的不同點(diǎn)就是異步請求不需要開啟子線程观堂,enqueue方法會自動將網(wǎng)絡(luò)請求部分放入子線程中執(zhí)行让网。

注意事項:
1,回調(diào)接口的onFailure方法和onResponse執(zhí)行在子線程师痕。
2溃睹,response.body().string()方法也必須放在子線程中。當(dāng)執(zhí)行這行代碼得到結(jié)果后胰坟,再跳轉(zhuǎn)到UI線程修改UI因篇。

三,post請求的使用方法

Post請求也分同步和異步兩種方式腕铸,同步與異步的區(qū)別和get方法類似惜犀,所以此時只講解post異步請求的使用方法。
使用示例如下:
private void postDataWithParame() {
OkHttpClient client = new OkHttpClient();//創(chuàng)建OkHttpClient對象狠裹。
FormBody.Builder formBody = new FormBody.Builder();//創(chuàng)建表單請求體
formBody.add("username","zhangsan");//傳遞鍵值對參數(shù)
Request request = new Request.Builder()//創(chuàng)建Request 對象。
.url("http://www.baidu.com")
.post(formBody.build())//傳遞請求體
.build();
client.newCall(request).enqueue(new Callback() {汽烦。涛菠。。});//回調(diào)方法的使用與get異步請求相同撇吞,此時略俗冻。
}

看完代碼我們會發(fā)現(xiàn):post請求中并沒有設(shè)置請求方式為POST,回憶在get請求中也沒有設(shè)置請求方式為GET牍颈,那么是怎么區(qū)分請求方式的呢迄薄?重點(diǎn)是Request.Builder類的post方法,在Request.Builder對象創(chuàng)建最初默認(rèn)是get請求煮岁,所以在get請求中不需要設(shè)置請求方式讥蔽,當(dāng)調(diào)用post方法時把請求方式修改為POST。所以此時為POST請求画机。

四冶伞,POST請求傳遞參數(shù)的方法總結(jié)

在post請求使用方法中講了一種傳遞參數(shù)的方法,就是創(chuàng)建表單請求體對象步氏,然后把表單請求體對象作為post方法的參數(shù)响禽。post請求傳遞參數(shù)的方法還有很多種,但都是通過post方法傳遞的荚醒。下面我們看一下Request.Builder類的post方法的聲明:
public Builder post(RequestBody body)1

由方法的聲明可以看出芋类,post方法接收的參數(shù)是RequestBody 對象,所以只要是RequestBody 類以及子類對象都可以當(dāng)作參數(shù)進(jìn)行傳遞界阁。FormBody就是RequestBody 的一個子類對象侯繁。

1,使用FormBody傳遞鍵值對參數(shù)

這種方式用來上傳String類型的鍵值對
使用示例如下:
private void postDataWithParame() {
OkHttpClient client = new OkHttpClient();//創(chuàng)建OkHttpClient對象铺董。
FormBody.Builder formBody = new FormBody.Builder();//創(chuàng)建表單請求體
formBody.add("username","zhangsan");//傳遞鍵值對參數(shù)
Request request = new Request.Builder()//創(chuàng)建Request 對象巫击。
.url("http://www.baidu.com")
.post(formBody.build())//傳遞請求體
.build();
client.newCall(request).enqueue(new Callback() {禀晓。。坝锰。});//此處省略回調(diào)方法粹懒。
}

2,使用RequestBody傳遞Json或File對象

RequestBody是抽象類顷级,故不能直接使用凫乖,但是他有靜態(tài)方法create,使用這個方法可以得到RequestBody對象弓颈。

這種方式可以上傳Json對象或File對象帽芽。
上傳json對象使用示例如下:
OkHttpClient client = new OkHttpClient();//創(chuàng)建OkHttpClient對象。
MediaType JSON = MediaType.parse("application/json; charset=utf-8");//數(shù)據(jù)類型為json格式翔冀,
String jsonStr = "{"username":"lisi","nickname":"李四"}";//json數(shù)據(jù).
RequestBody body = RequestBody.create(JSON, josnStr);
Request request = new Request.Builder()
.url("http://www.baidu.com")
.post(body)
.build();
client.newCall(request).enqueue(new Callback() {导街。。纤子。});//此處省略回調(diào)方法搬瑰。1

上傳File對象使用示例如下:
OkHttpClient client = new OkHttpClient();//創(chuàng)建OkHttpClient對象。
MediaType fileType = MediaType.parse("File/*");//數(shù)據(jù)類型為json格式控硼,
File file = new File("path");//file對象.
RequestBody body = RequestBody.create(fileType , file );
Request request = new Request.Builder()
.url("http://www.baidu.com")
.post(body)
.build();
client.newCall(request).enqueue(new Callback() {泽论。。卡乾。});//此處省略回調(diào)方法翼悴。1

3,使用MultipartBody同時傳遞鍵值對參數(shù)和File對象

這個字面意思是多重的body幔妨。我們知道FromBody傳遞的是字符串型的鍵值對鹦赎,RequestBody傳遞的是多媒體,那么如果我們想二者都傳遞怎么辦陶冷?此時就需要使用MultipartBody類钙姊。
使用示例如下:
OkHttpClient client = new OkHttpClient();
MultipartBody multipartBody =new MultipartBody.Builder()
.setType(MultipartBody.FORM)
.addFormDataPart("groupId",""+groupId)//添加鍵值對參數(shù)
.addFormDataPart("title","title")
.addFormDataPart("file",file.getName(),RequestBody.create(MediaType.parse("file/*"), file))//添加文件
.build();
final Request request = new Request.Builder()
.url(URLContant.CHAT_ROOM_SUBJECT_IMAGE)
.post(multipartBody)
.build();
client.newCall(request).enqueue(new Callback() {。埂伦。煞额。});

4,自定義RequestBody實現(xiàn)流的上傳

在上面的分析中我們知道沾谜,只要是RequestBody類以及子類都可以作為post方法的參數(shù)膊毁,下面我們就自定義一個類,繼承RequestBody基跑,實現(xiàn)流的上傳婚温。
使用示例如下:
首先創(chuàng)建一個RequestBody類的子類對象:
RequestBody body = new RequestBody() {
@Override
public MediaType contentType() {
return null;
}
@Override
public void writeTo(BufferedSink sink) throws IOException {//重寫writeTo方法
FileInputStream fio= new FileInputStream(new File("fileName"));
byte[] buffer = new byte[1024*8];
if(fio.read(buffer) != -1){
sink.write(buffer);
}
}
};

然后使用body對象:
OkHttpClient client = new OkHttpClient();//創(chuàng)建OkHttpClient對象。
Request request = new Request.Builder()
.url("http://www.baidu.com")
.post(body)
.build();
client.newCall(request).enqueue(new Callback() {媳否。栅螟。荆秦。});

以上代碼的與眾不同就是body對象,這個body對象重寫了write方法力图,里面有個sink對象步绸。這個是OKio包中的輸出流,有write方法吃媒。使用這個方法我們可以實現(xiàn)上傳流的功能瓤介。

使用RequestBody上傳文件時,并沒有實現(xiàn)斷點(diǎn)續(xù)傳的功能赘那。我可以使用這種方法結(jié)合RandomAccessFile類實現(xiàn)斷點(diǎn)續(xù)傳的功能刑桑。

五,設(shè)置請求頭

OKHttp中設(shè)置請求頭特別簡單募舟,在創(chuàng)建request對象時調(diào)用一個方法即可祠斧。
使用示例如下:
Request request = new Request.Builder()
.url("http://www.baidu.com")
.header("User-Agent", "OkHttp Headers.java")
.addHeader("token", "myToken")
.build();1

其他部分代碼略。

六胃珍,下載文件

在OKHttp中并沒有提供下載文件的功能梁肿,但是在Response中可以獲取流對象,有了流對象我們就可以自己實現(xiàn)文件的下載觅彰。代碼如下:
這段代碼寫在回調(diào)接口CallBack的onResponse方法中:
try{
InputStream is = response.body().byteStream();//從服務(wù)器得到輸入流對象
long sum = 0;
File dir = new File(mDestFileDir);
if (!dir.exists()){
dir.mkdirs();
}
File file = new File(dir, mdestFileName);//根據(jù)目錄和文件名得到file對象
FileOutputStream fos = new FileOutputStream(file);
byte[] buf = new byte[1024*8];
int len = 0;
while ((len = is.read(buf)) != -1){
fos.write(buf, 0, len);
}
fos.flush();
return file;

}

七,對于OKHttp的使用封裝

由于okhttp是偏底層的網(wǎng)絡(luò)請求類庫钮热,返回結(jié)果的回調(diào)方法仍然執(zhí)行在子線程中填抬,需要自己跳轉(zhuǎn)到UI線程,使用麻煩隧期。為了使用方便需要對OKHttp進(jìn)行再次封裝飒责。對于OKHttp的封裝首推的就是hongyang大神的OKHttpUtils。我個人在看過OKHttp的原碼和借鑒各大神的封裝源碼后封裝了一套自己的OKHttpUtils仆潮。這套OKHttpUtils最大的優(yōu)點(diǎn)是簡單和便于使用宏蛉,這是我項目中實際用的網(wǎng)絡(luò)請求工具類,完全可以說拿來即用性置。而且代碼簡單拾并,可供學(xué)習(xí)使用。

github的地址是:https://github.com/guozhengXia/OkHttpUtils

封裝的功能有:

  • 一般的get請求
  • 一般的post請求
  • 上傳單個文件(包含進(jìn)度)
  • 上傳list集合文件
  • 上傳map集合文件
  • 文件下載(包含進(jìn)度)
  • 圖片下載(實現(xiàn)了圖片的壓縮)
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末鹏浅,一起剝皮案震驚了整個濱河市嗅义,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌隐砸,老刑警劉巖之碗,帶你破解...
    沈念sama閱讀 218,858評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異季希,居然都是意外死亡褪那,警方通過查閱死者的電腦和手機(jī)幽纷,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,372評論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來博敬,“玉大人友浸,你說我怎么就攤上這事∫背溃” “怎么了尾菇?”我有些...
    開封第一講書人閱讀 165,282評論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長囚枪。 經(jīng)常有香客問我派诬,道長,這世上最難降的妖魔是什么链沼? 我笑而不...
    開封第一講書人閱讀 58,842評論 1 295
  • 正文 為了忘掉前任默赂,我火速辦了婚禮,結(jié)果婚禮上括勺,老公的妹妹穿的比我還像新娘缆八。我一直安慰自己,他們只是感情好疾捍,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,857評論 6 392
  • 文/花漫 我一把揭開白布奈辰。 她就那樣靜靜地躺著,像睡著了一般乱豆。 火紅的嫁衣襯著肌膚如雪奖恰。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,679評論 1 305
  • 那天宛裕,我揣著相機(jī)與錄音瑟啃,去河邊找鬼。 笑死揩尸,一個胖子當(dāng)著我的面吹牛蛹屿,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播岩榆,決...
    沈念sama閱讀 40,406評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼错负,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了朗恳?” 一聲冷哼從身側(cè)響起湿颅,我...
    開封第一講書人閱讀 39,311評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎粥诫,沒想到半個月后油航,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,767評論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡怀浆,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,945評論 3 336
  • 正文 我和宋清朗相戀三年谊囚,在試婚紗的時候發(fā)現(xiàn)自己被綠了怕享。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,090評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡镰踏,死狀恐怖函筋,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情奠伪,我是刑警寧澤跌帐,帶...
    沈念sama閱讀 35,785評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站绊率,受9級特大地震影響谨敛,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜滤否,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,420評論 3 331
  • 文/蒙蒙 一脸狸、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧藐俺,春花似錦炊甲、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,988評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至菱父,卻和暖如春牵囤,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背滞伟。 一陣腳步聲響...
    開封第一講書人閱讀 33,101評論 1 271
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留炕贵,地道東北人梆奈。 一個月前我還...
    沈念sama閱讀 48,298評論 3 372
  • 正文 我出身青樓,卻偏偏與公主長得像称开,于是被迫代替她去往敵國和親亩钟。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,033評論 2 355

推薦閱讀更多精彩內(nèi)容