1. 程式人生 > >OkHttp3的基本用法

OkHttp3的基本用法

這篇文章說下OkHttp的基本用法,是最新的3哦,如果你曾經在網上搜索OkHttp怎麼使用發現有些類沒有了可能是因為人家說的是2。

首先說下OkHttp3是Java和Android都能用,Android還有一個著名網路庫叫Volley,那個只有Android能用。

匯入

自己到入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新增引數。例如Cookie,User-Agent什麼的,就是

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

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

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

另外如果你上傳一個檔案不是一張圖片,但是MediaType.parse(“image/png”)裡的”image/png”不知道該填什麼,可以參考下這個頁面

同步與非同步

從上文已經能知道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這個方法。

自動管理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()。後者可以設定一堆引數,例如超時時間什麼的。