不灭的焱

革命尚未成功,同志仍须努力下载JDK17

作者:Albert.Wen  添加时间:2021-04-26 09:18:46  修改时间:2023-02-01 16:36:41  分类:Java框架/系统  编辑

@RequestParam

主要用于将请求参数区域的数据映射到控制层方法的参数上

首先我们需要知道@RequestParam注解主要有哪些参数

  1. value:请求中传入参数的名称,如果不设置后台接口的value值,则会默认为该变量名。比如上图中第一个参数如果不设置value="page",则前端传入的参数名必须为pageNum,否则在后台接口中pageNum将接收不到对应的数据;
  2. required:该参数是否为必传项。默认是true,表示请求中一定要传入对应的参数,否则会报404错误,如果设置为false时,当请求中没有此参数,将会默认为null,而对于基本数据类型的变量,则必须有值,这时会抛出空指针异常。如果允许空值,则接口中变量需要使用包装类来声明。
  3. defaultValue:参数的默认值,如果请求中没有同名的参数时,该变量默认为此值。注意默认值可以使用SpEL表达式,如"#{systemProperties['java.vm.version']}"

如果在请求中传入多个同名参数,比如:url?userName=zhl&userName=holley时怎么办?

其实此时传入的数据格式是:“zhl,holley”,即多个数据之间使用逗号分隔开,在后台接口中可以使用数组或者List类型的变量来接收:

public String requestparam8(@RequestParam(value="userName") String[] userNames) 
// 或者
public String requestparam8(@RequestParam(value="list") List<String> list) 

 




 

一、下面为7种服务端获取前端传过来的参数的方法 

常用的注解为:@RequestParam@RequestBody

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

/**
 * 1.直接把表单的参数写在Controller相应的方法的形参中
 * @param username
 * @param password
 * @return
 */
@RequestMapping("/addUser1")
public String addUser1(String username, String password) {
    System.out.println("username is:" + username);
    System.out.println("password is:" + password);

    return "demo/index";
}

url形式:http://localhost/SSMDemo/demo/addUser1?username=lixiaoxi&password=111111

提交的参数需要 和Controller方法中的入参名称一致。

2、通过HttpServletRequest接收,post方式和get方式都可以。

/**
 * 2.通过HttpServletRequest接收
 * @param request
 * @return
 */
@RequestMapping("/addUser2")
public String addUser2(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 "demo/index";
}

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

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

package demo.model;

public class UserModel {
    
    private String username;
    private String password;
    
    public String getUsername() {
        return username;
    }
    
    public void setUsername(String username) {
        this.username = username;
    }
    
    public String getPassword() {
        return password;
    }
    
    public void setPassword(String password) {
        this.password = password;
    }
    
}

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

/**
 * 3.通过一个bean来接收
 * @param user
 * @return
 */
@RequestMapping("/addUser3")
public String addUser3(UserModel user) {
    System.out.println("username is:" + user.getUsername());
    System.out.println("password is:" + user.getPassword());
    
    return "demo/index";
}

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

/**
 * 4.通过@PathVariable获取路径中的参数
 * @param username
 * @param password
 * @return
 */
@RequestMapping(value="/addUser4/{username}/{password}", method=RequestMethod.GET)
public String addUser4(@PathVariable String username, @PathVariable String password) {
    System.out.println("username is:" + username);
    System.out.println("password is:" + password);
    
    return "demo/index";
}

例如,访问http://localhost/SSMDemo/demo/addUser4/lixiaoxi/111111 路径时,

则自动将URL中模板变量{username}和{password}绑定到通过@PathVariable注解的同名参数上,即入参后username=lixiaoxi、password=111111。

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

Jsp表单如下:

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

Java Controller如下:

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

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

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

/**
 * 6.用注解@RequestParam绑定请求参数到方法入参
 * @param username
 * @param password
 * @return
 */
@RequestMapping(value="/addUser6", method=RequestMethod.GET)
public String addUser6(@RequestParam("username") String username, @RequestParam("password") String password) {
    System.out.println("username is:" + username);
    System.out.println("password is:" + password);
    
    return "demo/index";
}

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

/**
 * 7.用注解@Requestbody绑定请求参数到方法入参
 * @param username
 * @param password
 * @return
 */
@RequestMapping(value="/addUser6", method=RequestMethod.POST)
public String addUser6(@RequestBody UserDTO userDTO) {
    System.out.println("username is:" + userDTO.getUserName());
    System.out.println("password is:" + userDTO.getPassWord());
    return "demo/index";
}

//UserDTO 这个类为一个实体类,里面定义的属性与URL传过来的属性名一一对应。

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

本篇博文将介绍几种如何处理url中的参数的注解@PathVaribale/@RequestParam/@GetMapping。

其中,各注解的作用为:

@PathVaribale 获取url中的数据

@RequestParam 获取请求参数的值

@GetMapping 组合注解,是@RequestMapping(method = RequestMethod.GET)的缩写

@PathVaribale 获取url中的数据

看一个例子,如果我们需要获取Url=localhost:8080/hello/id中的id值,实现代码如下:

@RestController
public class HelloController {

    @RequestMapping(value="/hello/{id}", method= RequestMethod.GET)
    public String sayHello(@PathVariable("id") Integer id){
        return "id:" + id;
    }
}

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

@RestController
public class HelloController {

    @RequestMapping(value="/hello/{id}/{name}", method= RequestMethod.GET)
    public String sayHello(@PathVariable("id") Integer id, @PathVariable("name") String name) {
        return "id:" + id + " name:" + name;
    }
}

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

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

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

@RequestParam 获取请求参数的值

直接看一个例子,如下

@RestController
public class HelloController {

    @RequestMapping(value="/hello", method=RequestMethod.GET)
    public String sayHello(@RequestParam("id") Integer id) {
        return "id:" + id;
    }
}

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

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

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

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

@RestController
public class HelloController {

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

测试结果如下:

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

@RestController
public class HelloController {

    @RequestMapping(value="/hello", method= RequestMethod.GET)
    public String sayHello(@RequestParam("id") Integer id, @RequestParam("name") String name) {
        return "id:" + id + " name:" + name;
    }
}

在浏览器中的测试结果如下:

@GetMapping 组合注解

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

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

例子

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

 

 

参考:

  1. Spring Boot 三种入参
  2. Spring Boot获取前端页面参数的几种方式总结
  3. @RequestParam详解