SpringBoot接收参数的七种方式
随着前后端的分离,接口方式开发成为普遍的开发形式。前端相对于后端来说,常用的接口传参方式就一定要了解和熟悉。
下面 我们梳理了常用的七种 Controller层接受参数的方式。
1、直接把请求参数写在Controller相应的方法的形参中,此场景适用于请求参数较少的情况
后端代码:
@RequestMapping("/addUser1")
public String addUser1(String username,String password) {
System.out.println("username is:"+username);
System.out.println("password is:"+password);
return "success";
}
前端传参:
url请求路径: http://localhost:8090/student/list?username=xiaom&passsword=123456
GET请求vue代码:
POST请求vue代码:
此处的RequestMapping中没有限定请求方式,那么get和post的请求方式都是可以接收的。get的请求方式我们可以直接在浏览器中输入地址,
端口可以自行在application.properties中配置,然后使用postman工具进行测试
2、封装一个bean直接来接收;我们这里使用上一个案例中封装好的User类来进行接收,同时适用get、post方法。
UserController中的代码如下:
@RequestMapping("/addUser2")
public String addUser2(User user) {
System.out.println("id is:"+user.getId());
System.out.println("username is:"+user.getUsername());
System.out.println("password is:"+user.getPassword());
return "success";
}
此时我们可以继续使用postman进行测试,注意这里传入的参数名要和User里面的属性名称一致(首字母之外的大小写保持一致,已测),否则无法识别接收,则相应的值会为null
3、通过原生的HttpServletRequest接收,同时适用get、post方法。
@RequestMapping("/addUser3")
public String addUser3(HttpServletRequest request) {
String username=request.getParameter("username");
String password=request.getParameter("password");
System.out.println("username is:"+username);
System.out.println("password is:"+password);
return "success";
}
测试方法同上,这里就不再演示。
4、通过@PathVariable获取rest风格请求路径中的参数
后端代码:
@RequestMapping(value="/addUser4/{username}/{password}")
public String addUser4(@PathVariable String username, @PathVariable String password) {
System.out.println("username is:"+username);
System.out.println("password is:"+password);
return "success";
}
前端代码:
http://127.0.0.1:8883/addUser4/xiadewang/123456
此时测试访问路径应该是rest风格的路径,如
http://127.0.0.1:8883/addUser4/xiadewang/123456
自动将URL中模板变量{username}和{password}绑定到通过@PathVariable注解的同名参数上
注意这里的参数个数一定要保持相同,否则会报404的错误。
5、使用@ModelAttribute注解请求参数,同时适用get,post
@RequestMapping(value="/addUser5")
public String addUser5(@ModelAttribute("user") User user) {
System.out.println("id is:"+user.getId());
System.out.println("username is:"+user.getUsername());
System.out.println("password is:"+user.getPassword());
return "success";
}
6、使用注解@RequestParam绑定请求参数到方法形参,同时适用get、post方法。
@RequestMapping(value="/addUser6")
public String addUser6(@RequestParam("username") String username,
@RequestParam("password") String password) {
System.out.println("username is:"+username);
System.out.println("password is:"+password);
return "success";
}
注意:当请求参数username或者password不存在时会有异常发生,可以通过设置属性required=false解决
例如:
@RequestParam(value="username", required=false)
7、JSON形式的参数: 使用注解@RequestBody绑定请求参数到方法形参,只适用post方法。
@RequestMapping(value="/addUser7")
public String addUser7(@RequestBody User user) {
System.out.println("id is:"+user.getId());
System.out.println("username is:"+user.getUsername());
System.out.println("password is:"+user.getPassword());
return "success";
}
**关于最后这个@RequestBody要重点讲解下,此时前端发送请求不能使用get方式,需要使用post方式,还有请求传递的参数需要是json字符串,这里重点要设置的是Content-Type,要将其设置为application/json。我们此时使用postman测试如下
这里如果不设置content-type的话,会报错误。**
小结
RequestBody和RequestParam同时使用的场景,代码如下
@RequestMapping(value="/addUser8")
public String addUser8(@RequestBody User user,@RequestParam("token") String token) {
System.out.println("token is:"+token);
System.out.println("id is:"+user.getId());
System.out.println("username is:"+user.getUsername());
System.out.println("password is:"+user.getPassword());
return "success";
}
token放在请求头,user放在请求体