欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

OkHttp的使用

程序员文章站 2024-03-25 11:37:16
...

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

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

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

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

其中基本分析使用如下:
OkHttp的使用

要的请求方式

GET

通过请求URI得到资源

POST

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

消息头

主要分为请求头和响应头

请求头

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

Accept - Charset:浏览器可接受的字符集。

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

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

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

Connection:表示是否需要持久连接。

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

响应头

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

setContentLength:设置Content-Length头信息。

消息体

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

请求体

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

响应体

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

响应码

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

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

重定向

客户端发送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的必要性。

基本使用

在项目中添加对OkHttp的依赖

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

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

初始化

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

OkHttpClient okHttpClient = new OkHttpClient();

OkHttp请求的构建

代表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();

OkHttp请求的发送

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

同步执行:

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

异步回调:

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客户端的任务是处理请求和响应,这说起来简单,但实际过程很复杂。

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

请求的重写

为了保证正确性和传输效率,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等头信息。

响应的重写

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

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

重定向

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

请求的重试

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

Call模型

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

Call有两种方式来执行:

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

Call的取消

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

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

拦截器

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

需要加依赖

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

用法

初始化拦截器,设置拦截级别,添加到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);
}

关注微信公众号获取更多相关资源

OkHttp的使用