OKHttp3的基本使用

作者: 一盘好书 | 来源:发表于2018-03-12 22:09 被阅读94次

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

到此,一些基本使用基本讲完,后面会接着讲一些其他场景的应用。

由于水平有限,如有错误,欢迎指出,相互学习,共同进步。

相关文章

网友评论

    本文标题:OKHttp3的基本使用

    本文链接:https://www.haomeiwen.com/subject/ozvifftx.html