我們一起聊聊日常開發必備神器 OkHttp3

作者：了不起 2023-03-26 07:58:04

雖然可選擇的工具很多，但是作為一名開發者，我們希望在寫代碼的時候，能夠輕松地調試我們應用程序的網絡通信，選擇適合的工具至關重要！

?一、摘要

現在開源的市場上，能網絡請求的工具非常的多，比如 HttpURLConnection 、Apache HttpClient、okHttp、Retrofit 等等。

雖然可選擇的工具很多，但是作為一名開發者，我們希望在寫代碼的時候，能夠輕松地調試我們應用程序的網絡通信，選擇適合的工具至關重要！

就目前我們所熟悉的，其中 Apache HttpClient 因其高效的性能、豐富的 api，在開源項目中使用非常廣泛，Android 系統最早默認的網絡請求工具也是使用 Apache HttpClient，但因為兼容性問題，Android 后期的版本中谷歌不愿意維護相關包，改而使用 okHttp。

現在 Android 系統中的網絡請求框架，基本都是 okhttp 和 Retrofit 一統天下，兩者其實都是 square 公司出品的，不同的地方在于 Retrofit 是基于 OkHttp 封裝的一套 RESTful 網絡請求框架，使用方面更加靈活，屬于后起之秀！

既然大家都覺得 OkHttp 好用，今天我們就一起來認識一下它！

來著網上對于 OkHttp 相關的介紹如下！

OkHttp 是 Square 公司基于 Java 和 Android 程序，封裝的一個高性能 http 網絡請求客戶端，并且對外開源，它的設計初衷是為了更快地加載資源并節省帶寬。

以下是使用 OkHttp 的主要優勢：

支持HTTP/2（有效使用套接字）
連接池（在沒有HTTP/2的情況下減少請求延遲）
GZIP壓縮（縮小下載大小）
響應緩存（避免了重新獲取相同的數據）
從常見的連接問題中無聲恢復
替代 IP 地址檢測（在 IPv4 和 IPv6 環境下）
支持現代TLS功能（TLS 1.3，ALPN，證書釘子）
支持同步和異步調用

目前 OkHttp 在開源項目中被廣泛使用，同時也是 Retrofit、Picasso 等庫的核心庫。

既然這么厲害，在網絡通信中我們如何使用呢，我們一起來學習一下！

二、案例實踐

2.1、添加依賴包

在使用之前，我們需要先導入okhttp?依賴包，不同的版本號，相關 api 稍有區別，本次介紹的 api 操作基于3.14.9版本號。

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

2.2、get 同步請求

okhttp?發起get同步請求非常的簡單，只需要幾行代碼就可以搞定。

案例如下！

String url = "https://www.baidu.com/";

OkHttpClient client = new OkHttpClient();
// 配置GET請求
Request request = new Request.Builder()
        .url(url)
        .get()
        .build();

// 發起同步請求
try (Response response = client.newCall(request).execute()){
    // 打印返回結果
    System.out.println(response.body().string());
} catch (Exception e) {
    e.printStackTrace();
}

2.3、post 表單同步請求

okhttp?發起post表單格式的數據提交，同步請求編程也非常的簡單，只需要幾行代碼就可以搞定。

案例如下！

String url = "https://www.baidu.com/";

OkHttpClient client = new OkHttpClient();
// 配置 POST + FORM 格式數據請求
RequestBody body = new FormBody.Builder()
        .add("userName", "zhangsan")
        .add("userPwd", "123456")
        .build();
Request request = new Request.Builder()
        .url(url)
        .post(body)
        .build();

// 發起同步請求
try (Response response = client.newCall(request).execute()){
    // 打印返回結果
    System.out.println(response.body().string());
} catch (Exception e) {
    e.printStackTrace();
}

2.4、post 表單 + 文件上傳，同步請求

如果在發起表單請求的時候，還需要上傳文件，該如何實現呢？

案例如下！

String url = "https://www.baidu.com/";

OkHttpClient client = new OkHttpClient();

// 要上傳的文件
File file = new File("/doc/Downloads/429545913565844e9b26f97dbb57a1c3.jpeg");
RequestBody fileBody = RequestBody.create(MediaType.parse("image/jpg"), file);

// 表單 + 文件數據提交
RequestBody multipartBody = new MultipartBody.Builder()
        .setType(MultipartBody.FORM)
        .addFormDataPart("userName", "zhangsan")
        .addFormDataPart("userPwd", "123456")
        .addFormDataPart("userFile", "00.png", fileBody)
        .build();
Request request = new Request.Builder()
        .url(url)
        .post(multipartBody)
        .build();

// 發起同步請求
try (Response response = client.newCall(request).execute()){
    // 打印返回結果
    System.out.println(response.body().string());
} catch (Exception e) {
    e.printStackTrace();
}

2.5、post + json 數據，同步請求

okhttp?發起post? + json格式的數據提交，同步請求編程也很簡單。

案例如下！

MediaType contentType = MediaType.get("application/json; charset=utf-8");
String url = "https://www.baidu.com/";
String json = "{}";

OkHttpClient client = new OkHttpClient();
// 配置 POST + JSON 請求
RequestBody body = RequestBody.create(contentType, json);
Request request = new Request.Builder()
        .url(url)
        .post(body)
        .build();

// 發起同步請求
try (Response response = client.newCall(request).execute()){
    // 打印返回結果
    System.out.println(response.body().string());
} catch (Exception e) {
    e.printStackTrace();
}

2.5、文件下載，同步請求

文件下載，通常是get方式請求，只需要在響應端使用字節流接受數據即可！

案例如下！

public static void main(String[] args)  {
    //目標存儲文件
    String targetFile = "/doc/Downloads/1.png";
    //需要下載的原始文件
    String url = "https://www.baidu.com/img/PCtm_d9c8750bed0b3c7d089fa7d55720d6cf.png";

    OkHttpClient client = new OkHttpClient();
    // 配置GET請求
    Request request = new Request.Builder()
            .url(url)
            .build();

    // 發起同步請求
    try (Response response = client.newCall(request).execute()){
        // 獲取文件字節流
        byte[] stream = response.body().bytes();
        // 寫入目標文件
        writeFile(targetFile, stream);
    } catch (Exception e) {
        e.printStackTrace();
    }
}


/**
 * 寫入目標文件
 * @param targetFile
 * @param stream
 * @throws IOException
 */
private static void writeFile(String targetFile, byte[] stream) throws IOException {
    String filePath = StringUtils.substringBeforeLast(targetFile, "/");
    Path folderPath = Paths.get(filePath);
    if(!Files.exists(folderPath)){
        Files.createDirectories(folderPath);
    }
    Path targetFilePath = Paths.get(targetFile);
    if(!Files.exists(targetFilePath)){
        Files.write(targetFilePath, stream, StandardOpenOption.CREATE);
    }
}

2.6、其他方式的同步請求

在實際的項目開發中，有的接口需要使用put?或者delete方式請求，應該如何處理呢？

put方式請求，案例如下！

// 只需要在 Request 配置類中，換成 put 方式即可
Request request = new Request.Builder()
        .url(url)
        .put(body)
        .build();

同樣的，delete方式請求也類似，案例如下！

// 只需要在 Request 配置中，換成 delete 方式即可
Request request = new Request.Builder()
        .url(url)
        .delete(body)
        .build();

2.7、自定義添加請求頭部

大部分的時候，基于安全的考慮，很多時候我們需要把相關的鑒權參數放在請求頭部，應該如何處理呢？

以post? + json格式請求為例，添加頭部請求參數，案例如下！

MediaType contentType = MediaType.get("application/json; charset=utf-8");
String url = "https://www.baidu.com/";
String json = "{}";

OkHttpClient client = new OkHttpClient();

// 配置 header 頭部請求參數
Headers headers = new Headers.Builder()
        .add("token", "11111-22222-333")
        .build();

// 配置 POST + JSON 請求
RequestBody body = RequestBody.create(contentType, json);
Request request = new Request.Builder()
        .url(url)
        .headers(headers)
        .post(body)
        .build();

// 發起同步請求
try (Response response = client.newCall(request).execute()){
    // 打印返回結果
    System.out.println(response.body().string());
} catch (Exception e) {
    e.printStackTrace();
}

2.8、發起異步請求

在上文中我們介紹的都是同步請求，在最開始我們也說到 OkHttp 不僅支持同步調用，也異步調用，那么如何進行異步請求編程呢？

其實操作很簡單，案例如下！

String url = "https://www.baidu.com/";
OkHttpClient client = new OkHttpClient().newBuilder().build();
Request request = new Request.Builder()
        .url(url)
        .get()
        .build();

// 發起異步請求
client.newCall(request).enqueue(new Callback() {
    @Override
    public void onFailure(Call call, IOException e) {
        System.out.println("請求異常 + " + e.getMessage());
    }

    @Override
    public void onResponse(Call call, Response response) throws IOException {
        System.out.println("請求完成，返回結果：" + response.body().string());
    }
});

三、小結

以上就是小編針對 OkHttp 在使用上，做了一次簡單的內容總結，整體下來，從使用上來講，api 的操作確實比 Apache HttpClient 要簡單很多。

關于 OkHttp 的內容其實還有很多，比如請求參數的全局配置、全局攔截器、websocket 等功能。

責任編輯：武曉燕來源： Java極客技術

開發工具開源