Springboot从URL请求中获取参数的几种方法总结

Posted by 2025年2月5日 in Java

7种服务端获取前端传过来的参数的方法

常用的方法为：@RequestParam和@RequestBody

直接把表单的参数写在Controller相应的方法的形参中，适用于get方式提交，不适用于post方式提交

 1     /**
 2      * 1.直接把表单的参数写在Controller相应的方法的形参中
 3       * @param username
 4      * @param password
 5      * @return
 6      */
 7     @RequestMapping("/addUser1")
 8     public String addUser1(String username,String password) {
 9         System.out.println("username is:"+username);
10         System.out.println("password is:"+password);
11         return "demo/index";
12     }

url形式：http://localhost/SSMDemo/demo/addUser1?username=lixiaoxi&password=111111 提交的参数需要和Controller方法中的入参名称一致。

通过HttpServletRequest接收，post方式和get方式都可以

 1     /**
 2      * 2、通过HttpServletRequest接收
 3       * @param request
 4      * @return
 5      */
 6     @RequestMapping("/addUser2")
 7     public String addUser2(HttpServletRequest request) {
 8         String username=request.getParameter("username");
 9         String password=request.getParameter("password");
10         System.out.println("username is:"+username);
11         System.out.println("password is:"+password);
12         return "demo/index";
13     }

通过一个bean来接收,post方式和get方式都可以

(1)建立一个和表单中参数对应的bean

 1 package demo.model;
 2 
 3 public class UserModel {
 4     
 5     private String username;
 6     private String password;
 7     public String getUsername() {
 8         return username;
 9     }
10     public void setUsername(String username) {
11         this.username = username;
12     }
13     public String getPassword() {
14         return password;
15     }
16     public void setPassword(String password) {
17         this.password = password;
18     }
19 }

(2)用这个bean来封装接收的参数

 1     /**
 2      * 3、通过一个bean来接收
 3       * @param user
 4      * @return
 5      */
 6     @RequestMapping("/addUser3")
 7     public String addUser3(UserModel user) {
 8         System.out.println("username is:"+user.getUsername());
 9         System.out.println("password is:"+user.getPassword());
10         return "demo/index";
11     }

通过@PathVariable获取路径中的参数

 1     /**
 2      * 4、通过@PathVariable获取路径中的参数
 3       * @param username
 4      * @param password
 5      * @return
 6      */
 7     @RequestMapping(value="/addUser4/{username}/{password}",method=RequestMethod.GET)
 8 public String addUser4(@PathVariable String username,@PathVariable String password) {
 9         System.out.println("username is:"+username);
10         System.out.println("password is:"+password);
11         return "demo/index";
12     }

例如，访问http://localhost/SSMDemo/demo/addUser4/lixiaoxi/111111 路径时，则自动将URL中模板变量{username}和{password}绑定到通过@PathVariable注解的同名参数上，即入参后username=lixiaoxi、password=111111。

使用@ModelAttribute注解获取POST请求的FORM表单数据

Jsp表单如下：

1 <form action ="<%=request.getContextPath()%>/demo/addUser5" method="post"> 
2      用户名:&nbsp;<input type="text" name="username"/><br/>
3      密&nbsp;&nbsp;码:&nbsp;<input type="password" name="password"/><br/>
4      <input type="submit" value="提交"/> 
5      <input type="reset" value="重置"/> 
6 </form>

Java Controller如下：

 1     /**
 2      * 5、使用@ModelAttribute注解获取POST请求的FORM表单数据
 3       * @param user
 4      * @return
 5      */
 6     @RequestMapping(value="/addUser5",method=RequestMethod.POST)
 7     public String addUser5(@ModelAttribute("user") UserModel user) {
 8         System.out.println("username is:"+user.getUsername());
 9         System.out.println("password is:"+user.getPassword());
10         return "demo/index";
11     }

用注解@RequestParam绑定请求参数到方法入参

当请求参数username不存在时会有异常发生,可以通过设置属性required=false解决,例如: @RequestParam(value=”username”, required=false)

 1     /**
 2      * 6、用注解@RequestParam绑定请求参数到方法入参
 3       * @param username
 4      * @param password
 5      * @return
 6      */
 7     @RequestMapping(value="/addUser6",method=RequestMethod.GET)
 8     public String addUser6(@RequestParam("username") String username,@RequestParam("password") String password) {
 9         System.out.println("username is:"+username);
10         System.out.println("password is:"+password);
11         return "demo/index";
12     }

用注解@RequestBody绑定请求参数到方法入参 用于POST请求

 1 /**
 2      * 7、用注解@Requestbody绑定请求参数到方法入参
 3       * @param username
 4      * @param password
 5      * @return
 6      */
 7     @RequestMapping(value="/addUser6",method=RequestMethod.POST)
 8     public String addUser6(@RequestBody UserDTO userDTO) {
 9         System.out.println("username is:"+userDTO.getUserName());
10         System.out.println("password is:"+userDTO.getPassWord());
11         return "demo/index";
12     }
13 
14 //UserDTO 这个类为一个实体类，里面定义的属性与URL传过来的属性名一一对应。

上面为7种服务端获取前端传过来的参数的方法。

spring boot的@RequestParam和@RequestBody的区别

由于项目是前后端分离，因此后台使用的是spring boot，做成微服务，只暴露接口。接口设计风格为restful的风格，在get请求下，后台接收参数的注解为RequestBody时会报错；在 post请求下，后台接收参数的注解为RequestParam时也会报错。 由于spring的RequestParam注解接收的参数是来自于requestHeader中，即请求头，也就是在url中，格式为xxx?username=123&password=456，而RequestBody注解接收的参数则是来自于requestBody中，即请求体中。 因此综上所述，如果为get请求时，后台接收参数的注解应该为RequestParam，如果为post请求时，则后台接收参数的注解就是为RequestBody。附上两个例子，截图如下：

SpringBoot 中常用注解@PathVaribale/@RequestParam/@GetMapping介绍

处理url中的参数的注解

  • @PathVaribale
  • @RequestParam
  • @GetMapping。

其中，各注解的作用为：

  • @PathVaribale 获取url中的数据
  • @RequestParam 获取请求参数的值
  • @GetMapping 组合注解，是@RequestMapping(method = RequestMethod.GET)的缩写

@PathVaribale 获取url中的数据 看一个例子，如果我们需要获取Url=localhost:8080/hello/id中的id值，实现代码如下：

1 @RestController
2 public class HelloController {
3 
4     @RequestMapping(value="/hello/{id}",method= RequestMethod.GET)
5     public String sayHello(@PathVariable("id") Integer id){
6         return "id:"+id;
7     }
8 }

同样，如果我们需要在url有多个参数需要获取，则如下代码所示来做就可以了。

1 @RestController
2 public class HelloController {
3 
4     @RequestMapping(value="/hello/{id}/{name}",method= RequestMethod.GET)
5     public String sayHello(@PathVariable("id") Integer id,@PathVariable("name") String name){
6         return "id:"+id+" name:"+name;
7     }
8 }

以上，通过@PathVariable注解来获取URL中的参数时的前提条件是我们知道url的格式时怎么样的。

只有知道url的格式，我们才能在指定的方法上通过相同的格式获取相应位置的参数值。

一般情况下，url的格式为：localhost:8080/hello?id=98,这种情况下该如何来获取其id值呢,这就需要借助于@RequestParam来完成了

@RequestParam 获取请求参数的值 直接看一个例子，如下

1 @RestController
2 public class HelloController {
3 
4     @RequestMapping(value="/hello",method= RequestMethod.GET)
5     public String sayHello(@RequestParam("id") Integer id){
6         return "id:"+id;
7     }
8 }

在浏览器中输入地址：localhost:8080/hello?id=1000，可以看到如下的结果：

当我们在浏览器中输入地址：localhost:8080/hello?id ,即不输入id的具体值，此时返回的结果为null。具体测试结果如下：

但是，当我们在浏览器中输入地址：localhost:8080/hello ,即不输入id参数，则会报如下错误：

@RequestParam注解给我们提供了这种解决方案，即允许用户不输入id时，使用默认值，具体代码如下：

1 @RestController
2 public class HelloController {
3     @RequestMapping(value="/hello",method= RequestMethod.GET)
4     //required=false 表示url中可以不穿入id参数，此时就使用默认参数
5     public String sayHello(@RequestParam(value="id",required = false,defaultValue = "1") Integer id){
6         return "id:"+id;
7     }
8 }

如果在url中有多个参数，即类似于localhost:8080/hello?id=98&&name=wojiushimogui这样的url，同样可以这样来处理。具体代码如下：

 1 /**
 2  * Created by wuranghao on 2017/4/7.
 3  */
 4 @RestController
 5 public class HelloController {
 6 
 7     @RequestMapping(value="/hello",method= RequestMethod.GET)
 8     public String sayHello(@RequestParam("id") Integer id,@RequestParam("name") String name){
 9         return "id:"+id+ " name:"+name;
10     }
11 }

@GetMapping 组合注解 @GetMapping是一个组合注解，是@RequestMapping(method = RequestMethod.GET)的缩写。该注解将HTTP Get 映射到 特定的处理方法上。

即可以使用@GetMapping(value = “/hello”)来代替@RequestMapping(value=”/hello”,method= RequestMethod.GET)。即可以让我们精简代码。

例子

1 @RestController
2 public class HelloController {
3     //@RequestMapping(value="/hello",method= RequestMethod.GET)
4     @GetMapping(value = "/hello")
5     //required=false 表示url中可以不穿入id参数，此时就使用默认参数
6     public String sayHello(@RequestParam(value="id",required = false,defaultValue = "1") Integer id){
7         return "id:"+id;
8     }

You May Also Like

No Picture

Java开发中(PO,VO,TO,BO,DAO,POJO)解释

No Picture

阿里开源工具Arthas实践

About the Author: 一块自由的砖

码农一个，一块自由勤恳的砖，哪里需要哪里搬！(￣▽￣)"