在详细介绍之前,我知道在 Stackoverflow 上有很多对话和相关问题。所有这些都以不同的方式帮助我,所以我认为我将我的发现放在一起作为一个有组织的常见问题解答来总结我的发现。
相关概念
您当然知道这些,但我只是将它们写为快速评论。如果我遗漏了什么,请随时编辑。
HTTP POST 请求:
当您愿意将对象发送到 Web 服务或服务器端应用程序时,将使用发布请求。
序列化:
是从 Web 浏览器获取对象到服务器端应用程序的过程。可以使用 jQuery Ajax 调用或 Curl post 请求。
序列化协议:
目前最流行的是 JSON 和 XML。由于 XML 标记的性质,序列化的 xml 对象的大小相对较大,因此 XML 变得不那么流行了。在这个常见问题解答中,主要关注的是JSON2序列化。
春天:
Spring 框架及其强大的注解使得以一种有效的方式暴露 Web 服务成为可能。Spring中有很多不同的库。这里我们关注的是Spring web MVC。
卷曲与 JQuery:
这些是您可以用来在客户端发出发布请求的工具。即使您打算使用 JQuery ajax 调用,我建议您使用 Curl 进行调试,因为它会在发出 post 请求后为您提供详细的响应。
@RequestBody 与 @RequestParam/@PathVariable 与 @ModelAttribute:
如果您的 Web 服务不依赖于您的 Java EE 模型,则必须使用 @RequestBody。如果您正在使用模型并且您的 JSON 对象已添加到模型中,则可以通过 @ModelAttribute 访问该对象。只有在您的请求是 GET 请求或 GET 和 POST 请求组合的情况下,您才需要使用 @RequestParam/@PathVariable。
@RequestBody 与 @ResposeBody:
正如您从名称中看到的那样简单,如果您在服务器端方法处理请求后向客户端发送响应,则只需要@ResponseBody。
RequestMappingHandlerAdapter 与 AnnotationMethodHandlerAdapter:
RequestMappingHandlerAdapter 是 Spring 框架的新映射处理程序,自 Spring 3.1 以来取代了 AnnotationMethodHandlerAdapter。如果您现有的配置仍在 AnnotationMethodHandlerAdapter 中,您可能会发现这篇文章很有用。我的帖子中提供的配置将让您了解如何设置 RequestMappingHandlerAdapter。
设置
您将需要设置一个消息转换器。这就是您的序列化 JSON 消息正文如何在服务器端转换为本地 java 对象的方式。
从这里开始的基本配置。转换器是基本配置示例中的 MarshallingHttpMessageConverter 和 CastorMarshaller ,我已将它们替换为 MappingJackson2HttpMessageConverter 和 MappingJacksonHttpMessageConverter。
在哪里放置配置
我的项目设置方式,我有两个配置文件:
- Application Context XML:其中之一是您的 sessionFactory bean、dataSource bean 等所在的应用程序上下文 XML 文件。
- MVC Dispatcher Servlet XML:这是您拥有视图解析器 bean 并导入应用程序上下文 XML 的地方。
hadlerAdapter bean 必须位于 MVC Dispatcher XML 文件中。
<bean name="handlerAdapter"
class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
<property name="messageConverters">
<list>
<bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter"/>
<ref bean="jsonConverter"/>
</list>
</property>
<property name="requireSession" value="false"/>
</bean>
<bean id="jsonConverter" class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
<property name="supportedMediaTypes" value="application/json"/>
</bean>
您可以有多个消息转换器。在这里,我创建了一个普通的 JSON 以及一个 JSON 2 消息转换器。XML 文件中的 Ref 和普通 bean 格式都已使用(我个人更喜欢 ref 标签,因为它更整洁)。
REST API
这是一个公开 REST API 的示例控制器。
控制器
这是您的 HTTP 发布请求的 REST API 公开的地方。
@Component
@Controller
@RequestMapping("/api/user")
public class UserController {
@RequestMapping(value = "/add", method = RequestMethod.POST, consumes = MediaType.APPLICATION_JSON_VALUE)
@ResponseBody
public String insertUser(@RequestBody final User user) {
System.out.println(user.toString());
userService.insertUser(user);
String userAdded = "User-> {" + user.toString() + "} is added";
System.out.println(userAdded);
return userAdded;
}
}
Java 对象
@JsonAutoDetect
public class User {
private int id;
private String username;
private String name;
private String lastName;
private String email;
public int getId() {
return externalId;
}
public void setId(final int id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(final String name) {
this.name = name;
}
public String getEmail() {
return email;
}
public void setEmail(final String email) {
this.email = email;
}
public String getUsername() {
return username;
}
public void setUsername(final String username) {
this.username = username;
}
public String getLastName() {
return lastName;
}
public void setLastName(final String lastName) {
this.lastName = lastName;
}
@Override
public String toString() {
return this.getName() + " | " + this.getLastName() + " | " + this.getEmail()
+ " | " + this.getUsername() + " | " + this.getId() + " | ";
}
}
CURL 后呼叫
curl -i -H "Content-Type: application/json" -X POST -d '{"id":100,"username":"JohnBlog","name":"John","lastName":"Blog","email":"JohnBlog@user.com"}' http://localhost:8080/[YOURWEBAPP]/api/user/add
相关帖子和问题
如果不是针对所有提供以下帖子和问题的人,此常见问题解答是不可能的(如果我遇到有用的相关帖子/问题,此列表将扩大):
- 什么是正确的JSON 内容类型?
- Spring 3.0 使用杰克逊消息转换器做出 JSON 响应
- 如何从终端/命令行使用 Curl 发布 JSON 数据以测试 Spring REST?
- 将 JSON 发布到 REST API
- https://github.com/geowarin/spring-mvc-examples
- 如何使用 curl 将 JSON 发布到 PHP
- 弹簧休息 | MappingJacksonHttpMessageConverter 产生无效的 JSON
- https://github.com/eugenp/REST
- Spring Web MVC - 验证单个请求参数
- 如何从终端/命令行使用 Curl 发布 JSON 数据以测试 Spring REST?
- 如何从 Java Servlet 返回 JSON 对象
- 如果 REST API 返回 JSON,那么 MIME 类型是什么?