OkHttp:是一款優(yōu)秀的HTTP框架,
- 支持get請(qǐng)求和post請(qǐng)求,
- 支持基于Http的文件上傳和下載,
- 支持加載圖片,
- 支持下載文件透明的GZIP壓縮,
- 支持響應(yīng)緩存避免重復(fù)的網(wǎng)絡(luò)請(qǐng)求,
- 支持使用連接池來(lái)降低響應(yīng)延遲問題
下載和添加網(wǎng)絡(luò)訪問權(quán)限


基本要求
Request:每一個(gè)HTTP請(qǐng)求中都應(yīng)該包含一個(gè)URL,一個(gè)GET或POST方法以及Header或其他參數(shù),當(dāng)然還可以含特定內(nèi)容類型的數(shù)據(jù)流。
Response:響應(yīng)則包含一個(gè)回復(fù)代碼(200代表成功,404代表未找到),Header和定制可選的body。
基本使用
在日常開發(fā)中最常使用的網(wǎng)絡(luò)請(qǐng)求就是GET和POST兩種方式
Http Get請(qǐng)求
//創(chuàng)建okHttpClient對(duì)象
OkHttpClient mOkHttpClient = new OkHttpClient();
//創(chuàng)建一個(gè)Request
final Request request = new Request.Builder()
.url("https://github.com/hongyangAndroid")
.build();
//new call
Call call = mOkHttpClient.newCall(request);
//請(qǐng)求加入調(diào)度
call.enqueue(new Callback()
{
@Override
public void onFailure(Request request, IOException e)
{
}
@Override
public void onResponse(final Response response) throws IOException
{
//String htmlStr = response.body().string();
}
});
- 以上就是發(fā)送一個(gè)get請(qǐng)求的步驟,首先構(gòu)造一個(gè)Request對(duì)象,參數(shù)最少有一個(gè)url,當(dāng)然還可以通過Request.Builder設(shè)置更多的參數(shù)比如:header、method等
- 然后通過request的對(duì)象去構(gòu)造得到一個(gè)Call對(duì)象,類似于將你的請(qǐng)求封裝成了任務(wù),既然是任務(wù),那就會(huì)有execute()和cancel()方法
- 最后,通過異步的方式去執(zhí)行請(qǐng)求,所以我們調(diào)用的是call.enqueue,將call加入調(diào)度隊(duì)列,然后等待任務(wù)執(zhí)行完成,最后在Callback中即可得到結(jié)果。
整體的寫法就是這樣,但是實(shí)際運(yùn)用過程中還需要進(jìn)行封裝。
注意 - onResponse回調(diào)的參數(shù)是response,一般情況下,比如我們希望獲得返回的字符串,可以通過response.body().string()獲得;如果希望獲得返回的二進(jìn)制字節(jié)數(shù)組,則調(diào)用response.body().bytes();如果你想拿到返回的inputStream,則調(diào)用response.body().byteStream()
此時(shí)onResponse執(zhí)行的線程并不是UI線程,所以當(dāng)你希望操作控件的時(shí)候,還需要使用handle等,例如:
@Override
public void onResponse(final Response response) throws IOException
{
final String res = response.body().string();
runOnUiThread(new Runnable()
{
@Override
public void run()
{
mTv.setText(res);
}
});
}
Http Post攜帶參數(shù)
post基本用法和get基本相同,比如post攜帶參數(shù),也僅僅是Request的構(gòu)造不同。
Request request = buildMultipartFormRequest(
url, new File[]{file}, new String[]{fileKey}, null);
FormEncodingBuilder builder = new FormEncodingBuilder();
builder.add("username","###");
Request request = new Request.Builder()
.url(url)
.post(builder.build())
.build();
mOkHttpClient.newCall(request).enqueue(new Callback(){});
post的時(shí)候,參數(shù)是包含在請(qǐng)求體中的,所以我們通過FormEncodingBuilder。添加多個(gè)string鍵值對(duì),然后去構(gòu)造RequestBody,最后完成Request的構(gòu)造。
封裝
上面的代碼包含太多重復(fù)的代碼,所以我們應(yīng)該使用封裝之后的代碼:
- 一般的get請(qǐng)求
OkHttpClientManager.getAsyn("https://www.baidu.com", new OkHttpClientManager.ResultCallback<String>()
{
@Override
public void onError(Request request, Exception e)
{
e.printStackTrace();
}
@Override
public void onResponse(String u)
{
mTv.setText(u);//注意這里是UI線程
}
});
對(duì)于一般的請(qǐng)求,我們給出一個(gè)url,然后再CallBack中直接進(jìn)行操作.
- 展示圖片
當(dāng)展示圖片的時(shí)候,我們只需要提供一個(gè)url和imageView,如果下載成功,直接設(shè)置就行了
OkHttpClientManager.displayImage(mImageView,
"http://images.csdn.net/20150817/1.jpg");
整合Gson
當(dāng)服務(wù)端返回json字符串時(shí),希望客戶端回調(diào)可以直接拿到對(duì)象,于是整合了Gson.
- 直接回調(diào)對(duì)象
現(xiàn)在有一個(gè)User實(shí)體類:
package com.zhy.utils.http.okhttp;
public class User {
public String username ;
public String password ;
public User() {
// TODO Auto-generated constructor stub
}
public User(String username, String password) {
this.username = username;
this.password = password;
}
@Override
public String toString()
{
return "User{" +
"username='" + username + '\'' +
", password='" + password + '\'' +
'}';
}
}
服務(wù)端返回:
{"username":"zhy","password":"123"}
客戶端按以下方式調(diào)用:
OkHttpClientManager.getAsyn("http://192.168.56.1:8080/okHttpServer/user!getUser",
new OkHttpClientManager.ResultCallback<User>()
{
@Override
public void onError(Request request, Exception e)
{
e.printStackTrace();
}
@Override
public void onResponse(User user)
{
mTv.setText(u.toString());//UI線程
}
});
我們傳入泛型User,在onResponse里面直接回調(diào)User對(duì)象。
注意:如果在json字符串轉(zhuǎn)變?yōu)閷?shí)例對(duì)象過程中出現(xiàn)錯(cuò)誤,程序不會(huì)崩潰,onError方法會(huì)被回調(diào)。
注意:接口命名從StringCallback修改為ResultCallback.接口中的onFailure方法修改為onError.
- 回調(diào)對(duì)象集合
服務(wù)端返回:
[{"username":"zhy","password":"123"},{"username":"lmj","password":"12345"}]
客戶端可以如下調(diào)用:
OkHttpClientManager.getAsyn("http://192.168.56.1:8080/okHttpServer/user!getUsers",
new OkHttpClientManager.ResultCallback<List<User>>()
{
@Override
public void onError(Request request, Exception e)
{
e.printStackTrace();
}
@Override
public void onResponse(List<User> us)
{
Log.e("TAG", us.size() + "");
mTv.setText(us.get(1).toString());
}
});
唯一的區(qū)別,就是泛型變?yōu)長(zhǎng)ist<User>.
參考:http://blog.csdn.net/mynameishuangshuai/article/details/51303446
http://blog.csdn.net/lmj623565791/article/details/47911083