一，OKHttp介紹
okhttp是一個(gè)第三方類庫涯雅，用于android中請求網(wǎng)絡(luò)鲜结。
這是一個(gè)開源項(xiàng)目,是安卓端最火熱的輕量級框架,由移動支付Square公司貢獻(xiàn)(該公司還貢獻(xiàn)了Picasso和LeakCanary) 。用于替代HttpUrlConnection和Apache HttpClient(android API23 里已移除HttpClient)活逆。
okhttp有自己的官網(wǎng)精刷，官網(wǎng)網(wǎng)址：OKHttp官網(wǎng)
如果想了解原碼可以在github上下載，地址是：https://github.com/square/okhttp
在AndroidStudio中使用不需要下載jar包蔗候，直接添加依賴即可：
compile ‘com.squareup.okhttp3:okhttp:3.4.1’
下面對以O(shè)KHttp3來詳細(xì)介紹OKHttp的使用方法怒允。
二，get請求的使用方法
使用OKHttp進(jìn)行網(wǎng)絡(luò)請求支持兩種方式锈遥，一種是同步請求纫事，一種是異步請求。下面分情況進(jìn)行介紹所灸。
1丽惶，get的同步請求
對于同步請求在請求時(shí)需要開啟子線程，請求成功后需要跳轉(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());
//此時(shí)的代碼執(zhí)行在子線程，修改UI的操作請使用handler跳轉(zhuǎn)到UI線程抡秆。
}
} catch (Exception e) {
e.printStackTrace();
}
}
}).start();
}
此時(shí)打印結(jié)果如下：
response.code()==200奕巍；
response.message()==OK；
res=={“code”:200,”message”:success};
注意事項(xiàng)：
1儒士，Response.code是http響應(yīng)行中的code伍绳，如果訪問成功則返回200.這個(gè)不是服務(wù)器設(shè)置的，而是http協(xié)議中自帶的乍桂。res中的code才是服務(wù)器設(shè)置的。注意二者的區(qū)別效床。
2睹酌，response.body().string()本質(zhì)是輸入流的讀操作，所以它還是網(wǎng)絡(luò)請求的一部分剩檀，所以這行代碼必須放在子線程憋沿。
3，response.body().string()只能調(diào)用一次沪猴，在第一次時(shí)有返回值辐啄，第二次再調(diào)用時(shí)將會返回null。原因是：response.body().string()的本質(zhì)是輸入流的讀操作运嗜，必須有服務(wù)器的輸出流的寫操作時(shí)客戶端的讀操作才能得到數(shù)據(jù)壶辜。而服務(wù)器的寫操作只執(zhí)行一次，所以客戶端的讀操作也只能執(zhí)行一次担租，第二次將返回null砸民。
2，get的異步請求
這種方式不用再次開啟子線程奋救，但回調(diào)方法是執(zhí)行在子線程中岭参，所以在更新UI時(shí)還要跳轉(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é)果與注意事項(xiàng)與同步請求時(shí)相同演侯。最大的不同點(diǎn)就是異步請求不需要開啟子線程，enqueue方法會自動將網(wǎng)絡(luò)請求部分放入子線程中執(zhí)行背亥。
注意事項(xiàng)：
1秒际，回調(diào)接口的onFailure方法和onResponse執(zhí)行在子線程。
2狡汉，response.body().string()方法也必須放在子線程中程癌。當(dāng)執(zhí)行這行代碼得到結(jié)果后，再跳轉(zhuǎn)到UI線程修改UI轴猎。
三嵌莉，post請求的使用方法
Post請求也分同步和異步兩種方式，同步與異步的區(qū)別和get方法類似萧吠，所以此時(shí)只講解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異步請求相同椎扬，此時(shí)略惫搏。
}
看完代碼我們會發(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方法時(shí)把請求方式修改為POST。所以此時(shí)為POST請求天吓。
四贿肩，POST請求傳遞參數(shù)的方法總結(jié)
在post請求使用方法中講了一種傳遞參數(shù)的方法，就是創(chuàng)建表單請求體對象龄寞，然后把表單請求體對象作為post方法的參數(shù)汰规。post請求傳遞參數(shù)的方法還有很多種，但都是通過post方法傳遞的物邑。下面我們看一下Request.Builder類的post方法的聲明：
public Builder post(RequestBody body)
由方法的聲明可以看出控轿，post方法接收的參數(shù)是RequestBody 對象，所以只要是RequestBody 類以及子類對象都可以當(dāng)作參數(shù)進(jìn)行傳遞拂封。FormBody就是RequestBody 的一個(gè)子類對象茬射。
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走趋，使用這個(gè)方法可以得到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)方法豆励。
上傳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)方法嫩痰。
3，使用MultipartBody同時(shí)傳遞鍵值對參數(shù)和File對象
這個(gè)字面意思是多重的body私沮。我們知道FromBody傳遞的是字符串型的鍵值對，RequestBody傳遞的是多媒體和橙，那么如果我們想二者都傳遞怎么辦仔燕？此時(shí)就需要使用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實(shí)現(xiàn)流的上傳
在上面的分析中我們知道外恕，只要是RequestBody類以及子類都可以作為post方法的參數(shù)，下面我們就自定義一個(gè)類乡翅，繼承RequestBody鳞疲，實(shí)現(xiàn)流的上傳。
使用示例如下：
首先創(chuàng)建一個(gè)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);
}
}
};
好了 休息一下 繼續(xù)看
然后使用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對象腺毫，這個(gè)body對象重寫了write方法，里面有個(gè)sink對象挣柬。這個(gè)是OKio包中的輸出流潮酒，有write方法。使用這個(gè)方法我們可以實(shí)現(xiàn)上傳流的功能邪蛔。
使用RequestBody上傳文件時(shí)急黎，并沒有實(shí)現(xiàn)斷點(diǎn)續(xù)傳的功能。我可以使用這種方法結(jié)合RandomAccessFile類實(shí)現(xiàn)斷點(diǎn)續(xù)傳的功能。
五叁熔，設(shè)置請求頭
OKHttp中設(shè)置請求頭特別簡單委乌，在創(chuàng)建request對象時(shí)調(diào)用一個(gè)方法即可。
使用示例如下：
Request request = new Request.Builder()
.url("http://www.baidu.com")
.header("User-Agent", "OkHttp Headers.java")
.addHeader("token", "myToken")
.build();
其他部分代碼略荣回。
六遭贸，下載文件
在OKHttp中并沒有提供下載文件的功能，但是在Response中可以獲取流對象心软，有了流對象我們就可以自己實(shí)現(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。我個(gè)人在看過OKHttp的原碼和借鑒各大神的封裝源碼后封裝了一套自己的OKHttpUtils诫隅。這套OKHttpUtils最大的優(yōu)點(diǎn)是簡單和便于使用腐魂，這是我項(xiàng)目中實(shí)際用的網(wǎng)絡(luò)請求工具類，完全可以說拿來即用逐纬。而且代碼簡單蛔屹，可供學(xué)習(xí)使用。
下載地址是：https://download.csdn.net/download/qq_35229022/10463957
封裝的功能有：
- 一般的get請求
- 一般的post請求
- 上傳單個(gè)文件(包含進(jìn)度)
- 上傳list集合文件
- 上傳map集合文件
- 文件下載(包含進(jìn)度)
- 圖片下載(實(shí)現(xiàn)了圖片的壓縮)
請大家多多支持豁生，多多提出寶貴意見兔毒，謝謝！
