okhttp 的 POST、GET 请求

okhttp 是时下比较火的一个 http 框架,它支持 get 请求和 post 请求,支持基于 http 的文件上传和下载,支持加载图片,支持下载文件透明的 GZIP 压缩,支持响应缓存避免重复的网络请求,支持使用连接池来降低响应延迟问题。

最近项目上有许多涉及到 http 请求的地方,所以抽个时间总结下相关的用法,既能给自己沉淀一下,也可以帮助到一些初学者~

okhttp 官网地址

okhttp github 地址

基本的配置方法可以看下上面的官网链接。因为在日常开发过程中最常用到的就是 POST 请求和 GET 请求,所以下面主要是整理一下这两种请求方式的使用姿势:

HTTP GET

OkHttpClient okHttpClient = new OkHttpClient();

Request request = new Request.Builder()
                .header("Authorization", AUTHORIZATION)
                .header("key", "value") // cookie、User-Agent 等
                .url(url)
                .build();

try {
    Response response = okHttpClient.newCall(request).execute();
    if (response.isSuccessful()) {
        return response.body().string();
    }
} catch (IOException e) {
    e.printStackTrace();
}

可以通过 response.isSuccessful() 判断是否成功:

Returns true if the code is in [200..300), which means the request was successfully received, understood, and accepted.

GET 请求中如果有 query 类型的参数,可以直接在构造 url 的时候进行相关 query 参数的赋值操作。

HTTP POST

HTTP POST JSON 数据

private static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
OkHttpClient client = new OkHttpClient();

public String post(String url, String json) {
    // must have request body, even null
    RequestBody requestBody = RequestBody.create(JSON, json);

    Request request = new Request.Builder()
                .header("Authorization", API_KEY)
                .url(url)
                .post(requestBody)
                .build();
    try {
        Response response = client.newCall(request).execute();
        if (response.isSucessful()) {
            return response.body().string();
        }
    } catch (IOException e) {
        e.printStackTrace();
    }
}

HTTP POST 表单上传

OkHttpClient okHttpClient = new OkHttpClient();

RequestBody body = new FormBody.Builder()
    .add("key", "value")
    .add("key", "value")
    .build();

Request request = new Request.Builder()
    .url(url)
    .header("Authorization", AUTHORIZATION)
    .post(body)
    .build();

try {
    Response response = okHttpClient.newCall(request).execute();
    if (response.isSuccessful()) {
        return response.body().string();
    }
} catch (IOException e) {
    e.printStackTrace();
}

HTTP POST 提交分块请求

当上传的数据中包含文件的时候,比如上传图片等场景下,要使用这种写法。

OkHttpClient client = new OkHttpClient();

 RequestBody fileBody = RequestBody.create(MediaType.parse("image/png"), file);

RequestBody requestBody = new MultipartBody.Builder()
                .setType(MultipartBody.FORM)
                .addFormDataPart("label", label)
                .addFormDataPart("image_file", file.getName(), fileBody)
                .addFormDataPart("resolution", resolution)
                .build();

Request request = new Request.Builder()
                .url(url)
                .header("Authorization", AUTHORIZATION)
                .post(requestBody)
                .build();

try {
    Response response = client.newCall(request).execute();
    if (response.isSuccessful()) {
        return response.body().string();
    }
} catch (IOException e) {
    e.printStackTrace();
}

同步与异步

在上述例子中,client.newCall(request).execute() 执行后就是在执行 HTTP 请求了,但是这个执行过程是同步的,如果在 Android 的主线程中操作会抛异常,所以 okhttp 也提供了异步的方法:

OkHttpClient okHttpClient = new OkHttpClient();
Request request = new Request.Builder()
        .url(url)
        .build();
okHttpClient.newCall(request).enqueue(new Callback() {
    @Override
    public void onFailure(Call call, IOException e) {
        e.printStackTrace();
    }

    @Override
    public void onResponse(Call call, Response response) throws IOException {
        if (response.isSuccessful()) {
            return response.body().string();
        }
    }
});

因为该操作是在异步线程中调用的,所以不能在回调里更新 UI,如果要在回调中去更新 UI 的话,可以调用 runOnUIThread() 的方式去更新。

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

推荐阅读更多精彩内容