Java發送http請求方法之OkHttp3

1、前言

適用於Android開發和Web開發。

2、依賴

<dependency>
  <groupId>com.squareup.okhttp3</groupId>
  <artifactId>okhttp</artifactId>
  <version>3.3.0</version>
</dependency>

3、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添加參數。例如Cookie，User-Agent什么的，就是

Request request = new Request.Builder()
    .url(url)
    .header("鍵", "值")
    .header("鍵", "值")
    ...
    .build();

response的body有很多種輸出方法，string()只是其中之一，注意是string()不是toString()。如果是下載文件就是response.body().bytes()。另外可以根據response.code()獲取返回的狀態碼。

4、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請求創建request和get是一樣的，只是post請求需要提交一個表單，就是RequestBody。表單的格式有好多種，普通的表單是：

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

RequestBody的數據格式都要指定Content-Type，常見的有三種：

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

但是好像以上的普通表單並沒有指定Content-Type，這是因為FormBody繼承了RequestBody，它已經指定了數據類型為application/x-www-form-urlencoded。

private static final MediaType CONTENT_TYPE = MediaType.parse("application/x-www-form-urlencoded");

再看看數據為其它類型的RequestBody的創建方式。
如果表單是個json：

MediaType JSON = MediaType.parse("application/json; charset=utf-8");
RequestBody body = RequestBody.create(JSON, "你的json");

如果數據包含文件

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");

5、同步和異步

從上文已經能知道call.execute()就是在執行http請求了，但是這是個同步操作，是在主線程運行的。如果你在android的UI線程直接執行這句話就出異常了。
OkHttp也幫我們實現了異步，寫法是：

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();
    }
}

執行結果是：

我是主線程,線程Id為:1
我是主線程,線程Id為:1
我是主線程,線程Id為:1
我是異步線程,線程Id為:11
我是主線程,線程Id為:1
我是主線程,線程Id為:1
我是主線程,線程Id為:1
我是主線程,線程Id為:1
我是主線程,線程Id為:1
我是主線程,線程Id為:1
我是主線程,線程Id為:1

顯然onFailure()和onResponse()分別是在請求失敗和成功時會調用的方法。這里有個要注意的地方，onFailure()和onResponse()是在異步線程里執行的，所以如果你在Android把更新UI的操作寫在這兩個方法里面是會報錯的，這個時候可以用runOnUiThread這個方法。

6、自動管理Cookie

Request經常都要攜帶Cookie，上面說過request創建時可以通過header設置參數，Cookie也是參數之一。就像下面這樣：

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

然后可以從返回的response里得到新的Cookie，你可能得想辦法把Cookie保存起來。
但是OkHttp可以不用我們管理Cookie，自動攜帶，保存和更新Cookie。
方法是在創建OkHttpClient設置管理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();

這樣以后發送Request都不用管Cookie這個參數也不用去response獲取新Cookie什么的了。還能通過cookieStore獲取當前保存的Cookie。
最后，new OkHttpClient()只是一種快速創建OkHttpClient的方式，更標准的是使用OkHttpClient.Builder()。后者可以設置一堆參數，例如超時時間什么的。

7、上傳文件和下載文件

自己查看文檔吧。。。