使用OkHttp发送POST请求的快速入门指南

译者注：https://www.baeldung.com/ 是一个文章质量非常高的英文技术网站，感兴趣的同学可以去访问学习。

1介绍

本文将介绍 OkHttp 客户端的基本用法。

在本篇简短的技术文章中，我们将特别介绍 OkHttp 3.x 版本中发送Post请求的不同方式。

2 基本的 POST 请求

我们可以使用 FormBody.Builder 构造基本的 RequestBody ， 包含两个参数：用户名、密码，发送 POST请求。

@Test
public void whenSendPostRequest_thenCorrect() 
  throws IOException {
    RequestBody formBody = new FormBody.Builder()
      .add("username", "test")
      .add("password", "test")
      .build();
 
    Request request = new Request.Builder()
      .url(BASE_URL + "/users")
      .post(formBody)
      .build();
 
    Call call = client.newCall(request);
    Response response = call.execute();
     
    assertThat(response.code(), equalTo(200));
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

3 带授权的 POST 请求

如果要对请求进行身份验证，可以使用 Credentials.basic 构建器向请求头中添加凭据。

下面代码给出发送一个 String 字符串作为请求体带授权的例子:

@Test
public void whenSendPostRequestWithAuthorization_thenCorrect() 
  throws IOException {
    String postBody = "test post";
     
    Request request = new Request.Builder()
      .url(URL_SECURED_BY_BASIC_AUTHENTICATION)
      .addHeader("Authorization", Credentials.basic("username", "password"))
      .post(RequestBody.create(
        MediaType.parse("text/x-markdown), postBody))
      .build();
 
    Call call = client.newCall(request);
    Response response = call.execute();
 
    assertThat(response.code(), equalTo(200));
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

4 POST方式发送 JSON 数据

为了在请求体中发送 JSON，我们必须设置它的媒体类型 application/json。 我们可以使用 RequestBody.create构建器来构造：

@Test
public void whenPostJson_thenCorrect() throws IOException {
    String json = "{\"id\":1,\"name\":\"John\"}";
 
    RequestBody body = RequestBody.create(
      MediaType.parse("application/json"), json);
 
    Request request = new Request.Builder()
      .url(BASE_URL + "/users/detail")
      .post(body)
      .build();
  
    Call call = client.newCall(request);
    Response response = call.execute();
 
    assertThat(response.code(), equalTo(200));
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

5 Multipart POST 请求

为了发送一个 Multipart Post 请求， 我们需要将 RequestBody 构建为一个 MultipartBody 来发布文件、用户名和密码的 POST 请求：

@Test
public void whenSendMultipartRequest_thenCorrect() 
  throws IOException {  
    RequestBody requestBody = new MultipartBody.Builder()
      .setType(MultipartBody.FORM)
      .addFormDataPart("username", "test")
      .addFormDataPart("password", "test")
      .addFormDataPart("file", "file.txt",
        RequestBody.create(MediaType.parse("application/octet-stream"), 
          new File("src/test/resources/test.txt")))
      .build();
 
    Request request = new Request.Builder()
      .url(BASE_URL + "/users/multipart")
      .post(requestBody)
      .build();
 
    Call call = client.newCall(request);
    Response response = call.execute();
 
    assertThat(response.code(), equalTo(200));
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

6 发送不带默认字符编码的POST 请求

Okhttp 的默认字符编码是 UTF-8:

@Test
public void whenPostJsonWithoutCharset_thenCharsetIsUtf8() throws IOException {
    final String json = "{\"id\":1,\"name\":\"John\"}";
 
    final RequestBody body = RequestBody.create(
        MediaType.parse("application/json"), json);
 
    String charset = body.contentType().charset().displayName();
 
    assertThat(charset, equalTo("UTF-8"));
}
1
2
3
4
5
6
7
8
9
10
11

如果我们想使用其他字符编码，我们可以将其作为 MediaType.parse () 的第二个参数传入:

@Test
public void whenPostJsonWithUtf16Charset_thenCharsetIsUtf16() throws IOException {
    final String json = "{\"id\":1,\"name\":\"John\"}";
 
    final RequestBody body = RequestBody.create(
        MediaType.parse("application/json; charset=utf-16"), json);
 
    String charset = body.contentType().charset().displayName();
 
    assertThat(charset, equalTo("UTF-16"));
}
1
2
3
4
5
6
7
8
9
10
11

7 总结

在这篇短文中，我们给出了几个使用 OkHttp 客户端发送 POST 请求的示例。

和往常一样，本文的示例代码已发布在 GitHub上。