Spring注解@RequestBody和@RequestParam

背景

今天在写一个controller接口的时候,有个参数是List<Long>型的。然后发请求测试就出现问题了,试了几次发现用@RequestParam可以解决,但是不知道为什么,就深入研究了一下这两个注解。

content-type

在http请求头里面会看到content-type参数,官方定义是:

MediaType,即是Internet Media Type,互联网媒体类型;也叫做MIME类型,在Http协议消息头中,使用Content-Type来表示具体请求中的媒体类型信息。

通俗理解为请求内容的编码类型。
常见的编码格式:

application/x-www-form-urlencoded:数据被编码为名称/值对。这是标准的编码格式。
multipart/form-data: 数据被编码为一条消息,页上的每个控件对应消息中的一个部分。
text/plain: 数据以纯文本形式(text/json/xml/html)进行编码,其中不含任何控件或格式字符。

前端表单里的enctype属性为编码方式,常用的有两种:application/x-www-form-urlencoded和multipart/form-data,默认为application/x-www-form-urlencoded。上传文件时通常是用multipart/form-data
如果想要往后端传json串,那么就要指定content-type为application/json。而后端要接收这样的json串就要用@ReqeustBody注解修饰参数。

Controller获取参数方式

@PathVariable 获取URL中的参数
    @RequestMapping(value = "/{name}/f", method = RequestMethod.POST)
    public String g(@PathVariable String name, Integer age) {
        return "name:" + name + ",age:" + age;
    }
HttpServletRequest
    @RequestMapping(value = "/a", method = RequestMethod.POST)
    public String a(HttpServletRequest request, HttpServletResponse response) {
        return "name:" + request.getParameter("name") + ",age:" + request.getParameter("age");
    }
11.PNG
12.PNG

这是最基本的获取参数的方式,对于GET和POST请求都适用。一般在拦截器里面会用这种方式获取参数。HttpServletRequest可以获取请求头的完整信息,在一次请求的生命周期内,可以通过下面的方式获取Request对象(当然也可以获取response对象):

HttpServletRequest httpServletRequest = ((ServletRequestAttributes)RequestContextHolder.getRequestAttributes()).getRequest();
不加注解获取参数
    @RequestMapping(value = "/b", method = RequestMethod.POST)
    public String b(String name, Integer age) {
        return "name:" + name + ",age:" + age;
    }

如果不传参数则默认为null。如果参数是基本类型,则必须要传,不然会报500错。所以最好使用封装类型接受或者用bean包装起来,bean的话会给默认值0。
指定参数名和方法的参数名一致。

@RequestParam注解获取参数
    @RequestMapping(value = "/d", method = RequestMethod.POST)
    public String d(@RequestParam(value = "sss") String name, @RequestParam(value = "age", required = false) Integer age) {
        return "name:" + name + ",age:" + age;
    }

@RequestParam注解可以指定参数的名字和是否必传,除此之外,都和上面的不加注解的方式类似。
另外需要说明的一点是如果参数是基本类型,同时指定required = false,还是会报500的错。因为没有传的参数都会直接把null赋过来,基本类型是无法接受null值的,所以会报错。
另外@RequestParam的name参数和value参数是一样的作用,因为他们指定对方互相为别名。

bean方式获取参数
    @RequestMapping(value = "/c", method = RequestMethod.POST)
    public String c(User user) {
        return "name:" + user.getName() + ",age:" + user.getAge();
    }
    public class User {
        private String name;
        private int age;
    }

推荐使用这种方式,就算age是基本类型int,如果前端没传过来,也会默认给0值。

小结

以上的获取参数的方式,在postman里面都是用params填写的,也就是参数会被加到url里面去。
如果把参数放入body里面去当作表单或者用x-www-form-urlencoded提交,同样是可以的。

@RequestBody注解

    @RequestMapping(value = "/e", method = RequestMethod.POST)
    public String e(Integer age, @RequestBody String name) {
        return "name:" + name + ",age:" + age;
    }

@RequestBody注解的参数必须以body的形式提交
先看使用x-www-form-urlencoded提交


14.PNG

name的值变成了name=pzx&age=18,显然不是想要的结果。这里是因为String修饰的name,要是其他类型就会直接报不支持的类型错误,@RequestBody注解其实是不太支持x-www-form-urlencoded格式的。

@requestBody注解常用来处理content-type不是默认的application/x-www-form-urlcoded编码的内容,比如说:application/json或者是application/xml等。一般情况下来说常用其来处理application/json类型。

    @RequestMapping(value = "/f", method = RequestMethod.POST)
    public String f(@RequestBody User user) {
        return "name:" + user.getName() + ",age:" + user.getAge();
    }
15.PNG

前端传值时要指定content-type为applicati/json,后端使用bean接受即可。
如果是使用@RequestBody修饰,那么就不能通过HttpServletRequest获取参数。
@RequestBody参数只支持传入一个对象参数,它实际上是将输入流的body体作为一个整体进行转换,而body整体只有一份,解析完成之后会关闭输入流。如果传入多个参数则会报错。除非自定义参数解析器。

List参数问题

上面介绍的都是基础内容,接下来介绍遇到的问题,以及解决办法。

    @RequestMapping(value = "/h", method = RequestMethod.POST)
    public String h(List<String> name, Integer age) {
        return "name:" + name + ",age:" + age;
    }

    @RequestMapping(value = "/i", method = RequestMethod.POST)
    public String i(@RequestParam List<String> name, Integer age) {
        return "name:" + name + ",age:" + age;
    }

前端发送请求过来,不管是form还是x-www-form-urlencoded格式,/h接口报错,/i接口成功
/h接口:
"status": 500,
"error": "Internal Server Error",
"exception": "org.springframework.beans.BeanInstantiationException",
"message": "Failed to instantiate [java.util.List]: Specified class is an interface",
/i接口:
name:[pzx, hyy],age:18

接下来看@RequestBody的

    @RequestMapping(value = "/j", method = RequestMethod.POST)
    public String j(@RequestBody List<String> names) {
        return "name:" + names;
    }

    @RequestMapping(value = "/k", method = RequestMethod.POST)
    public String k(@RequestBody List<User> users) {
        return "users:" + users;
    }

/j
输入:
["pzx","hyy"]
输出:
name:[pzx, hyy]
/k
输入:
[
{
"name":"pzx","age":18
},
{
"name":"hyy","age":17
}
]
输出:
users:[User(name=pzx, age=18), User(name=hyy, age=17)]

Spring参数解析原理

上面介绍的主要是用法以及验证结果,但是结果为什么是这样存在很多疑惑,比如为啥加了@RequestParam就能获取List参数,为啥@RequestBody修饰的参数不能通过HttpServletRequest.getParameter()获取,但是可以通过request.getReader()流获取。
接下来就看一下Spring到底是怎么解析的!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,602评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,442评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,878评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,306评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,330评论 5 373
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,071评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,382评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,006评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,512评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,965评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,094评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,732评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,283评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,286评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,512评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,536评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,828评论 2 345

推荐阅读更多精彩内容