OkHttp的使用

1.Http网络请求基本知识
2.OkHttp的基本使用
3.Call模型

一.Http网络请求响应基本知识
简介

从客户端到服务器端的请求消息及响应,包括在消息首行中,对资源的请求方法、资源的标识符及使用的协议。

Http进行请求和响应,即一次消息处理基本的流程:


http请求

其中基本分析使用如下:


分析
要的请求方式

<b>GET</b>

通过请求URI得到资源

<b>POST</b>

上传数据到服务器来获取资源

<b>消息头</b>

主要分为请求头和响应头

<b>请求头</b>

一般请求头信息不进行添加,如果有要求,再进行添加。

<b>Accept - Charset:</b>浏览器可接受的字符集。

<b>Accept - Encoding:</b>浏览器能够进行解码的数据编码方式

<b>Accept - Language:</b>浏览器所希望的语言种类,当服务器能够提供一种以上的语言版本时要用到。

<b>Authorization:</b>授权信息,通常出现在对服务器发送的WWW - Authenticate头的应答中。

<b>Connection:</b>表示是否需要持久连接。

<b>Content - Length:</b>表示请求消息正文的长度。

<b>响应头</b>

拿到请求头信息,可以完成一些设置,比如

<b>setContentLength:</b>设置Content-Length头信息。

<b>消息体</b>

消息体重要的有两种:请求体(RequestBody),响应体(ResponseBody)

<b>请求体</b>

可以为空,一般在进行POST请求时会传递请求体,将请求体的数据上传到服务器去获取数据

<b>响应体</b>

当请求得到响应时,返回的响应中拿到响应体,来进行数据的取出和数据展示

<b>响应码</b>

HTTP应答码也称为状态码,它反映了Web服务器处理HTTP请求状态。HTTP应答码由3位数字构成,其中首位数字定义了应答码的类型:

<b>1XX-信息类(Information)</b>,表示收到Web浏览器请求,正在进一步的处理中
<b>2XX-成功类(Successful)</b>,表示用户请求被正确接收,理解和处理例如:200 OK
<b>3XX-重定向类(Redirection)</b>,表示请求没有成功,客户必须采取进一步的动作。
<b>4XX-客户端错误(Client Error)</b>,表示客户端提交的请求有错误 例如:404 NOT Found,意味着请求中所引用的文档不存在。
<b>5XX-服务器错误(Server Error)</b>表示服务器不能完成对请求的处理:如 500

<b>重定向</b>

客户端发送http请求——>服务器接受后发送302状态码响应及对应新的location给客户浏览器——>客户浏览器发现是302响应,则自动再发送一个新的http请求,请求url是新的location地址——>服务器根据此请求寻找资源并发送给客户。

二.OkHttp的使用

简介

OkHttp是Square出的Http通讯库,支持HTTP和HTTP/2,用于Android应用和Java应用。

OkHttp是非常优秀的Http通讯库,将Http连接中各种繁杂的问题,对并发的支持,对常见异常的处理等封装在底层,提供简单易用的API供应用中调用。与之相比,HttpUrlConnection的使用过于复杂,Appache的HttpClient在Android平台上的运行又有各种问题,在Android 6.0之后,已经将HttpClient库从SDK中删除,全面转向使用OkHttp。

目前有很多知名的Android三方框架都使用OkHttp作为网络连接的默认基栈,例如Volley,Glide,Retrofit等,从中也能看出学习OkHttp的必要性。

基本使用

<b>在项目中添加对OkHttp的依赖</b>

在需要使用OkHttp的模块的build.gradle文件中,添加如下依赖:(版本号可能变更)

compile 'com.squareup.okhttp3:okhttp:3.2.0'

<b> 初始化</b>

OkHttp框架的核心类是OkHttpClient,此类可直接实例化。由于OkHttpClient内部处理了并发,多线程和Socket重用等问题,为了节省资源,整个应用中使用一个OkHttpClient对象即可,可以对它做Singleton封装。

OkHttpClient okHttpClient = new OkHttpClient();

<b>OkHttp请求的构建</b>

代表Http请求的类是Request,该类使用构造器模式,最简单的构造GET请求如下:

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

要构造Post请求,在构建Request时增加请求体即可:

Request request = new Request.Builder()
.url(url)
.post(RequestBody)
.build();

RequestBody formBody = new FormEncodingBuilder()
.add("name", "Cuber")
.add("age", "26")
.build();

<b>OkHttp请求的发送</b>

请求的发送有两种形式,一种是直接同步执行,阻塞调用线程,直接返回结果;另一种是通过队列异步执行,不阻塞调用线程,通过回调方法返回结果。如下所示:

<b>同步执行:</b>

// 如果返回null,代表超时或没有网络连接
Response response = client.newCall(request).execute();

<b>异步回调:</b>

Response response = client.newCall(request).enqueue(new Callback() {

@Override
public void onFailure(Request request, IOException e) {
    //超时或没有网络连接
    //注意:这里是后台线程!
}

@Override
    public void onResponse(Response response) throws IOException {
    //成功
    //注意:这里是后台线程!
}
});

以上这些就是快速上手OkHttp需要知道的全部内容,可以从中看出,它的API非常简单易用。

Call模型

Http客户端的任务是处理请求和响应,这说起来简单,但实际过程很复杂。

<b>请求:</b>Http请求包含一个URL,请求方法(例如GET或者POST),请求头。还可能包含请求体,可以是数据流也可以是指定的内容类别。
<b>响应:</b>用一个响应码来回应请求(例如200代表成功,404代表页面未找到),响应头和响应体。

<b>请求的重写</b>

为了保证正确性和传输效率,OkHttp会在发送你的请求之前重写它,例如:
OkHttp可能会添加原始请求中缺失的头信息,包括Content-Length, Transfer-Encoding, User-Agent, Host, Connection, 和 Content-Type。
为了实现透明的响应压缩(transparent response compression),OkHttp会增加Accept-Encoding头信息。
如果你收到了cookie,OkHttp会增加Cookie头信息。
某些请求可能会对响应做缓存。如果被缓存的响应不是最新的,OkHttp能做一个有条件的GET请求来下载更新后的响应。此功能需要添加If-Modified-Since和If-None-Match等头信息。

<b>响应的重写</b>

如果使用了透明压缩,OkHttp会去掉对应响应的Content-Encoding和Content-Length头信息,因为它们不能应用于解压后的响应体。

如果有条件的GET成功了,网络侧的响应和缓存的响应会被自动合并。

<b>重定向</b>

如果你请求的URL被移动了,服务器会返回类似于302这样的响应码,来指明新的URL。OkHttp能跟随新的URL,获取到最终的响应。

<b>请求的重试</b>

有时会发生连接失败:可能网络连接状况不好,或者服务器不可达。OkHttp会自动使用不同的路由来重试请求。

<b>Call模型</b>

由于以上的重写,重定向和重试等操作,你的一个简单请求可能会产生多个请求和响应。OkHttp使用Call这一概念对此来建模:不论为了满足你的请求任务,中间做了多少次请求和响应,都算作一个Call。

<b>Call有两种方式来执行:</b>

<b>同步方式:</b>你的线程会被阻塞,知道响应可读。
<b>异步方式:</b>你在任意线程将请求排队,当响应可读时,会在另一个线程拿到回调。

<b>Call的取消</b>

使用Call.cancel()来停止一个执行中的请求。如果线程正在写请求或读响应,则会收到IOException。使用此方法,在一个Call已经不需要时取消它,可以节省网络流量

Call可以在任意线程取消,如果请求没有完成,调用取消方法会导致请求失败,读写请求体和响应体的代码会产生IOException。

拦截器

OkHttp在请求响应过程中可以添加拦截器,拦截请求和响应的数据等。

需要加依赖

compile 'com.squareup.okhttp3:logging-interceptor:3.4.1'

<b>用法</b>

初始化拦截器,设置拦截级别,添加到OkHttpClient中

HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor();
interceptor.setLevel(HttpLoggingInterceptor.Level.BODY);

okHttpClient = new OkHttpClient.Builder()
        .addInterceptor(interceptor)
        .build();
响应体解析-使用Gson

添加依赖

compile 'com.google.code.gson:gson:2.8.0'

以下代码使用Gson库来解析服务器响应的JSON信息

FAQ

OkHttp如何设置超时?

设置超时的方法很简单:

OkHttpClient client = new OkHttpClient.Builder()
    .connectTimeout(10, TimeUnit.SECONDS)  // 连接超时
    .writeTimeout(10, TimeUnit.SECONDS)    // Socket写超时
    .readTimeout(30, TimeUnit.SECONDS)     // Socket读超时
    .build();

注意readTimeout和writeTimeout被用于OkHttp内部的Connection类,用在setSoTimeout方法上来设置Socket。

另外,在2.5.0版本之后,读、写、连接超时的默认值是10s。

OkHttp中,Callback的回调方法onFailure和onResponse是在主线程执行码?

不是,OkHttp是一个Java库,不是Android库,它对Android主线程一无所知,所以这两个回调方法自然是在后台线程执行。实际开发中,常常对OkHttp做二次封装,来直接将结果传递给主线程。

也可以实现Callback类,自己做一个抽象类UICallback,从而可以在UI中运行

public abstract class UICallback implements Callback{

    private final Handler handler = new Handler(Looper.getMainLooper());

    @Override
    public void onFailure(final Call call, final IOException e) {
        handler.post(new Runnable() {
            @Override
            public void run() {
                onFailureInUi(call, e);
            }
        });
    }

    @Override
    public void onResponse(final Call call, final Response response)  {

        try {
            if (!response.isSuccessful()) {
                throw new IOException("error code: " + response.code());
            }

            final String content = response.body().string();
            handler.post(new Runnable() {
                @Override
                public void run() {
                    onResponseInUi(call, content);
                }    
            }) ;
        } catch (IOException e) {
            onFailure(call, e);
        }
    }

    public abstract void onFailureInUi(Call call, IOException e);

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

推荐阅读更多精彩内容