Android OkHttp使用教程

Android系统提供了两种HTTP通信类，HttpURLConnection和HttpClient。

关于HttpURLConnection和HttpClient的选择>>官方博客

尽管Google在大部分安卓版本中推荐使用HttpURLConnection，但是这个类相比HttpClient实在是太难用，太弱爆了。

OkHttp是一个相对成熟的解决方案，据说Android4.4的源码中可以看到HttpURLConnection已经替换成OkHttp实现了。所以我们更有理由相信OkHttp的强大。

OkHttp 处理了很多网络疑难杂症：会从很多常用的连接问题中自动恢复。如果您的服务器配置了多个IP地址，当第一个IP连接失败的时候，OkHttp会自动尝试下一个IP。OkHttp还处理了代理服务器问题和SSL握手失败问题。

使用 OkHttp 无需重写您程序中的网络代码。OkHttp实现了几乎和java.net.HttpURLConnection一样的API。如果你用了 Apache HttpClient，则OkHttp也提供了一个对应的okhttp-apache 模块。

注：在国内使用OkHttp会因为这个问题导致部分酷派手机用户无法联网，所以对于大众app来说，需要等待这个bug修复后再使用。或者尝试使用OkHttp的老版本。
截止到目前，OkHttp一直没有修复，并把修复计划延迟到了OkHttp2.3中。不是所有设备都能重现，仅少量设备会出现这个问题。（如果问题这么明显，OkHttp早就修复了）

入门

官方资料

官方介绍
github源码

使用范围

OkHttp支持Android 2.3及其以上版本。
对于Java, JDK1.7以上。

jar包准备

官方介绍页面有链接位置。这里把下载链接也写在下面。
OkHttp
Okio

基本使用

HTTP GET

1 2 3 4 5 6 7 8

OkHttpClient client =  new  OkHttpClient();   String run(String url) throws IOException {      Request request =  new  Request.Builder().url(url).build();      Response response = client.newCall(request).execute();     if  (response.isSuccessful()) {         return  response.body().string();      }  else  {         throw  new  IOException( "Unexpected code "  + response);      } }

Request是OkHttp中访问的请求，Builder是辅助类。Response即OkHttp中的响应。

Response类：

1 2 3

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

response.body()返回ResponseBody类

可以方便的获取string

1 2 3 4

public final String string() throws IOException Returns the response as a string decoded  with  the charset of the Content-Type header. If that header is either absent or lacks a charset,   this  will attempt to decode the response body as UTF-8.Throws: IOException

当然也能获取到流的形式：

1	public final InputStream byteStream()

HTTP POST

POST提交Json数据

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

public static final MediaType JSON = MediaType.parse( "application/json; charset=utf-8" ); OkHttpClient client =  new  OkHttpClient(); String post(String url, String json) throws IOException {       RequestBody body = RequestBody.create(JSON, json);        Request request =  new  Request.Builder()        .url(url)        .post(body)        .build();        Response response = client.newCall(request).execute();      f (response.isSuccessful()) {          return  response.body().string();      }  else  {          throw  new  IOException( "Unexpected code "  + response);      } }

使用Request的post方法来提交请求体RequestBody

POST提交键值对

很多时候我们会需要通过POST方式把键值对数据传送到服务器。 OkHttp提供了很方便的方式来做这件事情。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21

OkHttpClient client =  new  OkHttpClient(); String post(String url, String json) throws IOException {         RequestBody formBody =  new  FormEncodingBuilder()      .add( "platform" ,  "android" )      .add( "name" ,  "bug" )      .add( "subject" ,  "XXXXXXXXXXXXXXX" )      .build();          Request request =  new  Request.Builder()        .url(url)        .post(body)        .build();          Response response = client.newCall(request).execute();      if  (response.isSuccessful()) {          return  response.body().string();      }  else  {          throw  new  IOException( "Unexpected code "  + response);      } }

总结

通过上面的例子我们可以发现，OkHttp在很多时候使用都是很方便的，而且很多代码也有重复，因此特地整理了下面的工具类。
注意：

• OkHttp官方文档并不建议我们创建多个OkHttpClient，因此全局使用一个。 如果有需要，可以使用clone方法，再进行自定义。这点在后面的高级教程里会提到。
  

• enqueue为OkHttp提供的异步方法，入门教程中并没有提到，后面的高级教程里会有解释。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90

import java.io.IOException; import java.util.List; import java.util.concurrent.TimeUnit; import org.apache.http.client.utils.URLEncodedUtils; import org.apache.http.message.BasicNameValuePair; import cn.wiz.sdk.constant.WizConstant; import com.squareup.okhttp.Callback; import com.squareup.okhttp.OkHttpClient; import com.squareup.okhttp.Request; import com.squareup.okhttp.Response;     public class OkHttpUtil {      private static final OkHttpClient mOkHttpClient =  new  OkHttpClient();      static{          mOkHttpClient.setConnectTimeout(30, TimeUnit.SECONDS);      }      /**       * 该不会开启异步线程。       * @param request