首先說下OkHttp3是Java和Android都能用居触,Android還有一個(gè)著名網(wǎng)絡(luò)庫叫Volley妖混,那個(gè)只有Android能用。
導(dǎo)入
自己到入jar包轮洋,別漏了okio:
okhttp-3.3.0.jar
okio-1.8.0.jar
maven方式:
<dependency>
<groupId>com.squareup.okhttp3</groupId>
<artifactId>okhttp</artifactId>
<version>3.3.0</version>
</dependency>
gradle方式:
compile 'com.squareup.okhttp3:okhttp:3.3.0'
Get請求
String url = "https://www.baidu.com/";
OkHttpClient okHttpClient = new OkHttpClient();
Request request = new Request.Builder()
.url(url)
.build();
Call call = okHttpClient.newCall(request);
try {
Response response = call.execute();
System.out.println(response.body().string());
} catch (IOException e) {
e.printStackTrace();
}
如果你需要在request的的header添加參數(shù)制市。例如Cookie,User-Agent什么的弊予,就是
Request request = new Request.Builder()
.url(url)
.header("鍵", "值")
.header("鍵", "值")
...
.build();
response的body有很多種輸出方法祥楣,string()只是其中之一,注意是string()不是toString()。如果是下載文件就是response.body().bytes()误褪。
另外可以根據(jù)response.code()獲取返回的狀態(tài)碼责鳍。
Post請求
String url = "https://www.baidu.com/";
OkHttpClient okHttpClient = new OkHttpClient();
RequestBody body = new FormBody.Builder()
.add("鍵", "值")
.add("鍵", "值")
...
.build();
Request request = new Request.Builder()
.url(url)
.post(body)
.build();
Call call = okHttpClient.newCall(request);
try {
Response response = call.execute();
System.out.println(response.body().string());
} catch (IOException e) {
e.printStackTrace();
}
post請求創(chuàng)建request和get是一樣的,只是post請求需要提交一個(gè)表單兽间,就是RequestBody历葛。表單的格式有好多種,普通的表單是:
RequestBody body = new FormBody.Builder()
.add("鍵", "值")
.add("鍵", "值")
...
.build();
RequestBody的數(shù)據(jù)格式都要指定Content-Type嘀略,常見的有三種:
- application/x-www-form-urlencoded 數(shù)據(jù)是個(gè)普通表單
- multipart/form-data 數(shù)據(jù)里有文件
- application/json 數(shù)據(jù)是個(gè)json
但是好像以上的普通表單并沒有指定Content-Type恤溶,這是因?yàn)镕ormBody繼承了RequestBody,它已經(jīng)指定了數(shù)據(jù)類型為application/x-www-form-urlencoded帜羊。
private static final MediaType CONTENT_TYPE = MediaType.parse("application/x-www-form-urlencoded");
再看看數(shù)據(jù)為其它類型的RequestBody的創(chuàng)建方式宏娄。
如果表單是個(gè)json:
MediaType JSON = MediaType.parse("application/json; charset=utf-8");
RequestBody body = RequestBody.create(JSON, "你的json");
如果數(shù)據(jù)包含文件:
RequestBody requestBody = new MultipartBody.Builder()
.setType(MultipartBody.FORM)
.addFormDataPart("file", file.getName(), RequestBody.create(MediaType.parse("image/png"), file))
.build();
上面的MultipartBody也是繼承了RequestBody,看下源碼可知它適用于這五種Content-Type:
public static final MediaType MIXED = MediaType.parse("multipart/mixed");
public static final MediaType ALTERNATIVE = MediaType.parse("multipart/alternative");
public static final MediaType DIGEST = MediaType.parse("multipart/digest");
public static final MediaType PARALLEL = MediaType.parse("multipart/parallel");
public static final MediaType FORM = MediaType.parse("multipart/form-data");
另外如果你上傳一個(gè)文件不是一張圖片逮壁,但是MediaType.parse("image/png")里的"image/png"不知道該填什么孵坚,可以參考下這個(gè)頁面。
同步與異步
從上文已經(jīng)能知道call.execute()就是在執(zhí)行http請求了窥淆,但是這是個(gè)同步操作卖宠,是在主線程運(yùn)行的。如果你在android的UI線程直接執(zhí)行這句話就出異常了忧饭。
OkHttp也幫我們實(shí)現(xiàn)了異步扛伍,寫法是:
String url = "https://www.baidu.com/";
OkHttpClient okHttpClient = new OkHttpClient();
Request request = new Request.Builder()
.url(url)
.build();
Call call = okHttpClient.newCall(request);
call.enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
e.printStackTrace();
}
@Override
public void onResponse(Call call, Response response) throws IOException {
System.out.println("我是異步線程,線程Id為:" + Thread.currentThread().getId());
}
});
for (int i = 0; i < 10; i++) {
System.out.println("我是主線程,線程Id為:" + Thread.currentThread().getId());
try {
Thread.currentThread().sleep(100);
} catch (InterruptedException e) {
e.printStackTrace();
}
}
執(zhí)行結(jié)果是:
我是主線程,線程Id為:1
我是主線程,線程Id為:1
我是主線程,線程Id為:1
我是異步線程,線程Id為:11
我是主線程,線程Id為:1
我是主線程,線程Id為:1
我是主線程,線程Id為:1
我是主線程,線程Id為:1
我是主線程,線程Id為:1
我是主線程,線程Id為:1
我是主線程,線程Id為:1
顯然onFailure()和onResponse()分別是在請求失敗和成功時(shí)會(huì)調(diào)用的方法。這里有個(gè)要注意的地方词裤,onFailure()和onResponse()是在異步線程里執(zhí)行的刺洒,所以如果你在Android把更新UI的操作寫在這兩個(gè)方法里面是會(huì)報(bào)錯(cuò)的,這個(gè)時(shí)候可以用runOnUiThread這個(gè)方法吼砂。
自動(dòng)管理Cookie
Request經(jīng)常都要攜帶Cookie逆航,上面說過request創(chuàng)建時(shí)可以通過header設(shè)置參數(shù),Cookie也是參數(shù)之一渔肩。就像下面這樣:
Request request = new Request.Builder()
.url(url)
.header("Cookie", "xxx")
.build();
然后可以從返回的response里得到新的Cookie因俐,你可能得想辦法把Cookie保存起來。
但是OkHttp可以不用我們管理Cookie周偎,自動(dòng)攜帶抹剩,保存和更新Cookie。
方法是在創(chuàng)建OkHttpClient設(shè)置管理Cookie的CookieJar:
private final HashMap<String, List<Cookie>> cookieStore = new HashMap<>();
OkHttpClient okHttpClient = new OkHttpClient.Builder()
.cookieJar(new CookieJar() {
@Override
public void saveFromResponse(HttpUrl httpUrl, List<Cookie> list) {
cookieStore.put(httpUrl.host(), list);
}
@Override
public List<Cookie> loadForRequest(HttpUrl httpUrl) {
List<Cookie> cookies = cookieStore.get(httpUrl.host());
return cookies != null ? cookies : new ArrayList<Cookie>();
}
})
.build();
這樣以后發(fā)送Request都不用管Cookie這個(gè)參數(shù)也不用去response獲取新Cookie什么的了蓉坎。還能通過cookieStore獲取當(dāng)前保存的Cookie澳眷。
最后,new OkHttpClient()只是一種快速創(chuàng)建OkHttpClient的方式蛉艾,更標(biāo)準(zhǔn)的是使用OkHttpClient.Builder()钳踊。后者可以設(shè)置一堆參數(shù)衷敌,例如超時(shí)時(shí)間什么的。