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

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

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,657评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,662评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,143评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,732评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,837评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,036评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,126评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,868评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,315评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,641评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,773评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,470评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,126评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,859评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,095评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,584评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,676评论 2 351

推荐阅读更多精彩内容