Spring @RequestBody 教程展示了如何使用@RequestBody 注解将方法参数绑定到请求主体。
Spring 是用于创建企业应用的流行 Java 应用框架。
Spring @RequestBody
@RequestBody注释将请求主体绑定到方法参数。 序列化/反序列化的过程由HttpMessageConverter执行。 另外，可以通过使用@Valid注释自变量来应用自动验证。
Spring @RequestBody示例
该应用将表单 POST 和 JSON post 请求的请求主体参数绑定到映射的方法参数。
pom.xml
src
├───main
│ ├───java
│ │ └───com
│ │ └───zetcode
│ │ ├───bean
│ │ │ User.java
│ │ ├───config
│ │ │ MyWebInitializer.java
│ │ │ WebConfig.java
│ │ └───controller
│ │ MyController.java
│ └───resources
│ logback.xml
└───test
└───java
这是项目结构。
pom.xml
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
我们声明必要的依赖关系。 在HttpMessageConverter中进行序列化需要jackson-databind。 该应用在嵌入式 Jetty 上运行； 因此，我们声明jetty-maven-plugin。
resources/logback.xml
logback.xml是 Logback 日志库的配置文件。
com/zetcode/bean/User.java
package com.zetcode.bean;
public class User {
private String name;
private String occupation;
public User() {
}
public User(String name, String occupation) {
this.name = name;
this.occupation = occupation;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getOccupation() {
return occupation;
}
public void setOccupation(String occupation) {
this.occupation = occupation;
}
@Override
public String toString() {
final StringBuilder sb = new StringBuilder("User{");
sb.append("name='").append(name).append('\'');
sb.append(", occupation='").append(occupation).append('\'');
sb.append('}');
return sb.toString();
}
}
在示例中，我们具有User bean，它具有name和occupation属性。
com/zetcode/config/MyWebInitializer.java
package com.zetcode.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;
@Configuration
public class MyWebInitializer extends
AbstractAnnotationConfigDispatcherServletInitializer {
@Override
protected Class[] getRootConfigClasses() {
return null;
}
@Override
protected Class[] getServletConfigClasses() {
return new Class[]{WebConfig.class};
}
@Override
protected String[] getServletMappings() {
return new String[]{"/"};
}
}
MyWebInitializer注册 Spring DispatcherServlet，它是 Spring Web 应用的前端控制器。
com/zetcode/config/WebConfig.java
package com.zetcode.config;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
@EnableWebMvc
@ComponentScan(basePackages = {"com.zetcode"})
public class WebConfig implements WebMvcConfigurer {
}
WebConfig通过@EnableWebMvc启用 Spring MVC 注解，并为com.zetcode软件包配置组件扫描。
com/zetcode/controller/MyController.java
package com.zetcode.controller;
import com.zetcode.bean.User;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.util.MultiValueMap;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class MyController {
private static final Logger logger = LoggerFactory.getLogger(MyController.class);
@ResponseStatus(value = HttpStatus.OK)
@PostMapping(value="/vals")
public void process(@RequestBody MultiValueMap
logger.info("Values:{}", values);
}
@ResponseStatus(value = HttpStatus.OK)
@PostMapping(value="/user", consumes = MediaType.APPLICATION_JSON_VALUE)
public void process2(@RequestBody User user) {
logger.info("User: {}", user);
}
}
在MyContoller中，我们有两个 POST 映射。 我们使用@RequestBody将请求参数绑定到MultiValueMap和User bean。 绑定值显示在日志中。
$ mvn jetty:run
我们启动服务器。
$ curl -i -d "par1=val1&par2=val2" -X POST http://localhost:8080/vals
使用curl工具，我们可以创建第一个映射的请求。 这将创建一个表单 POST 数据请求（内容类型为 application / x-www-form-urlencoded）。
11:57:39.049 INFO com.zetcode.controller.MyController - Values:{par1=[val1], par2=[val2]}
我们得到这个日志。
$ curl -i -H "Content-Type: application/json" -d "{\"name\":\"John Doe\",\"occupation\":\"gardener\"}" -X POST "http://localhost:8080/user"
我们调用第二个映射。 在这里，我们使用 JSON 数据创建一个请求。 请注意，在 Windows 上，我们需要转义双引号。
12:02:33.817 INFO com.zetcode.controller.MyController - User: User{name='John Doe', occupation='gardener'}
这是日志中的输出。
在本教程中，我们使用@RequestBody注解将请求属性绑定到方法参数。