OkHttp3的基本用法

首先說下OkHttp3是Java和Android都能用,Android還有一個著名網(wǎng)絡(luò)庫叫Volley,那個只有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請求需要提交一個表單,就是RequestBody。表單的格式有好多種,普通的表單是:

RequestBody body = new FormBody.Builder()
    .add("鍵", "值")
    .add("鍵", "值")
    ...
    .build();

RequestBody的數(shù)據(jù)格式都要指定Content-Type,常見的有三種:

  • application/x-www-form-urlencoded 數(shù)據(jù)是個普通表單
  • multipart/form-data 數(shù)據(jù)里有文件
  • application/json 數(shù)據(jù)是個json

但是好像以上的普通表單并沒有指定Content-Type,這是因為FormBody繼承了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)建方式。

如果表單是個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");

另外如果你上傳一個文件不是一張圖片,但是MediaType.parse("image/png")里的"image/png"不知道該填什么,可以參考下這個頁面。

同步與異步

從上文已經(jīng)能知道call.execute()就是在執(zhí)行http請求了,但是這是個同步操作,是在主線程運(yùn)行的。如果你在android的UI線程直接執(zhí)行這句話就出異常了。
OkHttp也幫我們實現(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()分別是在請求失敗和成功時會調(diào)用的方法。這里有個要注意的地方,onFailure()和onResponse()是在異步線程里執(zhí)行的,所以如果你在Android把更新UI的操作寫在這兩個方法里面是會報錯的,這個時候可以用runOnUiThread這個方法。

自動管理Cookie

Request經(jīng)常都要攜帶Cookie,上面說過request創(chuàng)建時可以通過header設(shè)置參數(shù),Cookie也是參數(shù)之一。就像下面這樣:

Request request = new Request.Builder()
    .url(url)
    .header("Cookie", "xxx")
    .build();

然后可以從返回的response里得到新的Cookie,你可能得想辦法把Cookie保存起來。
但是OkHttp可以不用我們管理Cookie,自動攜帶,保存和更新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這個參數(shù)也不用去response獲取新Cookie什么的了。還能通過cookieStore獲取當(dāng)前保存的Cookie。
最后,new OkHttpClient()只是一種快速創(chuàng)建OkHttpClient的方式,更標(biāo)準(zhǔn)的是使用OkHttpClient.Builder()。后者可以設(shè)置一堆參數(shù),例如超時時間什么的。

參考:http://www.itdecent.cn/p/1873287eed87

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 136,534評論 19 139
  • 這篇文章說下OkHttp的基本用法,是最新的3哦,如果你在網(wǎng)上搜索OkHttp怎么使用發(fā)現(xiàn)有些類沒有了可能是因為人...
    光劍書架上的書閱讀 2,804評論 0 5
  • 6.1 公鑰密鑰加密原理 6.1.1 基礎(chǔ)知識 密鑰:一般就是一個字符串或數(shù)字,在加密或者解密時傳遞給加密/解密算...
    AndroidMaster閱讀 4,107評論 1 8
  • 類似的事情 曾無所畏懼 只知直沖 即使飽受百態(tài) 仍不會輕易而棄 今卻有所猶豫 有所選擇 雖有所尷尬而不得已 欣,豪...
    進(jìn)擊的Unicorn閱讀 228評論 3 2
  • 試試markdown功能 二號標(biāo)題 三號標(biāo)題 這是一些引用嗎?
    海馬派閱讀 117評論 0 0

友情鏈接更多精彩內(nèi)容