基于SpringMVC对接前端参数注解
作者:夜白宋
一、请求方式
HTTP/1.1 协议规定的 HTTP 请求方法有 OPTIONS、GET、HEAD、POST、PUT、DELETE、TRACE、CONNECT这几种。
其中 POST 一般用来向服务端提交数据,GET/HEAD请求虽然可以携带请求体,但是在实际浏览器是不被规范允许的,所以需要注意
HTTP 协议是以 ASCII 码传输。他是建立在 TCP/IP 协议之上的应用层规范,
规定HTTP 请求分为三个部分:
- 状态行
- headers 请求头
- entity-body 消息主体
类似于下面这样:
<method> <request-URL> <version> <headers> <entity-body>
二、参数格式
值 | 描述 |
---|---|
application/x-www-form-urlencoded | 在发送前编码所有字符(默认) |
multipart/form-data | 不对字符编码。在使用包含文件上传控件的表单时,必须使用该值。 |
application/json | 作为请求头告诉服务端消息主体是序列化的JSON字符串。除低版本的IE,基本都支持。 |
text/plain | 空格转换为 “+” 加号,但不对特殊字符编码。 |
三、注解描述
1. @RequestParam
将请求参数绑定到你控制器的方法参数上(是springmvc中接收普通参数的注解),主要是从url中解析对应的参数名,并绑定对应值,默认值为hello
语法:
@RequestParam(value=”参数名”,required=”true/false”,defaultValue=””)
value
:参数名required
:是否包含该参数,默认为true,表示该请求路径中必须包含该参数,如果不包含就报错。defaultValue
:默认参数值,如果设置了该值,required=true将失效,自动为false,如果没有传该参数,就使用默认值
2. @RequestBody
主要用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的),使用@RequestBody接收数据时,一般都用POST方式进行提交。
注:@RequestBody与@RequestParam()可以同时使用,@RequestBody最多只能有一个,而@RequestParam()可以有多个。
注:一个请求,只有一个RequestBody;一个请求,可以有多个RequestParam。
注:当同时使用@RequestParam和@RequestBody时,@RequestParam指定的参数可以是普通元素、数组、集合、对象等等(即:当,@RequestBody 与@RequestParam可以同时使用时,原SpringMVC接收参数的机制不变,只不过RequestBody 接收的是请求体里面的JSON数据;而RequestParam接收的是key-value里面的参数,所以它会被切面进行处理从而可以用普通元素、数组、集合、对象等接收。即:如果参数时放在请求体中,application/json传入后台的话,那么后台要用@RequestBody才能接收到;如果不是放在请求体中的话,那么后台接收前台传过来的参数时,要用@RequestParam来接收,或则形参前 什么也不写也能接收。
注:如果参数前写了@RequestParam(xxx),那么前端必须有对应的xxx名字才行(不管其是否有值,当然可以通过设置该注解的required属性来调节是否必须传),如果没有xxx名的话,那么请求会出错,报400。
注:如果参数前不写@RequestParam(xxx)的话,那么就前端可以有可以没有对应的xxx名字才行,如果有xxx名的话,那么就会自动匹配;没有的话,请求也能正确发送。
追注:这里与feign消费服务时不同;feign消费服务时,如果参数前什么也不写,那么会被默认是@RequestBody的。
四、实际调用
1.Get请求
1.1 普通元素传参
前端请求
后端接收入参:
@GetMapping("/testPrint") public void testPrint1(String name) { System.out.println("testPrint1: " + name); } 或 @GetMapping("/testPrint") public void testPrint2(@RequestParam("name") String name) { System.out.println("testPrint2: " + name); }
1.2 数组传参
前端请求
后端接收入参:
@GetMapping("/testPrint1") public void testPrint1(String[] name) { System.out.println("testPrint1: " + JSON.toJSONString(name)); } 或 @GetMapping("/testPrint2") public void testPrint2(@RequestParam("name") String[] name) { System.out.println("testPrint2: " + JSON.toJSONString(name)); }
2.Post请求
2.1 application/x-www-form-urlencoded请求传参
前端请求类型
后端接收入参:
@PostMapping("/testPrint1") public void testPrint1(Bb bb) { System.out.println("testPrint1: " + JSON.toJSONString(bb)); }
此处一定要注意不能使用@RequestBody,否则就会抛出415错误, “Unsupported Media Type”,
2.2 application/json请求传参
前端请求类型
后端接收入参:
@PostMapping("/testPrint2") public void testPrint2(@RequestBody Bb bb) { System.out.println("testPrint2: " + JSON.toJSONString(bb)); }
此处一定要使用@RequestBody,否则无法解析JSON数据
总结
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。