Okhttp最火的网络请求框架

Okhttp作为现在最火的一个网络请求框架，已经有无数牛人给出了工具类等等。

例如：
鸿洋大神的 Android 一个改善的okHttp封装库 和 Android OkHttp完全解析 是时候来了解OkHttp了 以及 Android Https相关完全解析 当OkHttp遇到Https

还有凯子哥的 开源项目OkHttpPlus——支持GET、POST、UI线程回调、JSON格式解析、链式调用、文件上传下

有别人写好的工具类固然好，但是不光用要会用，还要止其所以然。

那么直接取拉官方的代码，研究如何使用以及阅读API说明，对加深理解OkHttp和了解基础，就更有帮助了。

正文

OkHttp现在已经升级到3.0版本了，API较2.0还是有些不同的。稍后再说。

下面将通过一个一个的测试用例来说明和解释API的用法，当然这些用力都是我照着example敲的，研究的过程中自然有了些了解，便记录下来。

创建完工程，引入了包，别忘记创建Client实例。

OkHttpClient yOkHttpClient = new  OkHttpClient();

那么，OkHttpClient是干嘛用的呢？
简单来说，通过OkHttpClient可以发送一个Http请求，并读取该Http请求的响应，它是一个生产Call的工厂。
此外，受益于一个共享的响应缓存/线程池/复用的连接等因素，绝大多数应用使用一个OkHttpClient实例，便可以满足整个应用的Http请求。
创建一个默认配置OkHttpClient，可以使用默认的构造函数。或者通过new OkHttpClient.Builder()方法来一步一步配置一个OkHttpClient实例。另外，如果要求使用现有的实例，可以通过newBuilder()方法来进行构造。

下面就是一个构造OkHttpClient实例的简单例子。

OkHttpClient client = ... OkHttpClient clientWith30sTimeout = client.newBuilder().readTimeout( 30 , TimeUnit.SECONDS) .build(); Response response =client.With30sTimeout.newCall(request).execute();

看一下OkHttpClient的源码，会发现缓存/代理等等需求，一应俱全的按照类封装到了Builder中。

Dispatcher dispatcher; // 分发Proxy proxy;// 代理List<Protocol> protocols; List<ConnectionSpec> connectionSpecs; List<Interceptor> interceptors = new ArrayList<>(); // 拦截器final  List<Interceptor> networkInterceptors = new  ArrayList<>(); // 网络拦截器 ProxySelector proxySelector; CookieJar cookieJar; Cache cache; // 缓存InternalCache internalCache;SocketFactory socketFactory; HostnameVerifier hostnameVerifier; CertificatePinner certificatePinner; Authenticator proxyAuthenticator; // 代理证书Authenticator authenticator; // 证书ConnectionPool connectionPool; Dns dns; // DNSboolean  followSslRedirects; boolean  followRedirects; boolean  retryOnConnectionFailure; int  connectTimeout; int  readTimeout;int  writeTimeout;

简单Get请求

代码：

@Testpublic void testGet ()  throws  IOException { Request build =  new Request.Builder() .url( "https://raw.github.com/square/okhttp/master/README.md" ) .build(); Response response = yOkHttpClient.newCall(build) .execute(); System.out.println(response); }

结果：
在结果中打印了协议，结果码，消息结果，访问的url地址等等。

Response{protocol=http/1.1200 , message=OK, url=https://raw.githubusercontent.com/square/okhttp/master/README.md}

简单看一下Request类，可以发现它代表一个Http请求，需要注意的是Request一旦build()之后，便不可修改。

Request的实例，主要通过new Request.Builder()来一步一步构造的。看一下Builder的代码。

public Builder () {this.method = "GET"new Headers.Builder(); }

默认是Get方法，此外还创建了头信息。值得注意的是Headers类中是通过List namesAndValues = new ArrayList<>(20)，来存放头信息的，一开始我也很纳闷，头信息都是一对一对的为什么要用List，看一下源码发现，在存取的时候都是将索引+2或者-2。并且头信息可以存在多个相同的Key信息。

继续看一下如何发起请求的。

yOkHttpClient.newCall(request)

跟到newCall()方法中发现，又使用OkHttpClient实例和Request的实例，一起构造了一个RealCall的实例。在跟进RealCall代码中，可以简单了解到RealCall类简单做了一个托管并通过Dispather类对请求进行分发和执行，实际开启线程发起请求的方法就在这个类中。

随后又调用execute()方法，拿到了一个响应。这个execute()方法，实际上执行的就是RealCall中的execute()方法，那么最后就调用了Dispatcher的execute()方法。

最后，再看一下Response类的说明，Response代表一个Http的响应，这个类的实例不可修改。

致次，一个简单的Get请求和说明就结束了，简单跟入源码的原因在于，更清楚的了解OkHttpClient的Api和运行原理。

简单Post请求

提起post请求，必然是有请求体的。

代码：

String bowlingJson(String player1, String player2) { return"{'winCondition':'HIGH_SCORE','name':'Bowling','lastSaved':1367702411696,'dateStarted':1367702378785,'players':[{'name':' + player1 + ','history':[10,8,6,7,8],'color':-13388315,'total':39},{'name':'+ player2 +','history':[6,10,5,10,10],'color':-48060,'total':41}"@Testpublic void testPost () throws  IOException { MediaType JSON = MediaType.parse(RequestBody body = RequestBody.create(JSON, bowlingJson("Jesse", "Jake")); Request request = new  Request.Builder() .url("http://www.roundsapp.com/post" ) .post(body) .build(); Response response = yOkHttpClient.newCall(request).execute(); System.out.println(response.body().string()); }

此处先给一个Http请求头大全的地址，非常好的。

MediaType用于描述Http请求和响应体的内容类型。对于Http请求头不了解的人，请看下面的图（PS：我也不太懂）。

图是在这篇文章上找到的Android网络请求心路历程

很明了吧，MediaType代表的就是请求包体内容的类型。

例如，MediaType.parse(“application/json; charset=utf-8”);这个就带表请求体的类型为JSON格式的。

定义好数据类型，还要将其变为请求体，最后通过post()方法，随请求一并发出。

RequestBody body = RequestBody.create(JSON, bowlingJson("Jesse""Jake"));

为请求指定头信息

代码：

@Testpublic void testAccessHeaders ()  throws</span> Exception { Request request =new Request.Builder() .url("https://api.github.com/repos/square/okhttp/issues") // User-Agent User-Agent的内容包含发出请求的用户信息 User-Agent: Mozilla/5.0 (Linux; X11).header("User-Agent","OkHttp Headers.java" ) // Accept 指定客户端能够接收的内容类型 Accept: text/plain, text/html.addHeader("Accept""application/json; q=0.5") .addHeader("Accept","application/vnd.github.v3+json") .build(); Response response = yOkHttpClient.newCall(request).execute(); if (response.isSuccessful()) { System.out.println("Server: "+ response.header("Server")); System.out.println("Date: "+ response.header("Date")); System.out.println("Vary: " + response.headers("Vary")); } }

响应结果：

Server : GitHub.comDate : Thu, 28 Jan 2016 15:41:13 GMTVary: [Accept, Accept-Encoding]

这个例子主要是Http请求头信息的一个展示。
对于header(String name, String value)方法，使用name和value设置一个头信息，如果请求中已经存在响应的信息那么直接替换掉。

而addHeader(String name, String value)，如果请求头中已经存在name的name-value，那么还会继续添加，请求头中便会存在多个name相同而value不同的“键值对”。

至于name的取值说明，可以查看这个请求头大全。

异步Get请求

代码如下：

@Testpublic void testAsyncGet () { final  Request request = new  Request.Builder().url("http://publicobject.com/helloworld.txt").build(); System.out.println(request); yOkHttpClient.newCall(request).enqueue(new Callback() { @Overridepublic void onFailure (Call call, IOException e) {e.printStackTrace(); }@Overridepublic void onResponse (Call call, Response response)  throws IOException { System.out.println(call = "[" + call + "]", response =" [" + response + "]" ); if  (!response.isSuccessful()) { throw new  IOException("" + response); } Headers headers = response.headers(); for  ( int  i =  0 ; i < headers.size(); i++) { System.out.println(headers.name(i) + ": "+ headers.value(i)); } System.out.println(response.body().string()); } }); }

与同步方法不同，调用的是enqueue()方法，其实际上调用的就是RealCall中的enqueue()方法，那么实际上就是Dispatcher的enqueue()方法。

synchronized void  enqueue(AsyncCall call) { if  (runningAsyncCalls.size() < maxRequests && runningCallsForHost(call) < maxRequestsPerHost) { runningAsyncCalls.add(call); executorService().execute(call); } else { readyAsyncCalls.add(call); } }

添加授权证书

代码如下：