OKHttp3 系列 — 基本使用

Get異步請求

第一步,OkHttpClient的初始化
// 直接初始化,使用所有默認配置
OkHttpClient okHttpClient = new OkHttpClient();

// 配置一些信息進入OkHttpClient
mOkHttpClient = new OkHttpClient().newBuilder()
                .connectTimeout(REQUEST_TIME, TimeUnit.SECONDS)
                .readTimeout(REQUEST_TIME, TimeUnit.SECONDS)
                .writeTimeout(REQUEST_TIME, TimeUnit.SECONDS)
                .addInterceptor(new RetryInterceptor(2))
                .addInterceptor(new LoggerInterceptor())
                .build();
第二步,初始化Request
Request request = new Request.Builder().url(url).build();

其中,url為請求的網絡地址。

第三步,進行異步請求
okHttpClient.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.e(TAG, "onResponse: " + body.string());
        }
    }
});

需要注意的是:
body.string()方法只能調用一次,第二次調用會報一個非法狀態異常java.lang.IllegalStateException: closed

添加頭信息

很多時候請求需要對身份進行驗證,頭信息中添加相應的健值對使得能夠通過服務器端的身份驗證。

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

可以在初始化request的時候塞入頭信息,addHeader方法可以為相同鍵名添加多個值,header方法會覆蓋掉原來的值。

Post異步請求

post請求多了用RequestBody提交表單數據的步驟。

初始化RequestBody(第一種方式)

RequestBody默認有兩個實現子類FormBody、MultipartBody,普通的表單數據提交。

RequestBody requestBody = new FormBody.Builder()
                .add("name", "value")
                .build();

通過add方法把需要提交的數據用健值對的形式提交至服務器。有人說我想提交整個json字符串怎么辦呢?在第二種方式中,待會兒會講到。

MultipartBody表單,可以上傳文件和圖片至服務器。

RequestBody requestBody = new MultipartBody.Builder()
        .setType(MultipartBody.FORM)
        //.addFormDataPart("","")
        .addPart(Headers.of("Content-Disposition", "form-data;name =\"file\";filename=\"img.png\"")
                , RequestBody.create(MediaType.parse("image/png"), file))
        .build();

通過查看源碼,addFormDataPart與addPart最終殊途同歸,addPart可以自定義頭信息,而addFormDataPart也可以,只是需要一個一個添加;

// 源碼
public static Part createFormData(String name, @Nullable String filename, RequestBody body) {
  if (name == null) {
    throw new NullPointerException("name == null");
  }
  StringBuilder disposition = new StringBuilder("form-data; name=");
  appendQuotedString(disposition, name);

  if (filename != null) {
    disposition.append("; filename=");
    appendQuotedString(disposition, filename);
  }

  return create(Headers.of("Content-Disposition", disposition.toString()), body);
}

Headers.of()方法對參數的個數有要求,必須是偶數個數,最終以健值對的形式填入到請求頭信息中。

初始化RequestBody(第二種方式)
MediaType MEDIA_TYPE_JSON = MediaType.parse("application/json");
RequestBody requestBody = RequestBody.create(MEDIA_TYPE_JSON, obj.toString());

create方法第一個參數為網絡協議的消息頭里的Content-Type,一般情況下以下幾種類型較為常見:

application/x-www-form-urlencoded
multipart/form-data
text/plain
application/json

application/x-www-form-urlencoded:瀏覽器標準的編碼格式,支持最為普遍,提交數據以健值對形式提交;

multipart/form-data:提交的數據會被分隔符隔開,并且會加上一些Content-Disposition屬性。

application/json:以json格式進行數據提交。

第二個參數就是一個json字符串,標準格式的json字符串可以直接傳遞進入,比如:

{"CityId":18,"CityName":"changsha","ProvinceId":27,"CityOrder":1}
初始化request

通過post方法把相應的RequestBody對象傳遞進去。

RequestBody requestBody = new FormBody.Builder()
        .add("name", "value")
        .build();

Request request = new Request.Builder().url(url).post(requestBody).build();
進行異步請求
okHttpClient.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.e(TAG, "onResponse: " + body.string());
        }
    }
});

到此,一些基本使用基本講完,后面會接著講一些其他場景的應用。

由于水平有限,如有錯誤,歡迎指出,相互學習,共同進步。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容