Okhttp3基本使用

I.簡介

HTTP是現(xiàn)代應(yīng)用常用的一種交換數(shù)據(jù)和媒體的網(wǎng)絡(luò)方式稽坤，高效地使用HTTP能讓資源加載更快，節(jié)省帶寬渔伯。OkHttp是一個高效的HTTP客戶端顶霞，它有以下默認特性：

  • 支持HTTP/2，允許所有同一個主機地址的請求共享同一個socket連接
  • 連接池減少請求延時
  • 透明的GZIP壓縮減少響應(yīng)數(shù)據(jù)的大小
  • 緩存響應(yīng)內(nèi)容锣吼，避免一些完全重復(fù)的請求

當(dāng)網(wǎng)絡(luò)出現(xiàn)問題的時候OkHttp依然堅守自己的職責(zé)确丢，它會自動恢復(fù)一般的連接問題，如果你的服務(wù)有多個IP地址吐限，當(dāng)?shù)谝粋€IP請求失敗時，OkHttp會交替嘗試你配置的其他IP褂始，OkHttp使用現(xiàn)代TLS技術(shù)(SNI, ALPN)初始化新的連接诸典，當(dāng)握手失敗時會回退到TLS 1.0。

note: OkHttp 支持 Android 2.3 及以上版本Android平臺崎苗， 對于 Java, JDK 1.7及以上.

對于Okhttp3的源碼閱讀預(yù)計會寫3篇文章來總結(jié)：

II.使用

OkHttp的使用是非常簡單的. 它的請求/響應(yīng) API 使用構(gòu)造器模式builders來設(shè)計，它支持阻塞式的同步請求和帶回調(diào)的異步請求胆数。

Download OkHttp3

implementation 'com.squareup.okhttp3:okhttp:3.10.0'

當(dāng)你看到這的時候肌蜻，可能最新的穩(wěn)定版已經(jīng)不是3.10.0了，你需要移步官方GitHub來查看最新版本必尼。 官方地址 https://github.com/square/okhttp蒋搜，另外不要忘了在清單文件聲明訪問Internet的權(quán)限篡撵，如果使用 DiskLruCache，那還得聲明寫外存的權(quán)限豆挽。

1.1. 異步GET請求

-new OkHttpClient;
-構(gòu)造Request對象育谬；
-通過前兩步中的對象構(gòu)建Call對象；
-通過Call#enqueue(Callback)方法來提交異步請求帮哈；

String url = "http://wwww.baidu.com";
OkHttpClient okHttpClient = new OkHttpClient();
final Request request = new Request.Builder()
        .url(url)
        .get()//默認就是GET請求膛檀，可以不寫
        .build();
Call call = okHttpClient.newCall(request);
call.enqueue(new Callback() {
    @Override
    public void onFailure(Call call, IOException e) {
        Log.d(TAG, "onFailure: ");
    }

    @Override
    public void onResponse(Call call, Response response) throws IOException {
        Log.d(TAG, "onResponse: " + response.body().string());
    }
});

異步發(fā)起的請求會被加入到 Dispatcher 中的 runningAsyncCalls雙端隊列中通過線程池來執(zhí)行。

1.2. 同步GET請求

前面幾個步驟和異步方式一樣娘侍，只是最后一部是通過 Call#execute() 來提交請求咖刃，注意這種方式會阻塞調(diào)用線程，所以在Android中應(yīng)放在子線程中執(zhí)行憾筏，否則有可能引起ANR異常嚎杨，Android3.0 以后已經(jīng)不允許在主線程訪問網(wǎng)絡(luò)。

String url = "http://wwww.baidu.com";
OkHttpClient okHttpClient = new OkHttpClient();
final Request request = new Request.Builder()
        .url(url)
        .build();
final Call call = okHttpClient.newCall(request);
new Thread(new Runnable() {
    @Override
    public void run() {
        try {
            Response response = call.execute();
            Log.d(TAG, "run: " + response.body().string());
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}).start();

2.1. POST方式提交String

這種方式與前面的區(qū)別就是在構(gòu)造Request對象時踩叭，需要多構(gòu)造一個RequestBody對象磕潮，用它來攜帶我們要提交的數(shù)據(jù)。在構(gòu)造 RequestBody 需要指定MediaType容贝，用于描述請求/響應(yīng) body 的內(nèi)容類型自脯，關(guān)于 MediaType 的更多信息可以查看 RFC 2045，RequstBody的幾種構(gòu)造方式：

image.png
MediaType mediaType = MediaType.parse("text/x-markdown; charset=utf-8");
String requestBody = "I am Jdqm.";
Request request = new Request.Builder()
        .url("https://api.github.com/markdown/raw")
        .post(RequestBody.create(mediaType, requestBody))
        .build();
OkHttpClient okHttpClient = new OkHttpClient();
okHttpClient.newCall(request).enqueue(new Callback() {
    @Override
    public void onFailure(Call call, IOException e) {
        Log.d(TAG, "onFailure: " + e.getMessage());
    }

    @Override
    public void onResponse(Call call, Response response) throws IOException {
        Log.d(TAG, response.protocol() + " " +response.code() + " " + response.message());
        Headers headers = response.headers();
        for (int i = 0; i < headers.size(); i++) {
            Log.d(TAG, headers.name(i) + ":" + headers.value(i));
        }
        Log.d(TAG, "onResponse: " + response.body().string());
    }
});

響應(yīng)內(nèi)容

http/1.1 200 OK 
Date:Sat, 10 Mar 2018 05:23:20 GMT 
Content-Type:text/html;charset=utf-8
Content-Length:18
Server:GitHub.com 
Status:200 OK 
X-RateLimit-Limit:60
X-RateLimit-Remaining:52
X-RateLimit-Reset:1520661052
X-CommonMarker-Version:0.17.4
Access-Control-Expose-Headers:ETag, Link, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval

Access-Control-Allow-Origin:*
Content-Security-Policy:default-src 'none'
Strict-Transport-Security:max-age=31536000; includeSubdomains; preload 
X-Content-Type-Options:nosniff 
X-Frame-Options:deny 
X-XSS-Protection:1; mode=block 
X-Runtime-rack:0.019668
Vary:Accept-Encoding 
X-GitHub-Request-Id:1474:20A83:5CC0B6:7A7C1B:5AA36BC8 
onResponse: <p>I am Jdqm.</p>

2.2 POST方式提交流

RequestBody requestBody = new RequestBody() {
    @Nullable
    @Override
    public MediaType contentType() {
        return MediaType.parse("text/x-markdown; charset=utf-8");
    }

    @Override
    public void writeTo(BufferedSink sink) throws IOException {
        sink.writeUtf8("I am Jdqm.");
    }
};

Request request = new Request.Builder()
        .url("https://api.github.com/markdown/raw")
        .post(requestBody)
        .build();
OkHttpClient okHttpClient = new OkHttpClient();
okHttpClient.newCall(request).enqueue(new Callback() {
    @Override
    public void onFailure(Call call, IOException e) {
        Log.d(TAG, "onFailure: " + e.getMessage());
    }

    @Override
    public void onResponse(Call call, Response response) throws IOException {
        Log.d(TAG, response.protocol() + " " +response.code() + " " + response.message());
        Headers headers = response.headers();
        for (int i = 0; i < headers.size(); i++) {
            Log.d(TAG, headers.name(i) + ":" + headers.value(i));
        }
        Log.d(TAG, "onResponse: " + response.body().string());
    }
});

2.3. POST提交文件

MediaType mediaType = MediaType.parse("text/x-markdown; charset=utf-8");
OkHttpClient okHttpClient = new OkHttpClient();
File file = new File("test.md");
Request request = new Request.Builder()
        .url("https://api.github.com/markdown/raw")
        .post(RequestBody.create(mediaType, file))
        .build();
okHttpClient.newCall(request).enqueue(new Callback() {
    @Override
    public void onFailure(Call call, IOException e) {
        Log.d(TAG, "onFailure: " + e.getMessage());
    }

    @Override
    public void onResponse(Call call, Response response) throws IOException {
        Log.d(TAG, response.protocol() + " " +response.code() + " " + response.message());
        Headers headers = response.headers();
        for (int i = 0; i < headers.size(); i++) {
            Log.d(TAG, headers.name(i) + ":" + headers.value(i));
        }
        Log.d(TAG, "onResponse: " + response.body().string());
    }
});

2.4. POST方式提交表單

OkHttpClient okHttpClient = new OkHttpClient();
RequestBody requestBody = new FormBody.Builder()
        .add("search", "Jurassic Park")
        .build();
Request request = new Request.Builder()
        .url("https://en.wikipedia.org/w/index.php")
        .post(requestBody)
        .build();

okHttpClient.newCall(request).enqueue(new Callback() {
    @Override
    public void onFailure(Call call, IOException e) {
        Log.d(TAG, "onFailure: " + e.getMessage());
    }

    @Override
    public void onResponse(Call call, Response response) throws IOException {
        Log.d(TAG, response.protocol() + " " +response.code() + " " + response.message());
        Headers headers = response.headers();
        for (int i = 0; i < headers.size(); i++) {
            Log.d(TAG, headers.name(i) + ":" + headers.value(i));
        }
        Log.d(TAG, "onResponse: " + response.body().string());
    }
});

提交表單時斤富，使用 RequestBody 的實現(xiàn)類FormBody來描述請求體膏潮，它可以攜帶一些經(jīng)過編碼的 key-value 請求體，鍵值對存儲在下面兩個集合中：

  private final List<String> encodedNames;
  private final List<String> encodedValues;

2.5. POST方式提交分塊請求

MultipartBody 可以構(gòu)建復(fù)雜的請求體满力，與HTML文件上傳形式兼容焕参。多塊請求體中每塊請求都是一個請求體，可以定義自己的請求頭油额。這些請求頭可以用來描述這塊請求叠纷，例如它的 Content-Disposition 。如果 Content-Length 和 Content-Type 可用的話潦嘶，他們會被自動添加到請求頭中涩嚣。

private static final String IMGUR_CLIENT_ID = "...";
private static final MediaType MEDIA_TYPE_PNG = MediaType.parse("image/png");

private void postMultipartBody() {
    OkHttpClient client = new OkHttpClient();

    // Use the imgur image upload API as documented at https://api.imgur.com/endpoints/image
    MultipartBody body = new MultipartBody.Builder("AaB03x")
            .setType(MultipartBody.FORM)
            .addPart(
                    Headers.of("Content-Disposition", "form-data; name=\"title\""),
                    RequestBody.create(null, "Square Logo"))
            .addPart(
                    Headers.of("Content-Disposition", "form-data; name=\"image\""),
                    RequestBody.create(MEDIA_TYPE_PNG, new File("website/static/logo-square.png")))
            .build();

    Request request = new Request.Builder()
            .header("Authorization", "Client-ID " + IMGUR_CLIENT_ID)
            .url("https://api.imgur.com/3/image")
            .post(body)
            .build();

    Call call = client.newCall(request);
    call.enqueue(new Callback() {
        @Override
        public void onFailure(Call call, IOException e) {

        }

        @Override
        public void onResponse(Call call, Response response) throws IOException {
            System.out.println(response.body().string());

        }

    });
}

III.攔截器-interceptor

OkHttp的攔截器鏈可謂是其整個框架的精髓，用戶可傳入的 interceptor 分為兩類：
①一類是全局的 interceptor掂僵，該類 interceptor 在整個攔截器鏈中最早被調(diào)用航厚，通過 OkHttpClient.Builder#addInterceptor(Interceptor) 傳入；
②另外一類是非網(wǎng)頁請求的 interceptor 锰蓬，這類攔截器只會在非網(wǎng)頁請求中被調(diào)用幔睬，并且是在組裝完請求之后，真正發(fā)起網(wǎng)絡(luò)請求前被調(diào)用芹扭，所有的 interceptor 被保存在 List<Interceptor> interceptors 集合中麻顶，按照添加順序來逐個調(diào)用赦抖，具體可參考 RealCall#getResponseWithInterceptorChain() 方法。通過 OkHttpClient.Builder#addNetworkInterceptor(Interceptor) 傳入澈蚌；

這里舉一個簡單的例子摹芙，例如有這樣一個需求，我要監(jiān)控App通過 OkHttp 發(fā)出的所有原始請求宛瞄，以及整個請求所耗費的時間浮禾，針對這樣的需求就可以使用第一類全局的 interceptor 在攔截器鏈頭去做。

OkHttpClient okHttpClient = new OkHttpClient.Builder()
        .addInterceptor(new LoggingInterceptor())
        .build();
Request request = new Request.Builder()
        .url("http://www.publicobject.com/helloworld.txt")
        .header("User-Agent", "OkHttp Example")
        .build();
okHttpClient.newCall(request).enqueue(new Callback() {
    @Override
    public void onFailure(Call call, IOException e) {
        Log.d(TAG, "onFailure: " + e.getMessage());
    }

    @Override
    public void onResponse(Call call, Response response) throws IOException {
        ResponseBody body = response.body();
        if (body != null) {
            Log.d(TAG, "onResponse: " + response.body().string());
            body.close();
        }
    }
});


public class LoggingInterceptor implements Interceptor {
    private static final String TAG = "LoggingInterceptor";

    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();

        long startTime = System.nanoTime();
        Log.d(TAG, String.format("Sending request %s on %s%n%s",
                request.url(), chain.connection(), request.headers()));

        Response response =  chain.proceed(request);

        long endTime = System.nanoTime();
        Log.d(TAG, String.format("Received response for %s in %.1fms%n%s",
                response.request().url(), (endTime - startTime) / 1e6d, response.headers()));

        return response;
    }
}

針對這個請求份汗，打印出來的結(jié)果

Sending request http://www.publicobject.com/helloworld.txt on null
User-Agent: OkHttp Example

Received response for https://publicobject.com/helloworld.txt in 1265.9ms
Server: nginx/1.10.0 (Ubuntu)
Date: Wed, 28 Mar 2018 08:19:48 GMT
Content-Type: text/plain
Content-Length: 1759
Last-Modified: Tue, 27 May 2014 02:35:47 GMT
Connection: keep-alive
ETag: "5383fa03-6df"
Accept-Ranges: bytes

注意到一點是這個請求做了重定向盈电，原始的 request url 是 http://www.publicobject.com/helloworld.tx，而響應(yīng)的 request url 是 https://publicobject.com/helloworld.txt杯活，這說明一定發(fā)生了重定向匆帚，但是做了幾次重定向其實我們這里是不知道的，要知道這些的話旁钧，可以使用 addNetworkInterceptor()去做吸重。更多的關(guān)于 interceptor的使用以及它們各自的優(yōu)缺點，請移步OkHttp官方說明文檔歪今。

image.png

IV. 自定義dns服務(wù)

Okhttp默認情況下使用的是系統(tǒng)

V.其他

  1. 推薦讓 OkHttpClient 保持單例嚎幸，用同一個 OkHttpClient 實例來執(zhí)行你的所有請求，因為每一個 OkHttpClient 實例都擁有自己的連接池和線程池寄猩，重用這些資源可以減少延時和節(jié)省資源嫉晶，如果為每個請求創(chuàng)建一個 OkHttpClient 實例，顯然就是一種資源的浪費田篇。當(dāng)然替废，也可以使用如下的方式來創(chuàng)建一個新的 OkHttpClient 實例，它們共享連接池泊柬、線程池和配置信息椎镣。
    OkHttpClient eagerClient = client.newBuilder()
        .readTimeout(500, TimeUnit.MILLISECONDS)
        .build();
    Response response = eagerClient.newCall(request).execute();
  1. 每一個Call（其實現(xiàn)是RealCall）只能執(zhí)行一次，否則會報異常兽赁，具體參見 RealCall#execute()
最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 人面猴
    序言：七十年代末衣陶，一起剝皮案震驚了整個濱河市，隨后出現(xiàn)的幾起案子闸氮，更是在濱河造成了極大的恐慌，老刑警劉巖教沾，帶你破解...
    沈念sama閱讀 218,755評論 6贊 507
  • 死咒
    序言：濱河連續(xù)發(fā)生了三起死亡事件蒲跨，死亡現(xiàn)場離奇詭異，居然都是意外死亡授翻，警方通過查閱死者的電腦和手機或悲，發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,305評論 3贊 395
  • 救了他兩次的神仙讓他今天三更去死
    文/潘曉璐 我一進店門孙咪，熙熙樓的掌柜王于貴愁眉苦臉地迎上來，“玉大人巡语，你說我怎么就攤上這事翎蹈。” “怎么了男公？”我有些...
    開封第一講書人閱讀 165,138評論 0贊 355
  • 道士緝兇錄：失蹤的賣姜人
    文/不壞的土叔 我叫張陵荤堪，是天一觀的道長。 經(jīng)常有香客問我枢赔，道長澄阳，這世上最難降的妖魔是什么？ 我笑而不...
    開封第一講書人閱讀 58,791評論 1贊 295
  • ?港島之戀（遺憾婚禮）
    正文 為了忘掉前任踏拜，我火速辦了婚禮碎赢，結(jié)果婚禮上，老公的妹妹穿的比我還像新娘速梗。我一直安慰自己肮塞，他們只是感情好，可當(dāng)我...
    茶點故事閱讀 67,794評論 6贊 392
  • 惡毒庶女頂嫁案：這布局不是一般人想出來的
    文/花漫 我一把揭開白布姻锁。 她就那樣靜靜地躺著枕赵，像睡著了一般。 火紅的嫁衣襯著肌膚如雪屋摔。 梳的紋絲不亂的頭發(fā)上烁设，一...
    開封第一講書人閱讀 51,631評論 1贊 305
  • 城市分裂傳說
    那天，我揣著相機與錄音钓试，去河邊找鬼装黑。 笑死，一個胖子當(dāng)著我的面吹牛弓熏，可吹牛的內(nèi)容都是我干的恋谭。 我是一名探鬼主播，決...
    沈念sama閱讀 40,362評論 3贊 418
  • 雙鴛鴦連環(huán)套：你想象不到人心有多黑
    文/蒼蘭香墨 我猛地睜開眼挽鞠，長吁一口氣：“原來是場噩夢啊……” “哼疚颊！你這毒婦竟也來了？” 一聲冷哼從身側(cè)響起信认，我...
    開封第一講書人閱讀 39,264評論 0贊 276
  • 萬榮殺人案實錄
    序言：老撾萬榮一對情侶失蹤材义，失蹤者是張志新（化名）和其女友劉穎，沒想到半個月后嫁赏，有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體其掂，經(jīng)...
    沈念sama閱讀 45,724評論 1贊 315
  • ?護林員之死
    正文 獨居荒郊野嶺守林人離奇死亡，尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,900評論 3贊 336
  • ?白月光啟示錄
    正文 我和宋清朗相戀三年潦蝇，在試婚紗的時候發(fā)現(xiàn)自己被綠了款熬。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片深寥。...
    茶點故事閱讀 40,040評論 1贊 350
  • 活死人
    序言：一個原本活蹦亂跳的男人離奇死亡，死狀恐怖贤牛，靈堂內(nèi)的尸體忽然破棺而出惋鹅，到底是詐尸還是另有隱情，我是刑警寧澤殉簸，帶...
    沈念sama閱讀 35,742評論 5贊 346
  • ?日本核電站爆炸內(nèi)幕
    正文 年R本政府宣布闰集，位于F島的核電站，受9級特大地震影響喂链，放射性物質(zhì)發(fā)生泄漏返十。R本人自食惡果不足惜，卻給世界環(huán)境...
    茶點故事閱讀 41,364評論 3贊 330
  • 男人毒藥：我在死后第九天來索命
    文/蒙蒙 一椭微、第九天 我趴在偏房一處隱蔽的房頂上張望洞坑。 院中可真熱鬧，春花似錦蝇率、人聲如沸迟杂。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,944評論 0贊 22
  • 一樁弒父案本慕，背后竟有這般陰謀
    文/蒼蘭香墨 我抬頭看了看天上的太陽排拷。三九已至，卻和暖如春锅尘，著一層夾襖步出監(jiān)牢的瞬間监氢，已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,060評論 1贊 270
  • 情欲美人皮
    我被黑心中介騙來泰國打工藤违， 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留浪腐，地道東北人。 一個月前我還...
    沈念sama閱讀 48,247評論 3贊 371
  • 代替公主和親
    正文 我出身青樓顿乒，卻偏偏與公主長得像议街，于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子璧榄，可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,979評論 2贊 355