Spring 4.x3.x (Web MVC) REST API 和 JSON2 Post 请求，如何一劳永逸

发布于06月04日

Before going into details, I know there has been lots of conversations and related questions on Stackoverflow. All of them kind of help me in different ways so I thought I put my findings all together as a single organized FAQ to summarize my findings.

设置

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

从here开始的基本配置.basic configuration sample中的转换器是MarshallingHttpMessageConverter和CastorMarshaller，我将它们替换为MappingJackson2HttpMessageConverter和MappingJacksonHttpMessageConverter.

配置放在哪里

The way my project is set up, I have two config files:

应用程序上下文XML: 其中之一是您的sessionFactory bean、DataSource bean等所在的应用程序上下文XML文件.
MVC Dispatcher Servlet XML: This is where you have your view resolver bean and import your application context XML.

hadlerAdapter bean has to be located in the later that is the MVC Dispatcher XML file.

<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>

You can have multiple message convertors. here, I have created a normal JSON as well as a JSON 2 message convertor. Both Ref and normal bean format in the XML file have been used (personally I prefer the ref tag as its neater).

睡觉接口

下面是一个示例控制器，它公开了睡觉接口.

The controller

这就是HTTP post请求的睡觉接口公开的地方.

@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 Post call

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

相关概念

HTTP POST请求:

序列化:

序列化协议:

春天:

Curl vs JQuery:

@RequestBody vs@RequestParam/@PathVariable vs@ModelAttribute:

@RequestBody vs @ResposeBody:

RequestMappingHandlerAdapter vs AnnotationMethodHandlerAdapter:

设置

配置放在哪里

睡觉接口

The controller

Java对象

CURL Post call

Related posts and questions

推荐答案

CURL Post call

Different Error Scenarios:

场景一:

场景二:

Senario Three:

Senario N(!):

Related posts and questions

Json相关问答推荐