詳細介紹androidokhttp網路請求庫

一、基礎介紹

AndroidOkHttp是由Square公司出品的一款輕量級的網路請求庫，它支持HTTP/2、WebSocket，擁有一個易於使用和靈活可擴展的API。

OkHttp是一個高效的HTTP客戶端，其優秀的性能和易於使用的API使其成為廣泛應用的網路請求庫之一。

二、基本用法

在使用AndroidOkHttp進行網路請求時，首先需要導入OkHttp庫。

dependencies {
    implementation 'com.squareup.okhttp3:okhttp:4.4.0'
}

OkHttp庫主要包含了OkHttpClient和Request這兩個類。使用OkHttpClient可以創建一個HTTP客戶端來處理網路請求，而Request則是我們需要發送的網路請求。

以下是一個簡單的使用實例：

OkHttpClient client = new OkHttpClient();

String url = "http://www.example.com";

Request request = new Request.Builder()
  .url(url)
  .build();

Call call = client.newCall(request);
Response response = call.execute();

三、OkHttpClient詳解

1.基礎參數設置

在創建OkHttpClient實例時，我們可以設置一些基礎的參數，如連接超時時間、讀取超時時間等。

以下是一個基本設置的例子：

OkHttpClient client = new OkHttpClient.Builder()
        .connectTimeout(10, TimeUnit.SECONDS)//連接超時時間
        .readTimeout(10, TimeUnit.SECONDS)//讀取超時時間
        .writeTimeout(10, TimeUnit.SECONDS)//寫入超時時間
        .build();

2.請求攔截器

OkHttpClient提供了請求攔截器的機制，可以在發送請求前對請求進行處理。

以下是一個簡單的請求攔截器的例子，它會在請求頭中添加一個自定義的User-Agent欄位：

OkHttpClient client = new OkHttpClient.Builder()
        .addInterceptor(new Interceptor() {
            @Override
            public Response intercept(Chain chain) throws IOException {
                Request request = chain.request().newBuilder()
                        .addHeader("User-Agent", "Android")
                        .build();
                return chain.proceed(request);
            }
         })
        .build();

3.響應攔截器

OkHttpClient同樣提供了響應攔截器的機制，可以在處理伺服器返回的響應時進行處理。

以下是一個簡單的響應攔截器的例子，它會在響應體中添加一個自定義的Content-Type欄位：

OkHttpClient client = new OkHttpClient.Builder()
        .addInterceptor(new Interceptor() {
            @Override
            public Response intercept(Chain chain) throws IOException {
                Response response = chain.proceed(chain.request());
                return response.newBuilder()
                        .addHeader("Content-Type", "application/json")
                        .build();
            }
        })
        .build();

四、Request詳解

1.構建請求

在使用OkHttp發送請求時，我們需要構建一個Request對象，設置請求的URL、請求頭、請求體等參數。

以下是一個構建POST請求的例子：

String url = "http://www.example.com";

RequestBody body = new FormBody.Builder()
        .add("key1", "value1")
        .add("key2", "value2")
        .build();

Request request = new Request.Builder()
        .url(url)
        .post(body)
        .build();

2.請求頭

我們可以在請求頭中設置一些欄位，如User-Agent、Authorization等。

以下是一個設置請求頭的例子：

Request request = new Request.Builder()
        .url(url)
        .addHeader("User-Agent", "Android")
        .addHeader("Authorization", "Bearer token")
        .build();

3.請求體

在請求中，我們可以設置請求體，如POST請求中的表單數據、上傳文件等。

以下是一個設置請求體的例子：

RequestBody body = new FormBody.Builder()
        .add("key1", "value1")
        .add("key2", "value2")
        .build();

Request request = new Request.Builder()
        .url(url)
        .post(body)
        .build();

五、非同步請求

AndroidOkHttp提供了非同步請求的機制，通過將請求放到子線程中執行，可以避免在主線程中進行網路請求時出現ANR的問題。

以下是一個簡單的非同步請求的例子：

String url = "http://www.example.com";

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
        .url(url)
        .build();

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

    @Override
    public void onResponse(Call call, Response response) throws IOException {
        String result = response.body().string();
        Log.d("OkHttp", result);
    }
});

六、文件上傳

在AndroidOkHttp中，我們可以使用MultipartBody來上傳文件。MultipartBody是一個組件，可以將多個請求體部分組成一個請求。

以下是一個簡單的文件上傳的例子：

String url = "http://www.example.com/upload";

File file = new File("/sdcard/test.png");

RequestBody requestBody = new MultipartBody.Builder()
        .setType(MultipartBody.FORM)
        .addFormDataPart("uploaded_file", file.getName(), RequestBody.create(MediaType.parse("image/png"), file))
        .build();

Request request = new Request.Builder()
        .url(url)
        .post(requestBody)
        .build();

OkHttpClient client = new OkHttpClient();
Response response = client.newCall(request).execute();

七、SSL/TLS

在網路請求中，SSL/TLS技術是一種廣泛應用的安全協議，用於保護數據在網路上的傳輸安全性。AndroidOkHttp提供了對於SSL/TLS的支持，可以安全地進行網路請求。

以下是一個簡單的HTTPS請求的例子：

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

OkHttpClient client = new OkHttpClient.Builder()
        .sslSocketFactory(getSSLSocketFactory(), getTrustManager())
        .build();

Request request = new Request.Builder()
        .url(url)
        .build();

Response response = client.newCall(request).execute();

這裡getSSLSocketFactory()和getTrustManager()是自定義的方法，用於獲取SSLSocketFactory和TrustManager，這部分內容不再詳細闡述。

八、大文件下載

大文件下載是一個比較常見的需求，我們可以使用AndroidOkHttp進行大文件的下載。

以下是一個簡單的大文件下載的例子：

String url = "http://www.example.com/large.zip";

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
        .url(url)
        .build();

Response response = client.newCall(request).execute();

FileOutputStream fos = new FileOutputStream("/sdcard/large.zip");
BufferedOutputStream bos = new BufferedOutputStream(fos);

int len;
byte[] buf = new byte[2048];
while ((len = response.body().byteStream().read(buf)) != -1) {
    bos.write(buf, 0, len);
    bos.flush();
}

bos.close();
fos.close();

總結

AndroidOkHttp是一個性能優秀、易於使用的網路請求庫，擁有豐富的功能和靈活的API，可以幫助我們高效地進行網路請求和數據交互。