Android OKHttp使用簡介

更新時間：2021年05月22日 11:45:51 作者：Soybeanmilk

目前Android端調用網絡請求最常用的框架就是OKHttp，目前項目中也經常會用到。介紹下OKHttp的使用場景

支持HTTP/2, HTTP/2通過使用多路復用技術在一個單獨的TCP連接上支持并發(fā), 通過在一個連接上一次性發(fā)送多個請求來發(fā)送或接收數據；
如果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進行開發(fā)了。

創(chuàng)建OkHttpClient

OKhttpclient通過builder構建，構建的時候涉及到很多配置項，本次簡單對其中一些配置項做了說明，后續(xù)會對一些重要的配置項做專題說明。在實際的項目中的配置項根據項目具體需求進行配置。

    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監(jiān)聽所有解析事件的，可以用于解析耗時計算
    builder.eventListener(EventListener.NONE);

    //添加攔截器，框架內部已經默認添加了部分攔截器，通過接口添加的攔截器在列表首部
    builder.addInterceptor(new LogInterceptor());
    //添加網絡攔截器，網絡攔截器可以操作重定向和失敗重連的返回值，以及監(jiān)控所有的網絡數據
    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個空閑連接，連接?；?分鐘
//        builder.connectionPool(new ConnectionPool());

//自定義CookieJar,默認CookieJar.NO_COOKIES
//        builder.cookieJar(CookieJar.NO_COOKIES);

//調度策略,默認最大并發(fā)數默認為 64，但個域名最大請求數 默認為 5 個
//        builder.dispatcher(new Dispatcher());

//配置證書認證策略
//        builder.sslSocketFactory();

      OkHttpClient  client = builder.build();

上述配置項中比較常用的有

緩存文件路徑以及緩存的容量大小
網絡請求的鏈接、讀取、寫入的超時時間
攔截器，這個是OKHTTP最常用的，可以用于處理包括重試、緩存、日志打印等功能
域名和證書的校驗
連接器以及并發(fā)的調度策略等

同步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請求

異步請求方式的步驟和上述前兩個步驟基本一致，主要發(fā)起請求的方式發(fā)生了變化，結果通過回調返回。這種請求方式對請求的線程沒有限制。

// 第一步，構建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 使用的資料請關注腳本之家其它相關文章！

您可能感興趣的文章:

Android?Flutter實現在多端運行的掃雷游戲
當我們回憶起小時候的經典電腦游戲，掃雷一定是其中之一。本文將通過Flutter實現一個能在多端運行的掃雷游戲，感興趣的可以了解一下
2023-03-03
Android Studio 修改類的默認注釋圖文教程
這篇文章主要介紹了Android Studio 修改類的默認注釋圖文教程，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧
2020-03-03
Android控件之GridView用法實例分析
這篇文章主要介紹了Android控件之GridView用法,通過繪制九宮格的實例形式分析了GridView可滾動網格的實現技巧,具有一定參考借鑒價值,需要的朋友可以參考下
2015-09-09
Android繪圖之Paint的使用方法詳解
這篇文章主要給大家介紹了關于Android繪圖之Paint使用的相關資料，文中通過示例代碼介紹的非常詳細，并給大家介紹了DrawText 基線確定的方法，需要的朋友可以參考借鑒，下面隨著小編來一些學習學習吧。
2017-11-11
Android自定義收音機搜臺控件RadioRulerView
這篇文章主要為大家詳細介紹了Android自定義收音機搜臺控件RadioRulerView的相關代碼，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2017-04-04
Android獲取周圍WIFI熱點服務
這篇文章主要為大家詳細介紹了Android獲取周圍WIFI熱點服務的相關資料，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2016-07-07
Android判斷是否為飛行模式簡單方法
這篇文章主要介紹了Android判斷是否為飛行模式簡單方法,本文使用最簡單的方法實現判斷是否為飛行模式,需要的朋友可以參考下
2015-04-04
Android實現數字跳動效果的TextView方法示例
數字跳動效果相信大家應該都見過，在開發(fā)加上這種效果后會讓ui交互看起來非常不錯，所以下面這篇文章主要給大家介紹了Android實現數字跳動的TextView的相關資料，文中給出了詳細的示例代碼，需要的朋友可以參考學習，下面來一起看看吧。
2017-04-04
Android 中的注解詳細介紹
本文主要介紹 Android 中的注解，這里整理詳細的資料來說明Android注解是如何使用，提高編程效率，有興趣的小伙伴可以參考下
2016-08-08
Android截屏分享功能
最近項目經理交給我一個任務，要求實現android截屏功能，包括Android截屏獲取圖片、將圖片保存到本地、通知系統(tǒng)相冊更新、通過微信、QQ、微博分享截屏圖片。小編把實現思路分享到腳本之家平臺，需要的朋友參考下
2017-12-12