最近在用Spring Web做一些Restful API的实现试验,碰到了@RequestBody 的JSON无法被正常反序列化的问题。服务端的代码大致如下:
@RequestMapping(value = "/aquas", method = RequestMethod.POST)
public Aqua createAqua(@RequestBody Aqua aqua) {
return aqua;
}
研究后发现,由于Aqua这个实体类缺少了默认的无参构造函数(如果自行添加了有参数的构造函数,默认的无参构造函数就需要手动添加),Spring Web默认使用的JSON序列化框架-Jackson就无法正常反序列化。此时服务器会返回400 Bad Request.
解决的方法很多,比较简单直接的方法是在Aqua这个实体类里面加一个无参的构造函数。比较复杂的也可通过向Jackson添加强制的转换器的方法让Jackson理解这个JSON对象。
今天这里要介绍的方式是利用注解让Jackson理解如何反序列化实体类的JSON。这个方法更加灵活,也十分简单。实体类的部分代码如下:
@JsonCreator
public Aqua(@JsonProperty("aquaId") String id) {
this.id = id;
}
在自定义的构造函数上面添加@JsonCreator的注解,同时在参数上加上@JsonProperty的注解配合使用。加上这两个注解之后,Jackson不需要无参构造函数也可以正常反序列化JSON了。
@JsonProperty注解也可以帮助Jackson理解JSON属性名和实体类中的变量名不一致的情况。
在这里需要注意,如果有多个构造函数,建议仅仅在一个构造函数上面加上@JsonCreator注解,以免不必要的麻烦。