Android OKHttp使用簡介

2021-05-22 13:00:43

下面是官網給出的OKHTTP的特點：

支援HTTP/2, HTTP/2通過使用多路複用技術在一個單獨的TCP連線上支援並行, 通過在一個連線上一次性傳送多個請求來傳送或接收資料；
如果HTTP/2不可用, 連線池複用技術也可以極大減少延時；
透明的Gzip處理降低了通訊資料的大小
響應快取完全避免了網路中的重複請求
使用Okio來簡化資料的存取與儲存，提高效能
如果您的伺服器設定了多個IP地址, 當第一個IP連線失敗的時候, OkHttp會自動嘗試下一個IP
OkHttp還處理了代理伺服器問題和SSL握手失敗問題；

官網地址：square.github.io/okhttp/

設定

新增OKHttp依賴

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

新增網路許可權，如果需要檔案讀寫檔案讀寫許可權

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

接下來就可以愉快的開始使用OKhttp進行開發了。

建立OkHttpClient

OKhttpclient通過builder構建，構建的時候涉及到很多設定項，本次簡單對其中一些設定項做了說明，後續會對一些重要的設定項做專題說明。在實際的專案中的設定項根據專案具體需求進行設定。

    OkHttpClient.Builder builder = new OkHttpClient.Builder();

    //快取目錄
    File externalCacheDir = context.getExternalCacheDir();
    if (externalCacheDir != null) {
        Cache okHttpCache = new Cache(new File(externalCacheDir,
                "HttpCache"), 30 * 1024 * 1024);
        builder.cache(okHttpCache);
    }

    //連線超時時間,連線超時是在將TCP SOCKET 連線到目標主機時應用的，預設10s
    builder.connectTimeout(30, TimeUnit.SECONDS);
    //讀取超時時間, 包括TCP SOCKET和Source 和Response的讀取IO操作，預設10s
    builder.readTimeout(20, TimeUnit.SECONDS);
    //寫入超時時間，主要指IO的寫入操作，預設10s
    builder.writeTimeout(20, TimeUnit.SECONDS);
    //整個呼叫時期的超時時間，包括解析DNS、連結、寫入請求體、伺服器端處理、以及讀取響應結果
    builder.callTimeout(120, TimeUnit.SECONDS);

    //用於單個client監聽所有解析事件的，可以用於解析耗時計算
    builder.eventListener(EventListener.NONE);

    //新增攔截器，框架內部已經預設新增了部分攔截器，通過介面新增的攔截器在列表首部
    builder.addInterceptor(new LogInterceptor());
    //新增網路攔截器，網路攔截器可以操作重定向和失敗重連的返回值，以及監控所有的網路資料
    builder.addNetworkInterceptor(new NetworkInterceptor());

    //在握手期間，如果URL的主機名和伺服器的標識主機名不匹配，驗證機制可以回撥此介面的實現者，以確定是否應該允許此連線。
    //返回false表示不允許此連結，無腦return true 十分不安全
    builder.hostnameVerifier(new HostnameVerifier() {
        @Override
        public boolean verify(String hostname, SSLSession session) {
            return true;
        }
    });

//授權,預設為Authenticator.NONE
//        builder.authenticator(Authenticator.NONE);

//連線池,預設5個空閒連線，連線保活5分鐘
//        builder.connectionPool(new ConnectionPool());

//自定義CookieJar,預設CookieJar.NO_COOKIES
//        builder.cookieJar(CookieJar.NO_COOKIES);

//排程策略,預設最大並行數預設為 64，但個域名最大請求數 預設為 5 個
//        builder.dispatcher(new Dispatcher());

//設定證書認證策略
//        builder.sslSocketFactory();

      OkHttpClient  client = builder.build();

上述設定項中比較常用的有

快取檔案路徑以及快取的容量大小
網路請求的連結、讀取、寫入的超時時間
攔截器，這個是OKHTTP最常用的，可以用於處理包括重試、快取、紀錄檔列印等功能
域名和證書的校驗
聯結器以及並行的排程策略等

同步get請求

public void synGet(String url) {
        
        // 第一步，構建HttpUrl
        HttpUrl.Builder builder = null;
        try {
            HttpUrl httpUrl = HttpUrl.parse(url);
            if(httpUrl != null){
                builder = httpUrl.newBuilder();
            }
        } catch (IllegalArgumentException e) {
            e.printStackTrace();
        }

        if (builder == null) {
            return;
        }
        builder.addQueryParameter("key","value");

        // 第二步，構建Request請求物件
        Request request = new Request.Builder()
                //請求地址
                .url(httpUrl)
                //get請求，預設為get請求
                .get()
                //新增請求頭，一個key對應多個value，可以自定義
                .addHeader("key", "value")
                .addHeader("key", "value1")
                //請求頭，一對一的，如常見的Content-Type、Accept-Encoding等
                .header("key1", "value1")
                //快取策略，當前使用強制網路請求
                .cacheControl(CacheControl.FORCE_NETWORK)
                //快取策略
                .build();

        try {
            //第三步,開始進行同步請求
            Response response = client
                    .newCall(request)
                    .execute();

            //第四步，解析響應結果
            ResponseBody body = response.body();
            if (body != null) {
                Log.d(TAG, body.string());
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

同步get請求會阻塞當前執行緒直到返回結果，請求大致分為四個步驟：

構建HttpUrl，當然這一步不是必須的，也可以直接傳入地址
第二步，構建Request請求物件，可以設定請求頭，快取策略，請求方式
第三步,開始進行同步請求
解析響應結果

注意：同步get請求要在子執行緒中進行，否應用會拋異常。

非同步get請求

非同步請求方式的步驟和上述前兩個步驟基本一致，主要發起請求的方式發生了變化，結果通過回撥返回。這種請求方式對請求的執行緒沒有限制。

// 第一步，構建HttpUrl
// 第二步，構建Request請求物件
//第三步,開始進行非同步請求
client.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {

            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                //第四步，解析響應結果
                ResponseBody body = response.body();
                if (body != null) {
                    Log.d(TAG, body.string());
                }
            }
        });

同步post請求

public void synPost(String url) {
    // 第一步，構建HttpUrl
    HttpUrl.Builder builder = null;
    try {
        HttpUrl httpUrl = HttpUrl.parse(url);
        if (httpUrl != null) {
            builder = httpUrl.newBuilder();
        }
    } catch (IllegalArgumentException e) {
        e.printStackTrace();
    }
    if (builder == null) {
        return;
    }

    //第二步，構建RequestBody
    MediaType mediaType = MediaType.parse("application/json;charset=UTF-8");
    JSONObject jsonObject = new JSONObject();
    try {
        jsonObject.put("key1", "value1");
        jsonObject.put("key2", "value2");
    } catch (JSONException e) {
        e.printStackTrace();
    }
    RequestBody requestBody = RequestBody.create(mediaType, jsonObject.toString());
    // 第三步，構建Request請求物件
    Request request = new Request.Builder()
            .url(builder.build())
            .post(requestBody)
            .build();
    
    //第四步,開始進行同步post請求
    try {
        Response response = client.newCall(request).execute();
        //第五步，解析請求結果
        ResponseBody body = response.body();
        if (body != null) {
            Log.d(TAG, body.string());
        }
    } catch (IOException e) {
        e.printStackTrace();
    }
}

與get請求方式不同的是post請求需要構建RequestBody，在請求時攜帶RequestBody。

非同步post請求

public void asynPost(String url) {
        // 第一步，構建HttpUrl
        //第二步，構建RequestBody
        // 第三步，構建Request請求物件
        Request request = new Request.Builder()
                .url(builder.build())
                .post(requestBody)
                .build();

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

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

上傳檔案

    //第一步，構建HttpUrl
    //第二步，構建RequestBody
    MediaType mediaType = MediaType.parse("multipart/form-data; charset=utf-8");
    RequestBody requestBody = RequestBody.create(mediaType, file);
	//第三步，構建MultipartBody
    MultipartBody body = new MultipartBody.Builder()
            .setType(MultipartBody.FORM)
            //在此處新增多個requestBody實現多檔案上傳
            .addFormDataPart("file", file.getName(), requestBody)
            .build();

    // 第四步，構建Request請求物件
    Request request = new Request.Builder()
            .url(builder.build())
            .post(body)
            .build();
	// 第五步，構建Request請求物件
    client.newCall(request).enqueue(new Callback() {
        @Override
        public void onFailure(Call call, IOException e) {

        }

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

表單提交

	//第二步，構建RequestBody
    FormBody formBody = new FormBody.Builder()
            .add("key1","value1")
            .add("key2","value2")
            .build();

    // 第三步，構建Request請求物件
    Request request = new Request.Builder()
            .url(builder.build())
            .post(formBody)
            .build();

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

        }

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

以上就是OKHttp 使用簡介的詳細內容，更多關於OKHttp 使用的資料請關注it145.com其它相關文章！