Spring 4.x/3.x (Web MVC) REST API 和 JSON2 Post 请求，如何一次性解决？

2023-12-30

在详细介绍之前，我知道 Stackoverflow 上已经有很多对话和相关问题。他们都以不同的方式帮助我，所以我想我将我的发现全部放在一起作为一个有组织的常见问题解答来总结我的发现。

Setup

您将需要设置一个消息转换器。这就是序列化 JSON 消息正文在服务器端转换为本地 java 对象的方式。

基本配置来自here https://stackoverflow.com/questions/3979649/json2-vs-jquery-json。转换器是 Marshalling HttpMessageConverter 和 CastorMarshaller基本配置示例 https://stackoverflow.com/questions/3979649/json2-vs-jquery-json，我已将它们替换为 MappingJackson2HttpMessageConverter 和 MappingJacksonHttpMessageConverter。

配置放在哪里

我的项目设置方式有两个配置文件：

应用程序上下文 XML：其中之一是 sessionFactory bean、dataSource bean 等所在的应用程序上下文 XML 文件。
MVC 调度程序 Servlet XML：您可以在此处拥有视图解析器 bean 并导入应用程序上下文 XML。

hadlerAdapter bean 必须位于后面的 MVC 调度程序 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 post 请求的 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":"JohnB[email protected] /cdn-cgi/l/email-protection"}' http://localhost:8080/[YOURWEBAPP]/api/user/add

不同的错误场景：

在这里，我探讨了进行卷曲调用后可能会遇到的不同错误以及可能出现的问题。

场景一：

HTTP/1.1 404 Not Found
Server: Apache-Coyote/1.1
Content-Type: text/html;charset=utf-8
Content-Length: 949
Date: Tue, 04 Jun 2013 02:59:35 GMT

这意味着您提供的 URL 中不存在 REST API。

Root cause:

您的请求中可能有拼写错误（相信我这可能会发生）！
可能是你的弹簧配置不正确。如果是这种情况，则需要进一步深入了解到底出了什么问题，但我已经提供了在开始更复杂的调查之前需要执行的一些初步操作。

Actions:

在确保一切都完全正确并且您的配置和 URL 都没有问题之后： - 运行 Maven 清理。 - 取消部署您的网络应用程序或直接将其删除。 - 重新部署网络应用程序 - 确保在您的 maven/gradle 中仅使用 Spring 的一个版本

场景二：

HTTP/1.1 400 Bad Request
Server: Apache-Coyote/1.1
Content-Type: text/html;charset=utf-8
Content-Length: 968
Date: Tue, 04 Jun 2013 03:08:05 GMT
Connection: close

其背后的唯一原因是您的请求格式不正确。如果您检查详细的curl响应，您应该能够看到“客户端发送的请求在语法上不正确。”。

Root cause:

您的 JSON 格式不正确，或者您缺少 JAVA 对象的强制参数。

Actions:

确保以正确的格式和正确数量的参数提供 JSON 对象。可空属性不是强制性的，但您必须为所有不可空属性提供数据。记住 Spring 使用 Java 反射将 JSON 文件转换为 Java 对象非常重要，这意味着什么？这意味着变量和方法名称是 CasE SensItiVe。如果您的 JSON 文件发送变量“userName”，则 Java 对象中的匹配变量也必须命名为“userName”。如果您有 getter 和 setter，它们也必须遵循相同的规则。 getUserName 和 setUserName 与我们前面的示例相匹配。

参议员三：

HTTP/1.1 415 Unsupported Media Type
Server: Apache-Coyote/1.1
Content-Type: text/html;charset=utf-8
Content-Length: 1051
Date: Wed, 24 Aug 2011 08:50:17 GMT

Root cause:

您的 Web 服务不支持 Json 媒体类型。这可能是由于您的注释未指定媒体类型，或者您未在 Curl post 命令中指定媒体类型。

Actions:

检查您的消息转换器设置是否正确，并确保 Web 服务注释与上面的示例匹配。如果这些没问题，请确保在 Curl post 请求中指定内容类型。

您的 Web 服务不支持 json 媒体类型。

塞纳里奥·N（！）：

HTTP/1.1 200 OK 
Server: Apache-Coyote/1.1 
Content-Type: application/json;charset=UTF-8 
Transfer-Encoding: chunked 
Date: Tue, 04 Jun 2013 03:06:16 GMT

恭喜用户实际上已发送到您的服务器端 REST API。

有关如何设置 spring 的更多详细信息，请查看 spring mvc 指南。