Android OKHttp使用簡(jiǎn)介

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

目前Android端調(diào)用網(wǎng)絡(luò)請(qǐng)求最常用的框架就是OKHttp，目前項(xiàng)目中也經(jīng)常會(huì)用到。介紹下OKHttp的使用場(chǎng)景

支持HTTP/2, HTTP/2通過(guò)使用多路復(fù)用技術(shù)在一個(gè)單獨(dú)的TCP連接上支持并發(fā), 通過(guò)在一個(gè)連接上一次性發(fā)送多個(gè)請(qǐng)求來(lái)發(fā)送或接收數(shù)據(jù)；
如果HTTP/2不可用, 連接池復(fù)用技術(shù)也可以極大減少延時(shí)；
透明的Gzip處理降低了通信數(shù)據(jù)的大小
響應(yīng)緩存完全避免了網(wǎng)絡(luò)中的重復(fù)請(qǐng)求
使用Okio來(lái)簡(jiǎn)化數(shù)據(jù)的訪問(wèn)與存儲(chǔ)，提高性能
如果您的服務(wù)器配置了多個(gè)IP地址, 當(dāng)?shù)谝粋€(gè)IP連接失敗的時(shí)候, OkHttp會(huì)自動(dòng)嘗試下一個(gè)IP
OkHttp還處理了代理服務(wù)器問(wèn)題和SSL握手失敗問(wèn)題；

官網(wǎng)地址：square.github.io/okhttp/

配置

添加OKHttp依賴

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

添加網(wǎng)絡(luò)權(quán)限，如果需要文件讀寫文件讀寫權(quán)限

<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" />

接下來(lái)就可以愉快的開(kāi)始使用OKhttp進(jìn)行開(kāi)發(fā)了。

創(chuàng)建OkHttpClient

OKhttpclient通過(guò)builder構(gòu)建，構(gòu)建的時(shí)候涉及到很多配置項(xiàng)，本次簡(jiǎn)單對(duì)其中一些配置項(xiàng)做了說(shuō)明，后續(xù)會(huì)對(duì)一些重要的配置項(xiàng)做專題說(shuō)明。在實(shí)際的項(xiàng)目中的配置項(xiàng)根據(jù)項(xiàng)目具體需求進(jìn)行配置。

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

    //連接超時(shí)時(shí)間,連接超時(shí)是在將TCP SOCKET 連接到目標(biāo)主機(jī)時(shí)應(yīng)用的，默認(rèn)10s
    builder.connectTimeout(30, TimeUnit.SECONDS);
    //讀取超時(shí)時(shí)間, 包括TCP SOCKET和Source 和Response的讀取IO操作，默認(rèn)10s
    builder.readTimeout(20, TimeUnit.SECONDS);
    //寫入超時(shí)時(shí)間，主要指IO的寫入操作，默認(rèn)10s
    builder.writeTimeout(20, TimeUnit.SECONDS);
    //整個(gè)調(diào)用時(shí)期的超時(shí)時(shí)間，包括解析DNS、鏈接、寫入請(qǐng)求體、服務(wù)端處理、以及讀取響應(yīng)結(jié)果
    builder.callTimeout(120, TimeUnit.SECONDS);

    //用于單個(gè)client監(jiān)聽(tīng)所有解析事件的，可以用于解析耗時(shí)計(jì)算
    builder.eventListener(EventListener.NONE);

    //添加攔截器，框架內(nèi)部已經(jīng)默認(rèn)添加了部分?jǐn)r截器，通過(guò)接口添加的攔截器在列表首部
    builder.addInterceptor(new LogInterceptor());
    //添加網(wǎng)絡(luò)攔截器，網(wǎng)絡(luò)攔截器可以操作重定向和失敗重連的返回值，以及監(jiān)控所有的網(wǎng)絡(luò)數(shù)據(jù)
    builder.addNetworkInterceptor(new NetworkInterceptor());

    //在握手期間，如果URL的主機(jī)名和服務(wù)器的標(biāo)識(shí)主機(jī)名不匹配，驗(yàn)證機(jī)制可以回調(diào)此接口的實(shí)現(xiàn)者，以確定是否應(yīng)該允許此連接。
    //返回false表示不允許此鏈接，無(wú)腦return true 十分不安全
    builder.hostnameVerifier(new HostnameVerifier() {
        @Override
        public boolean verify(String hostname, SSLSession session) {
            return true;
        }
    });

//授權(quán),默認(rèn)為Authenticator.NONE
//        builder.authenticator(Authenticator.NONE);

//連接池,默認(rèn)5個(gè)空閑連接，連接?；?分鐘
//        builder.connectionPool(new ConnectionPool());

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

//調(diào)度策略,默認(rèn)最大并發(fā)數(shù)默認(rèn)為 64，但個(gè)域名最大請(qǐng)求數(shù) 默認(rèn)為 5 個(gè)
//        builder.dispatcher(new Dispatcher());

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

      OkHttpClient  client = builder.build();

上述配置項(xiàng)中比較常用的有

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

同步get請(qǐng)求

public void synGet(String url) {
        
        // 第一步，構(gòu)建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");

        // 第二步，構(gòu)建Request請(qǐng)求對(duì)象
        Request request = new Request.Builder()
                //請(qǐng)求地址
                .url(httpUrl)
                //get請(qǐng)求，默認(rèn)為get請(qǐng)求
                .get()
                //添加請(qǐng)求頭，一個(gè)key對(duì)應(yīng)多個(gè)value，可以自定義
                .addHeader("key", "value")
                .addHeader("key", "value1")
                //請(qǐng)求頭，一對(duì)一的，如常見(jiàn)的Content-Type、Accept-Encoding等
                .header("key1", "value1")
                //緩存策略，當(dāng)前使用強(qiáng)制網(wǎng)絡(luò)請(qǐng)求
                .cacheControl(CacheControl.FORCE_NETWORK)
                //緩存策略
                .build();

        try {
            //第三步,開(kāi)始進(jìn)行同步請(qǐng)求
            Response response = client
                    .newCall(request)
                    .execute();

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

同步get請(qǐng)求會(huì)阻塞當(dāng)前線程直到返回結(jié)果，請(qǐng)求大致分為四個(gè)步驟：

構(gòu)建HttpUrl，當(dāng)然這一步不是必須的，也可以直接傳入地址
第二步，構(gòu)建Request請(qǐng)求對(duì)象，可以設(shè)置請(qǐng)求頭，緩存策略，請(qǐng)求方式
第三步,開(kāi)始進(jìn)行同步請(qǐng)求
解析響應(yīng)結(jié)果

注意：同步get請(qǐng)求要在子線程中進(jìn)行，否應(yīng)用會(huì)拋異常。

異步get請(qǐng)求

異步請(qǐng)求方式的步驟和上述前兩個(gè)步驟基本一致，主要發(fā)起請(qǐng)求的方式發(fā)生了變化，結(jié)果通過(guò)回調(diào)返回。這種請(qǐng)求方式對(duì)請(qǐng)求的線程沒(méi)有限制。

// 第一步，構(gòu)建HttpUrl
// 第二步，構(gòu)建Request請(qǐng)求對(duì)象
//第三步,開(kāi)始進(jìn)行異步請(qǐng)求
client.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {

            }

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

同步post請(qǐng)求

public void synPost(String url) {
    // 第一步，構(gòu)建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;
    }

    //第二步，構(gòu)建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());
    // 第三步，構(gòu)建Request請(qǐng)求對(duì)象
    Request request = new Request.Builder()
            .url(builder.build())
            .post(requestBody)
            .build();
    
    //第四步,開(kāi)始進(jìn)行同步post請(qǐng)求
    try {
        Response response = client.newCall(request).execute();
        //第五步，解析請(qǐng)求結(jié)果
        ResponseBody body = response.body();
        if (body != null) {
            Log.d(TAG, body.string());
        }
    } catch (IOException e) {
        e.printStackTrace();
    }
}

與get請(qǐng)求方式不同的是post請(qǐng)求需要構(gòu)建RequestBody，在請(qǐng)求時(shí)攜帶RequestBody。

異步post請(qǐng)求

public void asynPost(String url) {
        // 第一步，構(gòu)建HttpUrl
        //第二步，構(gòu)建RequestBody
        // 第三步，構(gòu)建Request請(qǐng)求對(duì)象
        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());
                }
            }
        });
    }

上傳文件

    //第一步，構(gòu)建HttpUrl
    //第二步，構(gòu)建RequestBody
    MediaType mediaType = MediaType.parse("multipart/form-data; charset=utf-8");
    RequestBody requestBody = RequestBody.create(mediaType, file);
	//第三步，構(gòu)建MultipartBody
    MultipartBody body = new MultipartBody.Builder()
            .setType(MultipartBody.FORM)
            //在此處添加多個(gè)requestBody實(shí)現(xiàn)多文件上傳
            .addFormDataPart("file", file.getName(), requestBody)
            .build();

    // 第四步，構(gòu)建Request請(qǐng)求對(duì)象
    Request request = new Request.Builder()
            .url(builder.build())
            .post(body)
            .build();
	// 第五步，構(gòu)建Request請(qǐng)求對(duì)象
    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());
            }
        }
    });

表單提交

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

    // 第三步，構(gòu)建Request請(qǐng)求對(duì)象
    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 使用簡(jiǎn)介的詳細(xì)內(nèi)容，更多關(guān)于OKHttp 使用的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: