使用Spring MVC 的 @RequestBody 映射json请求参数时报“The request sent by the client was syntactically incorrect.”异常解决方案

工作笔记

最近工作中开发RESTful接口需要处理客户端上传的json，图方便想起Spring的Controller中有@RequestBody可以优雅地完成json报文与Java类的映射，但是使用时碰到了 “The request sent by the client was syntactically incorrect.” 异常，记得以前也有碰到过，但是没有把原因记录下来，这次又掉坑里了。又baidugoogle了一会才解决，好记性不如烂笔头，这次还是好好反省下。

异常原因

字面上理解就是“客户端发送的请求语法不正确”这种意义不明的异常信息。语法不正确说的是什么语法？其实这里指的是上传的json报文不符合跟对应Java类的映射关系。举个栗子：
比如页面上Ajax请求的json报文如下：

{"id":1,"name":"zhangsan","gender":1}

Java工程中对应的类定义：

public class Person(){
    private Integer id;
    //...setter and getter
}
//Spring中Congroller代码
@Controller
@RequestMapping(value = "/test")
public class TestController{
    @RequestMapping(value = "/index")
    public String index(@RequestBody Person p){
        //do something
        return "testpage";
    }
}

用上述代码映射客户端上传的json报文就会报“The request sent by the client was syntactically incorrect.”异常。原因很简单，因为上传的json报文中有id,name,gender三个字段，而用来映射的java类中只有id字段，匹配不了，这就是所谓的“语法不正确”。如果将上述 Person 类的定义改成：

public class Person(){
    private Integer id;
    private String name;
    private Integer gender;
    //...setter and getter
}

程序再跑起来没问题了。而且，这里的Person还可以多定义几个字段，即：只要客户度上传的json报文字段都有定义，且类型定义正确，使用@RequestBody映射时就不会报“The request sent by the client was syntactically incorrect.”异常。

总结

在Spring的Controller中使用@RequestBody映射客户端请求的json报文时，需要注意几点：
1. json报文中有的字段，Java类中也要做定义，且类型必须相同。
2. Java类中定义的字段，json报文中可以不出现，到时候映射出来的就是null或者默认值。