idtitlesidebar_label
http_body
HTTP Body
HTTP Body

POSTPUT等请求方法中,通常使用 HTTP 请求体进行传输数据。在 Forest 中有多种方式设置请求体数据。

data 属性

您可以通过@Request注解的data属性把数据添加到请求体。需要注意的是只有当typePOSTPUTPATCH这类 HTTP Method 时,data属性中的值才会绑定到请求体中,而GET请求在有些情况会绑定到url的参数中。

具体type属性和data属性数据绑定位置的具体关系如下表:

typedata属性数据绑定位置支持的contentTypeContent-Type请求头
GETurl参数部分只有application/x-www-form-urlencoded
POST请求体任何contentType
PUT请求体任何contentType
PATCH请求体任何contentType
HEADurl参数部分只有application/x-www-form-urlencoded
OPTIONSurl参数部分只有application/x-www-form-urlencoded
DELETEurl参数部分只有application/x-www-form-urlencoded
TRACEurl参数部分只有application/x-www-form-urlencoded

data属性在POST请求中绑定请求体

  1. public interface MyClient {
  2. @Request(
  3. url = "http://localhost:8080/hello/user",
  4. type = "post",
  5. data = "username=foo&password=bar",
  6. headers = {"Accept:text/plain"}
  7. )
  8. String dataPost();
  9. }

该接口调用后所实际产生的 HTTP 请求如下:

  1. POST http://localhost:8080/hello/user
  2. HEADER:
  3. Accept:text/plain
  4. BODY:
  5. username=foo&password=bar

data属性中进行数据绑定:

  1. public interface MyClient {
  2. /**
  3. * 这里 data 属性中设置的字符串内容会绑定到请求体中
  4. * 其中 ${0} 和 ${1} 为参数序号绑定,会将序号对应的参数绑定到字符串中对应的位置
  5. * ${0} 会替换为 username 的值,${1} 会替换为 password 的值
  6. */
  7. @Request(
  8. url = "http://localhost:8080/hello/user",
  9. type = "post",
  10. data = "username=${0}&password=${1}",
  11. headers = {"Accept:text/plain"}
  12. )
  13. String dataPost(String username, String password);
  14. }

:::info 提示 其中${数字}的语法用到了《参数序号引用》 :::

如果调用方代码如下所示:

  1. myClient.dataPost("foo", "bar");

实际产生的 HTTP 请求如下:

  1. POST http://localhost:8080/hello/user
  2. HEADER:
  3. Accept: text/plain
  4. BODY:
  5. username=foo&password=bar

您可以直接把 JSON 数据加入到请求体中,其中header设置为Content-Type: application/json

  1. public interface MyClient {
  2. @Request(
  3. url = "http://localhost:8080/hello/user",
  4. type = "post",
  5. data = "{\"username\": \"${0}\", \"password\": \"${1}\"}",
  6. headers = {"Content-Type: application/json"}
  7. )
  8. String postJson(String username, String password);
  9. }

如果调用方代码如下所示:

  1. myClient.postJson("foo", "bar");

实际产生的 HTTP 请求如下:

  1. POST http://localhost:8080/hello/user
  2. HEADER:
  3. Content-Type: application/json
  4. BODY:
  5. {"username": "foo", "password": "bar"}

把 XML 数据加入到请求体中,其中header设置为Content-Type: application/json

  1. public interface MyClient {
  2. @Request(
  3. url = "http://localhost:8080/hello/user",
  4. type = "post",
  5. data = "<misc><username>${0}</username><password>${1}</password></misc>",
  6. headers = {"Content-Type: application/xml"}
  7. )
  8. String postXml(String username, String password);
  9. }

如果调用方代码如下所示:

  1. myClient.postXml("foo", "bar");

实际产生的 HTTP 请求如下:

  1. POST http://localhost:8080/hello/user
  2. HEADER:
  3. Content-Type: application/xml
  4. BODY:
  5. <misc><username>foo</username><password>bar</password></misc>

@Body 注解

使用data属性太麻烦?绑定到URL还是Body搞不清楚?那您可以使用@Body注解修饰参数的方式,将传入参数的数据绑定到 HTTP 请求体中。

@Body注解修饰的参数一定会绑定到请求体中,不用担心它会出现在其他地方

  1. /**
  2. * 默认body格式为 application/x-www-form-urlencoded,即以表单形式序列化数据
  3. */
  4. @Post(
  5. url = "http://localhost:8080/user",
  6. headers = {"Accept:text/plain"}
  7. )
  8. String sendPost(@Body("username") String username, @Body("password") String password);

JSON格式

要让@Body绑定的对象转换成JSON格式也非常简单,只要将contentType属性或Content-Type请求头指定为application/json便可。

  1. @Request(
  2. url = "http://localhost:8080/hello/user",
  3. contentType = "application/json",
  4. type = "post"
  5. )
  6. String send(@Body User user);

调用后产生的结果如下:

  1. POST http://localhost:8080/hello/user
  2. HEADER:
  3. Content-Type: application/json
  4. BODY:
  5. {"username": "foo", "password": "bar"}

XML格式

@Body较为特殊,除了指定contentType属性或Content-Type请求头为application/xml外,还需要设置@Bodyfilter属性为xml

  1. @Post(
  2. url = "http://localhost:8080/hello/user",
  3. contentType = "application/xml"
  4. )
  5. String send(@Body(filter = "xml") User user);

此外,这里的User对象也要绑定JAXB注解:

  1. @XmlRootElement(name = "misc")
  2. public User {
  3. private String usrname;
  4. private String password;
  5. public String getUsername() {
  6. return username;
  7. }
  8. public void setUsername(String username) {
  9. this.username = username;
  10. }
  11. public String getPassword() {
  12. return password;
  13. }
  14. public void setPassword(String password) {
  15. this.password = password;
  16. }
  17. }

调用传入User对象后的结果如下:

  1. POST http://localhost:8080/hello/user
  2. HEADER:
  3. Content-Type: application/xml
  4. BODY:
  5. <misc><username>foo</username><password>bar</password></misc>