okhttp使用总结

一.框架优点介绍

---

Calls

1.框架重写请求

当您向okhttp提供一个请求时，为了正确性和效率，okhttp将重写您的请求。
okhttp可能从原始请求添加头文件，包括内容长度，传输编码、代理、内容类型等。如果有cookie将添加一个cookie头。
有些请求会有缓存响应，如果已过期，okhttp可以执行条件更新响应。

2.跟踪请求

当您请求的URL已移动是，web服务器将返回类似302以指示文档的新URL的相应代码。okhttp将遵循重定向检索最终响应。

3.重试请求

如果有不同路线，okhttp将请求不同的路线。

4.Call被执行的两种方法

1.同步：你的线程会阻止，直到响应返回
2.异步：你对请求可以进行排队，并且响应回来对另一线程进行调用。Call可以从任何线程被取消。如果未完成将会失败会抛出io异常。

Connections

虽然你只提供了URL，但okhttp计划连接你的服务器使用三种类型：URL、地址、路线。

1.URL

2.地址

3.路线

4.Connections

当您请求一个 URL 的 OkHttp 时，这里做了些什么:
1.它使用 URL 和配置 OkHttpClient 来创建一个地址。此地址指定如何我们会连接到 web 服务器。
2.它尝试检索与该地址的连接，从连接池中。
3.如果它不在池中查找连接，它选择一条路线尝试。这通常意味着制作一个 DNS 请求以获取服务器的 IP 地址。如有必要，它然后选择 TLS 版本和代理服务器。
4.如果它是一个新的路线，它连接通过建立一个直接套接字连接，TLS 隧道 (为 HTTPS 通过 HTTP 代理服务器) 或直接的 TLS 连接。它作为必要的 TLS 握手。
5.它会发送 HTTP 请求，并读取响应。
6.如果有连接问题，OkHttp 会选择另一条路线，然后再试。这允许 OkHttp 恢复时的服务器地址的子集是遥不可及。它也是有用的当连接池是陈旧或未遂的 TLS 版本不受支持。
7.一旦收到了响应，连接将返回池，所以它可以重用一个未来的请求。连接被逐出池后的非活动时间。

二.原生态使用方法

---

同步获取（Synchronous Get）

下载文件，打印头文件，并以字符串形式打印其响应体。

响应体string()方法对小文件，方便快捷。但如果响应体大（大于1 MIB），避免string()因为它会加载整个文件到内存中。在这种情况下，更倾向于将身体作为一个流来处理。

private final OkHttpClient client = new OkHttpClient();

  public void run() throws Exception {
    Request request = new Request.Builder()
        .url("http://publicobject.com/helloworld.txt")
        .build();

    Response response = client.newCall(request).execute();
    if (!response.isSuccessful()) throw new IOException("Unexpected code " + response);

    Headers responseHeaders = response.headers();
    for (int i = 0; i < responseHeaders.size(); i++) {
      System.out.println(responseHeaders.name(i) + ": " + responseHeaders.value(i));
    }

    System.out.println(response.body().string());
  }

异步获取

在一个工作线程上下载文件，并在响应时调用返回。该回调是在响应头准备好后进行的。读取响应体可块。okhttp目前不提供异步API部分接收响应体。

  private final OkHttpClient client = new OkHttpClient();

  public void run() throws Exception {
    Request request = new Request.Builder()
        .url("http://publicobject.com/helloworld.txt")
        .build();

    client.newCall(request).enqueue(new Callback() {
      @Override public void onFailure(Request request, IOException throwable) {
        throwable.printStackTrace();
      }

      @Override public void onResponse(Response response) throws IOException {
        if (!response.isSuccessful()) throw new IOException("Unexpected code " + response);

        Headers responseHeaders = response.headers();
        for (int i = 0; i < responseHeaders.size(); i++) {
          System.out.println(responseHeaders.name(i) + ": " + responseHeaders.value(i));
        }

        System.out.println(response.body().string());
      }
    });
  }

取消Calls

使用Call.cancel()立即停止正在进行的请求。如果一个线程正在写请求或阅读的反应，它会收到IOException。用这个来保护网络的电话时，不再是必要的；例如当用户导航离开应用程序。同步和异步调用都可以取消。

private final ScheduledExecutorService executor = Executors.newScheduledThreadPool(1);
  private final OkHttpClient client = new OkHttpClient();

  public void run() throws Exception {
    Request request = new Request.Builder()
        .url("http://httpbin.org/delay/2") // This URL is served with a 2 second delay.
        .build();

    final long startNanos = System.nanoTime();
    final Call call = client.newCall(request);

    // Schedule a job to cancel the call in 1 second.
    executor.schedule(new Runnable() {
      @Override public void run() {
        System.out.printf("%.2f Canceling call.%n", (System.nanoTime() - startNanos) / 1e9f);
        call.cancel();
        System.out.printf("%.2f Canceled call.%n", (System.nanoTime() - startNanos) / 1e9f);
      }
    }, 1, TimeUnit.SECONDS);

    try {
      System.out.printf("%.2f Executing call.%n", (System.nanoTime() - startNanos) / 1e9f);
      Response response = call.execute();
      System.out.printf("%.2f Call was expected to fail, but completed: %s%n",
          (System.nanoTime() - startNanos) / 1e9f, response);
    } catch (IOException e) {
      System.out.printf("%.2f Call failed as expected: %s%n",
          (System.nanoTime() - startNanos) / 1e9f, e);
    }
  }

由于篇幅原因在此不再详述，有兴趣请参考wiki

三.封装后使用方法

---

get请求

Map<String, String> params = new HashMap<String, String>();
params.put(Constant.ID,id);
new OkHttpGetRequest.Builder().url(RequestLinks.VIDEO_LIST).params(params).get(new ResultCallback<List<VideoEntity>>(this, false) {
    @Override
    public void onResponse(List<VideoListEntity> response) {
        //UI线程，返回数据可在此处理
    }

    @Override
    public void onStatus(String response) {
        //非常规数据返回，例如参数错误、token超时等
    }
});

post请求

Map<String, String> params = new HashMap<String, String>();
params.put(Constant.ID,id);
new OkHttpPostRequest.Builder().url(RequestLinks.VIDEO_LIST).params(params).post(new ResultCallback<List<VideoEntity>>(this, false) {
    @Override
    public void onResponse(List<VideoListEntity> response) {
        //UI线程，返回数据可在此处理
    }

    @Override
    public void onStatus(String response) {
        //非常规数据返回，例如参数错误、token超时等
    }
});

download文件

Map<String, String> map = new HashMap<String, String>();
map.put(Constant.APP_ID, appVersionInfo.getId());
new OkHttpGetRequest.Builder().destFileDir("文件存储路径").destFileName(Constant.APPNAME).url(url).params(map).download(new ResultCallback<String>((BaseActivity) mContext, false) {
    @Override
    public void onResponse(String response) {

    }

    @Override
    public void inProgress(float progress) {
        showProgress = (int) (progress * 100);
        updateProgressBar.setProgress(showProgress);
        tv_progress.setText(showProgress + "%");
        if (showProgress == 100) {
            //下载完毕
        }
    }

    @Override
    public void onStatus(String response) {
        //非常规数据返回，例如参数错误、token超时等
    }
});

四.封装结构

---

类图结构

1. OkHttpClientManager有个单例方法所以关联自己
2. OkHttpRequest与OkHttpClientManager关联，他们是一种拥有关系
3. Builder构建类是OkHttpRequest的内部类
4. OkHttpPostRequest和OkHttpGetRequest继承于OKHttpRequest
5. 后面不详述