【译】Okhttp3之使用案例（一）

本文主要是介绍了如何快速使用Okhttp，由于英文能力有限，有不准确的地方，请参考原文。

原文地址https://github.com/square/okhttp/wiki/Recipes

同步Get请求

下载一个文件，打印它的响应头信息，并以String打印响应体数据。

响应体ResponseBody的string()方法对小文档来说会更方便有效，但是如果响应体比较大（超过1MiB）请不要使用string(),因为它会把整个文档加载到内存中，这种情况下可以把响应体作为流来处理（可以使用ResponseBody的byteStream()方法）；

private final OkHttpClient client = new OkHttpClient();

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

    try (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());
    }
  }

异步Get请求

在工作线程下载文件，然后在响应可读时获得回调，这个回调在响应头准备好之后调用。这个时候读取响应体仍然会被拒绝，此时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(Call call, IOException e) {
        e.printStackTrace();
      }

      @Override public void onResponse(Call call, Response response) throws IOException {
        try (ResponseBody responseBody = response.body()) {
          if (!response.isSuccessful()) throw new IOException("Unexpected code " + response);

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

          System.out.println(responseBody.string());
        }
      }
    });
  }

 访问HTTP头（Headers）

通常，HTTP的Headers工作方式如下Map<String, String>：每个字段都有一个值或没有。但是一些请求头允许有多个值比如Guava的 Multimap。比如，HTTP响应提供多个Vary头是合法且常见的。OkHttp的API试图使两种情况都很便捷。添加请求头时，用header(name, value)设置唯一的name和 value。如果已经存在当前值，则在添加新值之前将删除它们。使用addHeader(name, value)添加一个请求头时，不会移除已经存在的值。读取响应头时，用header(name)返回最后一次出现的值。通常这只会发生一次！如果没有值，header(name)则返回null。要将所有字段的值作为列表读取，请使用headers(name)。要访问所有头，请使用Headers——支持按索引访问的类；

private final OkHttpClient client = new OkHttpClient();

  public void run() throws Exception {
    Request request = new Request.Builder()
        .url("https://api.github.com/repos/square/okhttp/issues")
        .header("User-Agent", "OkHttp Headers.java")
        .addHeader("Accept", "application/json; q=0.5")
        .addHeader("Accept", "application/vnd.github.v3+json")
        .build();

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

      System.out.println("Server: " + response.header("Server"));
      System.out.println("Date: " + response.header("Date"));
      System.out.println("Vary: " + response.headers("Vary"));
    }
  }

Post请求提交String字符串

使用HTTP POST向服务器发送请求体。这个例子将markdown文档发布到把markdown呈现为HTML的Web服务器，由于整个请求体同时在内存中，因此请避免使用此API发布大型（大于1 MiB）文档。

public static final MediaType MEDIA_TYPE_MARKDOWN
      = MediaType.parse("text/x-markdown; charset=utf-8");

  private final OkHttpClient client = new OkHttpClient();

  public void run() throws Exception {
    String postBody = ""
        + "Releases\n"
        + "--------\n"
        + "\n"
        + " * _1.0_ May 6, 2013\n"
        + " * _1.1_ June 15, 2013\n"
        + " * _1.2_ August 11, 2013\n";

    Request request = new Request.Builder()
        .url("https://api.github.com/markdown/raw")
        .post(RequestBody.create(MEDIA_TYPE_MARKDOWN, postBody))
        .build();

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

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

POST 提交流Streaming

这个例子中我们将请求体作为流发送。请求体的内容在其开始写入时产生，此示例直接流入Okio缓冲接收器。在您的程序可能更喜欢OutputStream，您可以从BufferedSink.outputStream()中获得。

public static final MediaType MEDIA_TYPE_MARKDOWN
      = MediaType.parse("text/x-markdown; charset=utf-8");

  private final OkHttpClient client = new OkHttpClient();

  public void run() throws Exception {
    RequestBody requestBody = new RequestBody() {
      @Override public MediaType contentType() {
        return MEDIA_TYPE_MARKDOWN;
      }

      @Override public void writeTo(BufferedSink sink) throws IOException {
        sink.writeUtf8("Numbers\n");
        sink.writeUtf8("-------\n");
        for (int i = 2; i <= 997; i++) {
          sink.writeUtf8(String.format(" * %s = %s\n", i, factor(i)));
        }
      }

      private String factor(int n) {
        for (int i = 2; i < n; i++) {
          int x = n / i;
          if (x * i == n) return factor(x) + " × " + i;
        }
        return Integer.toString(n);
      }
    };

    Request request = new Request.Builder()
        .url("https://api.github.com/markdown/raw")
        .post(requestBody)
        .build();

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

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

Post上传文件

将文件作为请求体很容易。

public static final MediaType MEDIA_TYPE_MARKDOWN
      = MediaType.parse("text/x-markdown; charset=utf-8");

  private final OkHttpClient client = new OkHttpClient();

  public void run() throws Exception {
    File file = new File("README.md");

    Request request = new Request.Builder()
        .url("https://api.github.com/markdown/raw")
        .post(RequestBody.create(MEDIA_TYPE_MARKDOWN, file))
        .build();

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

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

Post提交表单数据

使用FormBody.Builder 来构建一个请求体，就一个HTML的<form>标签一样，名称和值将使用与HTML兼容的表单URL编码进行编码。

private final OkHttpClient client = new OkHttpClient();

  public void run() throws Exception {
    RequestBody formBody = new FormBody.Builder()
        .add("search", "Jurassic Park")
        .build();
    Request request = new Request.Builder()
        .url("https://en.wikipedia.org/w/index.php")
        .post(formBody)
        .build();

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

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

POST请求上传Multipart

MultipartBody.Builder可以构建与HTML文件上传表单兼容的复杂请求体。Multipart请求体的每个部分本身都是一个请求体，并且可以定义自己的请求头。如果有（定义自己的请求头），这些请求头应该对应部分（part）进行说明，例如它的内容情况；如果可以获得，Content-Length和Content-Type头信息会被自动添加。

/**
   * 说明：imgur是一个免费的图片分享网站，创办于2009年，提供了简单直接、带编辑功能的图片在线分享
   * 服务，格式持jpeg、gif、png、bmp等。用户成功上传图片后，可以通过分享代码外链到博客、论坛或
   * 者其他网站。                    
   * IMGUR_CLIENT_ID是imgur的客户端ID.如果您正在使用imgur而不是运行
   * 这些示例，请申请您自己的客户ID！https://api.imgur.com/oauth2
   */
  private static final String IMGUR_CLIENT_ID = "...";
  private static final MediaType MEDIA_TYPE_PNG = MediaType.parse("image/png");

  private final OkHttpClient client = new OkHttpClient();

  public void run() throws Exception {
    // 使用imgur图片上传API，如https://api.imgur.com/endpoints/image
    RequestBody requestBody = new MultipartBody.Builder()
        .setType(MultipartBody.FORM)
        .addFormDataPart("title", "Square Logo")
        .addFormDataPart("image", "logo-square.png",
            RequestBody.create(MEDIA_TYPE_PNG, new File("website/static/logo-square.png")))
        .build();

    Request request = new Request.Builder()
        .header("Authorization", "Client-ID " + IMGUR_CLIENT_ID)
        .url("https://api.imgur.com/3/image")
        .post(requestBody)
        .build();

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

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

缓存

要缓存响应结果，您需要一个可以读取和写入的缓存目录，以及缓存大小的限制。缓存目录应该是私有的，不受信任的应用程序不应该能够读取其内容！让多个缓存同时访问同一个目录是错误的，大多数应用程序应该只调用new OkHttpClient()一次，使用缓存配置它，并在任何地方使用相同的实例。否则，两个缓存实例将相互重叠，破坏响应缓存，并可能导致程序崩溃。响应的缓存使用HTTP头进行所有配置。您可以添加类似的请求头Cache-Control: max-stale=3600，OkHttp的缓存将实现它们。您的web服务器会根据自己的头信息配置响应多久被缓存，例如Cache-Control: max-age=9600。一些缓存头可强制缓存响应，强制网络响应，或强制使用条件GET验证网络响应。

private final OkHttpClient client;

  public CacheResponse(File cacheDirectory) throws Exception {
    int cacheSize = 10 * 1024 * 1024; // 10 MiB
    Cache cache = new Cache(cacheDirectory, cacheSize);

    client = new OkHttpClient.Builder()
        .cache(cache)
        .build();
  }

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

    String response1Body;
    try (Response response1 = client.newCall(request).execute()) {
      if (!response1.isSuccessful()) throw new IOException("Unexpected code " + response1);

      response1Body = response1.body().string();
      System.out.println("Response 1 response:          " + response1);
      System.out.println("Response 1 cache response:    " + response1.cacheResponse());
      System.out.println("Response 1 network response:  " + response1.networkResponse());
    }

    String response2Body;
    try (Response response2 = client.newCall(request).execute()) {
      if (!response2.isSuccessful()) throw new IOException("Unexpected code " + response2);

      response2Body = response2.body().string();
      System.out.println("Response 2 response:          " + response2);
      System.out.println("Response 2 cache response:    " + response2.cacheResponse());
      System.out.println("Response 2 network response:  " + response2.networkResponse());
    }

    System.out.println("Response 2 equals Response 1? " + response1Body.equals(response2Body));
  }

取消请求

用于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);

    System.out.printf("%.2f Executing call.%n", (System.nanoTime() - startNanos) / 1e9f);
    try (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);
    }
  }

请求超时设置

当服务器无法访问时，使用请求超时来结束请求。网络分裂（网络出现故障）可能是由于客户端的连接问题，服务器的可用性等任何两者之间的其他问题。OkHttp支持连接，读取和写入超时。

 private final OkHttpClient client;

  public ConfigureTimeouts() throws Exception {
    client = new OkHttpClient.Builder()
        .connectTimeout(10, TimeUnit.SECONDS)
        .writeTimeout(10, TimeUnit.SECONDS)
        .readTimeout(30, TimeUnit.SECONDS)
        .build();
  }

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

    try (Response response = client.newCall(request).execute()) {
      System.out.println("Response completed: " + response);
    }
  }

为一个请求执行特殊的配置

所有HTTP客户端配置都包含在OkHttpClient内，包括代理设置，超时和缓存。当您需要更改单个请求的配置时，请调用OkHttpClient.newBuilder()。这将返回与原始客户端共享相同连接池，调度程序和配置的构建器。在下面的示例中，我们发出一个请求，其中500毫秒超时，另一个请求超时3000毫秒。

private final OkHttpClient client = new OkHttpClient();

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

    // Copy to customize OkHttp for this request.
    OkHttpClient client1 = client.newBuilder()
        .readTimeout(500, TimeUnit.MILLISECONDS)
        .build();
    try (Response response = client1.newCall(request).execute()) {
      System.out.println("Response 1 succeeded: " + response);
    } catch (IOException e) {
      System.out.println("Response 1 failed: " + e);
    }

    // Copy to customize OkHttp for this request.
    OkHttpClient client2 = client.newBuilder()
        .readTimeout(3000, TimeUnit.MILLISECONDS)
        .build();
    try (Response response = client2.newCall(request).execute()) {
      System.out.println("Response 2 succeeded: " + response);
    } catch (IOException e) {
      System.out.println("Response 2 failed: " + e);
    }
  }