版权声明:本文为 newtrekWang 原创文章,可以随意转载,但必须在明确位置注明出处!!!

参考okhttp官方wiki

https://github.com/square/okhttp/wiki/Calls

okhttp3的设计思路

API部分简介

OkHttpClient.Builder:OkHttpClient可通过Builder采用建造者模式构建,通过Builder可以方便灵活的设置通用参数
- public Builder connectTimeout(long timeout, TimeUnit unit) 为连接设置超时时间
- public Builder readTimeout(long timeout, TimeUnit unit) 设置默认读时间
- public Builder writeTimeout(long timeout, TimeUnit unit) 设置默认写时间
- public Builder proxy(Proxy proxy) 设置代理
- public Builder proxySelector(ProxySelector proxySelector)
- public Builder cookieJar(CookieJar cookieJar) 设置处理cookies的处理者(Sets the handler that can accept cookies from incoming HTTP responses and provides cookies to outgoing HTTP requests)
- void setInternalCache(InternalCache internalCache) 设置内部缓存
- public Builder cache(Cache cache) 设置缓存
- public Builder dns(Dns dns) 设置DNS 服务
- public Builder socketFactory(SocketFactory socketFactory)
- public Builder sslSocketFactory(SSLSocketFactory sslSocketFactory) 配置证书用的
- public Builder sslSocketFactory( SSLSocketFactory sslSocketFactory, X509TrustManager trustManager) 配置证书用的
- public Builder hostnameVerifier(HostnameVerifier hostnameVerifier) Sets the verifier used to confirm that response certificates apply to requested hostnames for HTTPS connections. 应该也是是配置https的
- public Builder certificatePinner(CertificatePinner certificatePinner) 不太懂,没用过
- public Builder authenticator(Authenticator authenticator) Sets the authenticator used to respond to challenges from origin servers.
- public Builder proxyAuthenticator(Authenticator proxyAuthenticator) Sets the authenticator used to respond to challenges from proxy servers.
- public Builder connectionPool(ConnectionPool connectionPool) Sets the connection pool used to recycle HTTP and HTTPS connections. 设置连接池
- public Builder followSslRedirects(boolean followProtocolRedirects) Configure this client to follow redirects from HTTPS to HTTP and from HTTP to HTTPS.不懂
- public Builder followRedirects(boolean followRedirects) Configure this client to follow redirects. If unset, redirects be followed. 不懂
- public Builder retryOnConnectionFailure(boolean retryOnConnectionFailure) 连接失败是否重连
- public Builder dispatcher(Dispatcher dispatcher) Sets the dispatcher used to set policy and execute asynchronous requests. Must not be null.
- public Builder protocols(List protocols) 设置协议
- public Builder connectionSpecs(List connectionSpecs) 不懂
- public List interceptors() 应该是获取拦截器列表
- public Builder addInterceptor(Interceptor interceptor) 添加拦截器
- public List networkInterceptors() 返回网络拦截器
- public Builder addNetworkInterceptor(Interceptor interceptor) 添加网络拦截器
- public OkHttpClient build() 构建OkHttpClient,并为它设置参数

由上面的设计图可知,OkhttpClient是核心,他就像一个浏览器一样,什么工作,比如请求,接受响应都是由它做的,关键就是怎么给他配置http协议的那些配置了,因为配置太多,所以用了Builder帮助配置

翻翻Builder的源码可以知道,即时你没有配置啥参数,Builder也为你默认设置一些参数,比如他默认设置支持 Protocol.HTTP_2, Protocol.SPDY_3, Protocol.HTTP_1_1这三种协议,默认连接,读写超时都是10s,DNS用系统的,默认失败重连。。。。

创建OkhttpHelper

因为只要有请求就必须有okhttpclient参与,一般项目是分模块的,每个模块基本都有网络请求,总不能每个请求都要构造一个okhttpclient去请求吧,所以okhttpclient设计为单例,不用new ,到处都可以用它,方便快捷,代码得到了复用,也节省了内存开销

这里采用内部静态类实现单例

有Http协议,每个连接必有请求头,是供服务端或客户端读取的,这里Okhttp封装了请求,并且也为它提供builder类,再翻翻看

这些是默认的参数

  • public Builder url(HttpUrl url) 设置请求的URl,这个方法相当于浏览器上的地址输入框
  • public Builder url(String url) 重载方法
  • public Builder url(URL url) 也是重载,所以这里有三种url的表达格式
  • public Builder header(String name, String value) 这里是更新header字段的,就是设置键值对,里面的header应该用了个Map来记录的,我还在看
  • public Builder addHeader(String name, String value) 添加header字段
  • public Builder removeHeader(String name) 删除header字段
  • public Builder headers(Headers headers) 看吧,这里直接设置Headers,headers肯定是把所有的字段都包起来了
  • public Builder cacheControl(CacheControl cacheControl) 设置缓存控制,它其实也只设置header字段,不信看它的内部实现

  • public Builder method(String method, RequestBody body) 设置请求的方法和请求体,为什么先说这个呢?
  • public Builder get() 设置请求方法

其实它的具体实现是调用method()方法

怎么使用?

HTTP客户端的工作是接受您的请求并产生响应。这在理论上很简单,但在实践中变得棘手。

Requests 请求

每个HTTP请求包含一个URL,一个请求方法(像GET,POST),和一个头部列表,请求也包含一个body:特殊内容类型的数据流,比如文件,json数据...

Responses 响应

响应使用代码(如200获得成功或404找不到)来应答请求,标题及其自己的可选正文。

重写请求

当你提供给OKhttp一个HTTP请求,他就会按你定义的请求去执行,重写请求上面已给出了源码,直接用builder去set就是,可见okhttp支持很多header,如Content-Length, Transfer-Encoding, User-Agent, Host, Connection, and Content-Type

重写响应

响应是okhttp制造的,我们只是处理响应就行了。

后续请求

当您请求的URL已经移动时,网络服务器将返回一个302类型的响应代码,以指示该文档的新URL。 OkHttp将遵循重定向来检索最终的响应。

重试请求

有时连接失败:池连接过时并断开连接,或者无法访问Web服务器本身。 OkHttp将使用不同的路由重试该请求(如果有)。

Calls 呼叫

通过重写,重定向,后续跟踪和重试,您的简单请求可能会产生许多请求和响应,OkHttp使用Call来建立满足您的请求的任务,但是需要许多中间请求和响应。
有两种执行呼叫的方式
- Synchronous 同步:你的线程被阻塞,直到响应可读。
- Asynchronous 异步:您在任何线程上排队请求,并在响应可读时在另一个线程获取回调
呼叫可以在任何线程被取消,如果呼叫尚未完成,这将呼叫失败!编写请求正文或读取响应主体的代码在其呼叫被取消时将抛出IOException。

Dispatch

对于同步调用,您可以自己创建线程,并负责管理同时发出的请求数。同时连接太多浪费资源;太少的危害延迟。在安卓开发显然不能阻塞主线程,得在另一个线程执行。

对于异步调用,Dispatcher实现最大同时请求的策略。您可以设置每个网络服务器的最大值(默认值为5),总体(默认值为64)。

连接

1.它使用URL并配置了OkHttpClient来创建一个地址。该地址指定我们如何连接到Web服务器。
2.它尝试从连接池检索与该地址的连接.
3.如果在池中没有找到连接,则会选择尝试的路由。这通常意味着进行DNS请求以获取服务器的IP地址。然后,如果需要,可以选择TLS版本和代理服务器。
4.如果它是一个新路由,它通过构建直接套接字连接,TLS隧道(通过HTTP代理的HTTPS)或直接TLS连接进行连接。它需要TLS握手。
5.它发送HTTP请求并读取响应

如果连接有问题,OkHttp将选择另一个路由,然后重试。这允许OkHttp在服务器地址的子集不可达时恢复。

在接收到响应后,连接将返回到池中,以便将来可以重用该请求。连接在一段时间不活动之后从游泳池逐出。

使用实例

由于多处都会使用okhttpClient,所以我把它封装在一个单例类里,便于随处获取

同步请求 GET

结果:
title
title

异步请求 GET

访问HTTP标头

通常,HTTP标头的工作方式与Map <String,String>类似,但是有些标题允许多个值,如Guava的Multimap。
当写请求头时,使用头(名称,值)来设置名称唯一出现的值。
如果存在现有值,则在添加新值之前将删除它们。使用addHeader(name,value)来添加标题,而不会删除已经存在的标题。

post a String

使用HTTP POST将请求体发送到服务

post Streaming

post a file

直接 .post(RequestBody.create(MEDIA_TYPE_MARKDOWN, file)),file是File类型

post form parameters (post表单)

RequestBody formBody = new FormBody.Builder()
.add("search", "Jurassic Park")
.build();

Posting a multipart request

MultipartBody.Builder可以构建与HTML文件上传表单兼容的复杂请求体。多部分请求体的每个部分本身就是一个请求体,并且可以定义自己的头。如果存在,这些标题应该描述零件体,例如它的Content-Disposition。如果Content-Length和Content-Type标题可用,则会自动添加。

用Gson解析json响应

响应缓存

要缓存响应,您需要一个可以读取和写入的缓存目录,并对缓存的大小有限制。缓存目录应该是私有的,不受信任的应用程序不能读取其内容!

响应缓存使用HTTP头进行所有配置,你可以添加请求头,如Cache-Control:max-stale = 3600,OkHttp的缓存将遵守它们。您的网络服务器使用自己的响应头配置响应缓存的时间长短像Cache-Control:max-age = 9600。有缓存标头强制缓存的响应,强制网络响应,或强制使用条件GET验证网络响应

title
title
可以验证到我的E://java/目录里多了四个文件,其实他们就是缓存文件

cancel Call

每次client.newCall()的时候会返回一个Call,所以取消的话就调用call.cancel()就行,如果请求任务未完成,会抛出IO异常

Timeout

处理身份验证authentication

OkHttp可以自动重试未经身份验证的请求。当答复为401未授权时,将要求身份验证者提供凭证。实现应该构建一个包含缺少凭据的新请求。如果没有凭据可用,返回null以跳过重试。使用Response.challenges()来获取任何认证挑战的方案和领域。在履行基本挑战时,请使用Credentials.basic(用户名,密码)对请求标头进行编码。

Hits: 14

分类: Android

发表评论

电子邮件地址不会被公开。 必填项已用*标注