Okhttp 使用（同步毡惜、異步/get洲守、post/上傳文件）

簡介

目前Android端調(diào)用網(wǎng)絡(luò)請求最常用的框架就是OKHttp亡鼠，目前項目中也經(jīng)常會用到赏殃。OKHTTP有哪些特點(diǎn)呢？下面是官網(wǎng)給出的OKHTTP的特點(diǎn)：

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

官網(wǎng)地址：https://square.github.io/okhttp/
想要詳細(xì)了解HTTP/2抗蠢，可以參考：http://www.reibang.com/p/828a29bced9f

配置

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

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

創(chuàng)建OkHttpClient

OKhttpclient通過builder構(gòu)建迅矛，構(gòu)建的時候涉及到很多配置項，本次簡單對其中一些配置項做了說明潜叛，后續(xù)會對一些重要的配置項做專題說明诬乞。在實(shí)際的項目中的配置項根據(jù)項目具體需求進(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);
    }

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

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

    //添加攔截器特纤，框架內(nèi)部已經(jīng)默認(rèn)添加了部分?jǐn)r截器，通過接口添加的攔截器在列表首部
    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)識主機(jī)名不匹配担败，驗證機(jī)制可以回調(diào)此接口的實(shí)現(xiàn)者昔穴，以確定是否應(yīng)該允許此連接。
    //返回false表示不允許此鏈接提前，無腦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個空閑連接吗货，連接保活5分鐘
//        builder.connectionPool(new ConnectionPool());

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

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

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

      OkHttpClient  client = builder.build();

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

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

同步get請求

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請求對象
        Request request = new Request.Builder()
                //請求地址
                .url(httpUrl)
                //get請求，默認(rèn)為get請求
                .get()
                //添加請求頭崭放，一個key對應(yīng)多個value哨苛，可以自定義
                .addHeader("key", "value")
                .addHeader("key", "value1")
                //請求頭，一對一的币砂，如常見的Content-Type建峭、Accept-Encoding等
                .header("key1", "value1")
                //緩存策略，當(dāng)前使用強(qiáng)制網(wǎng)絡(luò)請求
                .cacheControl(CacheControl.FORCE_NETWORK)
                //緩存策略
                .build();

        try {
            //第三步,開始進(jìn)行同步請求
            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請求會阻塞當(dāng)前線程直到返回結(jié)果亿蒸，請求大致分為四個步驟：

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

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

異步get請求

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


// 第一步，構(gòu)建HttpUrl
// 第二步坛善，構(gòu)建Request請求對象
//第三步,開始進(jìn)行異步請求
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請求

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

與get請求方式不同的是post請求需要構(gòu)建RequestBody组力，在請求時攜帶RequestBody。

異步post請求

public void asynPost(String url) {
        // 第一步抖拴，構(gòu)建HttpUrl
        //第二步燎字，構(gòu)建RequestBody
        // 第三步腥椒，構(gòu)建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());
                }
            }
        });
    }

上傳文件

    //第一步，構(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)
            //在此處添加多個requestBody實(shí)現(xiàn)多文件上傳
            .addFormDataPart("file", file.getName(), requestBody)
            .build();

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

表單提交

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

    // 第三步，構(gòu)建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 使用（同步过椎、異步/get室梅、post/上傳文件）

Okhttp 使用（同步、異步/get、post/上傳文件）

簡介

配置