一些使用方法:
同步方法Get:
下载一个文件，打印它的头信息，打印响应体。
response.body的string()方法用来输出小型文档非常方便并且效率非常高。但是假如response.body大于1M，应该避免使用string()方法，因为它将会将整个文档加载到内存中。此时使用流更好。
1 | private final OkHttpClient client = new OkHttpClient(); |
异步Get方法
在工作线程上下载文件，并在响应可读时调用毁掉方法。 回调在响应头准备好之后进行。 读取响应体可能仍会阻塞线程。 OkHttp目前不提供异步API来接收部分响应体。
1 | private final OkHttpClient client = new OkHttpClient(); |
访问头
通常HTTP的头信息类似于Map
在写入请求标头时，使用header（name，value）将替换头信息。 如果有现有值，则在添加新值之前将删除它们。 使用addHeader（name，value）添加头，而不删除已经存在的头。
读取响应头时，使用header(name)返回最后一次的值。如果没有值，header（name）将返回null。 要将所有字段的值作为列表读取，请使用headers(name)。
要访问所有头，请使用支持通过索引访问的Headers类。
1 | private final OkHttpClient client = new OkHttpClient(); |
Post方法传入字符串
使用HTTP POST将请求正文发送到服务器。此示例将markdown文档发布到能将markdown转换为HTML的Web服务器。由于整个请求主体都在内存中，因此请避免使用此API发布大（大于1个MiB）文档。
1 | public static final MediaType MEDIA_TYPE_MARKDOWN |
Post发送流
这里使用POST方法以流的方式发送请求。请求内容将会一边生成一边写入。 此示例直接流入Okio缓冲接收器。你可能更喜欢OutputStream，您可以从BufferedSink.outputStream（）获取。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
38public 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();
Response response = client.newCall(request).execute();
if (!response.isSuccessful()) throw new IOException("Unexpected code " + response);
System.out.println(response.body().string());
}
Post一个文件
直接看代码：1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18public 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();
Response response = client.newCall(request).execute();
if (!response.isSuccessful()) throw new IOException("Unexpected code " + response);
System.out.println(response.body().string());
}
Post form表单
使用FormBody.Builder构建一个类似于HTML
1 | private final OkHttpClient client = new OkHttpClient(); |
Post复杂体请求
MultipartBody.Builder可以构建与HTML文件上传表单兼容的复杂请求体。 大部分请求正文的每个部分本身都是请求正文，并且可以定义其自己的头。 这些头信息应描述内容主体，例如其Content-Disposition。 如果Content-Length和Content-Type的header可用，则会自动添加。
1 | private static final String IMGUR_CLIENT_ID = "..."; |
使用Gson解析JSON响应体
Gson是一个很方便的API，用于在JSON和Java对象之间进行转换。 这里我们使用它来解码来自GitHub API的JSON响应。
请注意，ResponseBody.charStream（）使用Content-Type响应头来选择在解码响应正文时要使用的字符集。 如果没有指定字符集，它默认为UTF-8。
1 | private final OkHttpClient client = new OkHttpClient(); |
缓存响应
你需要为响应缓存设置一个你自己能够读写的目录，并且为这个缓存设定大小。缓存目录必须是私有的，不被信任的程序不能访问这个目录。
不能使用多个缓存同时访问同意缓存目录。大多数应用程序应该只调用OkHttpClient()一次（就是只创建一个实例），否则多个实例会导致程序崩溃，破坏缓存文件。
响应缓存对所有配置使用HTTP头。 您可以添加请求头，如Cache-Control：max-stale = 3600，OkHttp的缓存会使用这些配置。你的网络服务器会配置响应缓存持续时间的响应头，如Cache-Control：max-age = 9600。 缓存头强制缓存响应，强制网络响应，或强制使用条件GET验证网络响应。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
34private 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();
Response response1 = client.newCall(request).execute();
if (!response1.isSuccessful()) throw new IOException("Unexpected code " + response1);
String 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());
Response response2 = client.newCall(request).execute();
if (!response2.isSuccessful()) throw new IOException("Unexpected code " + response2);
String 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));
}
要防止响应使用缓存，请使用CacheControl.FORCE_NETWORK。 为了防止它使用网络，请使用CacheControl.FORCE_CACHE。
Note
：如果使用FORCE_CACHE并且响应需要网络，OkHttp将返回504 Unsatisfiable Request响应。
取消请求
使用Call.cancel()方法来立即他停止一个正在进行的请求。如果一个线程正在写入一个请求或者读取一个响应，程序将会抛出IOException异常。使用此选项可在不再需要call时节约网络资源。 例如当您的用户导航离开应用程序时，同步和异步调用都可以取消。
1 | private final ScheduledExecutorService executor = Executors.newScheduledThreadPool(1); |
连接超时
当连接不可达时使用timeouts来使一个请求失败。连接问题，服务器问题或者其他都可能导致网络连接失败，OhHttp支持连接超时，读超时和写超时。
1 | private final OkHttpClient client; |
单独配置
所有HTTP客户端配置都存在于OkHttpClient中，包括代理设置，超时和缓存。 当您需要更改单个调用的配置时，请调用OkHttpClient.newBuilder（）。 这将返回与原始客户端共享的相同连接池，调度程序和配置的构建器。 在下面的示例中，我们使用500毫秒超时创建一个请求，另一个请求使用3000毫秒超时。
1 | private final OkHttpClient client = new OkHttpClient(); |
传递认证信息
OkHttp可以自动重试未经身份验证的请求。 当响应为401 Not Authorized，将要求Authenticator提供凭据。 应构建新请求包含凭证， 如果没有可用的凭据，则返回null以跳过重试。
使用Response.challenges（）获取任何身份验证的方案和领域。 当完成基本挑战时，使用Credentials.basic（username，password）对请求标头进行编码。
1 | private final OkHttpClient client; |
你可以返回空值来放弃一个认证不通过的请求，避免多次重复本请求。例如，你可能想要跳过那些已经尝试过的请求。
1 | if (credential.equals(response.request().header("Authorization"))) { |
你也可以跳过服务器拒绝的请求：
1 | if (responseCount(response) >= 3) { |
下面是responseCount()方法：1
2
3
4
5
6
7private int responseCount(Response response) {
int result = 1;
while ((response = response.priorResponse()) != null) {
result++;
}
return result;
}