SpringMVC中RequestBody注解的List参数传递方式
作者:z.haoui
RequestBody注解的List参数传递
Controller方法参数:@RequestBody List<Long> ids
前端传的json数据:
[ 1010, 1011 ]
Controller方法参数:@RequestBody User user
把List集合封装在一个实体类型中,用该实体类型作为Controller的方法参数
User为实体类型,里面有个List<Long>类型的参数(假设名为userIds,且有对应的getter、setter方法)
前端传的json数据:
{ "userIds": [ 1, 2 ] }
@RequestBody注解分析
get和post
GET可以拥有请求体,RFC 文档中从来就没有说过 GET 没有请求体.RFC 只是说GET 意味着通过 URI 来识别资源。所以GET请求体中的数据一般都是不做处理的,有些 http 的 lib 里不让甚至直接不提供 GET 方法追加请求体的操作。
POST请求拥有请求体,并且请求数据一般都是放在请求体当中的。所以在处理POST请求时,通常都是从请求体中获取数据。
1.@RequestBody
1.1用途:
用于接收前端传递给后端的json字符串中的数据。(处理json格式的数据)
@RequestBody用来接收前端传递给后端的json字符串中的数据,GET方式的请求一般通过URL中携带key-value参数,而@RequestBody接收的是请求体中的数据(json格式的数据,只有请求体中能保存json),所以使用@RequestBody接收数据的时候必须是POST方式等方式。
@RequestBody与@RequestParam()可以同时使用,但@RequestBody最多只能有一个,而@RequestParam()可以多个。
1.2语法:
(@RequestBody Map map) (@RequestBody Object object)
(@RequestBody Map map)
先对简单,将json解析成Map形式的key-value对,直接通过map.get(“KeyName”)就能拿到值了(@RequestBody Object object)
通过json字符串中的key来匹配对应实体类的属性如果匹配一致且json中的该key对应的值符合实体类的对应属性的类型要求时,会调用实体类的setter方法将值注入到该属性。
如:
public Result deleteBookById(@RequestBody HashMap<String, String> map) { this.bookService.deleteBookById(Long.parseLong(map.get("id"))); return Result.createWithSuccessMessage(); } public Result updateBookById(@RequestBody Book book){ Book record = this.bookService.updateBookById(book); return Result.createWithModel(record); }
注意:
在(@RequestBody Object object)中,前端POST过来的数据会通过反序列数据到实体类中,并且在反序列的过程中会进行类型的转换。
在json中应该用null来代表空值,如果是""(空字符串)会判断为空串,如果实体类属性是String类型的,那么接受到的就是"",如果实现类属性类型是Integer、Double等类型,那么接收到的就是null。
{ name:"", age:null }
(@RequestBody Object object)内部是通过传递过来的数据中的Key寻找setter方法,有则调用,无则不作任何操作(其实可以设计)。
如果通过Key匹配到setter方法,但是Value无法转换为对应的实例类属性的类型时,抛出异常。
2.@RequestParam
2.1 用途:
@RequestParam用来处理 Content-Type 为 application/x-www-form-urlencoded 编码的内容,Content-Type默认为该属性。
可以用于接收URL中的参数并捆绑到方法的参数中,也可以接受post请求体中的Content-Type 为 application/x-www-form-urlencoded的数据。(post比较常用的是json格式数据)
语法:
@RequestParam(value=”参数名”,required=”true/false”,defaultValue=””)
value
:参数的keyrequired
:是否为必须,请求中必须包含该参数,如果不包含就报错。defaultValue
:代替的默认参数值,设置后required将自动置false
如:
public ModelAndView getUserByName(@RequestParam("name")String name){ ModelAndView mv = new ModelAndView(); log.info(name); return mv; } //必须携带name参数 public ModelAndView getUserByName2(@RequestParam("name",required="true")String name){ ModelAndView mv = new ModelAndView(); log.info(name); return mv; }
3.两者混合使用
@RequestBody与@RequestParam()可以同时使用,但@RequestBody最多只能有一个,而@RequestParam()可以多个。 public Result deleteBookById(@RequestBody HashMap<String, String> map,@RequestParam("name")String name) { System.out.println(map.get("id")); System.out.println(name); return Result.createWithSuccessMessage(); }
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。