利用 Spring Boot 来制作 Web 应用,就必定会涉及到前端与后台之间互相传递参数。下面演示 Controller 如何接收以 GET 方式传递过来的参数。

GET 请求不存在请求实体部分,键值对参数放置在 URL 尾部,因此请求头不需要设置 Content-Type 字段

1.参数直接在路径中(restful风格)

假设请求地址是如下这种 RESTful 风格,jumper 这个参数值直接放在路径里面:

http://localhost:8080/hello/jumper

Controller 可以这么获取该参数:

@GetMapping("/hello/{id}")
public String hello(@PathVariable("id") String name){
    System.out.println(name);
    return name;
}

controller get java 请求参数不必填 controller获取get请求参数_spring

2.参数跟在 ? 号后面

2.1 获取参数的基本方法

假设请求地址是如下这种传统方式,参数跟在问号后面:

http://localhost:8080/hello?name=jumper

Controller 可以这么获取该参数:

2.1.1 没有注解

@GetMapping("/hello")
public String hello(String name){
    System.out.println(name);
    return name;
}
情况1

controller get java 请求参数不必填 controller获取get请求参数_spring_02


后台

controller get java 请求参数不必填 controller获取get请求参数_User_03

情况2

controller get java 请求参数不必填 controller获取get请求参数_User_04


后台

controller get java 请求参数不必填 controller获取get请求参数_User_05

小结

=号前参数需要和方法传入参数名相同,否则为空
传入类型和方法参数类型不匹配时会报错

2.1.2 有注解

@GetMapping("/hello")
public String hello(@RequestParam String name){
    System.out.println(name);
    return ""+name;
}
参数匹配

controller get java 请求参数不必填 controller获取get请求参数_System_06


后台:

controller get java 请求参数不必填 controller获取get请求参数_User_07

参数不匹配

controller get java 请求参数不必填 controller获取get请求参数_User_08


后台:

controller get java 请求参数不必填 controller获取get请求参数_System_09

2.1.3 指定参数

@GetMapping("/hello")
public String hello(@RequestParam("id") String name){
    System.out.println(name);
    return ""+name;
}

controller get java 请求参数不必填 controller获取get请求参数_User_10


参数不匹配也会报错

2.1.4 允许空值

@GetMapping("/hello")
public String hello(@RequestParam(name = "id",required = false) String name){
    System.out.println(name);
    return ""+name;
}

不会报错传入为空

controller get java 请求参数不必填 controller获取get请求参数_User_11

2.1.5 指定默认值

当没有传递参数时自动使用默认值

@GetMapping("/hello")
public String hello(@RequestParam(name = "id",defaultValue = "lili") String name){
    System.out.println(name);
    return ""+name;
}

controller get java 请求参数不必填 controller获取get请求参数_System_12

2.2 获取多个参数

@GetMapping("/hello")
public String hello(String name, Integer age) {
    System.out.println(name + ":" + age);
    return "" + name + ":" + age;
}

根据参数名自动匹配方法参数名

controller get java 请求参数不必填 controller获取get请求参数_spring_13

参数名不匹配

controller get java 请求参数不必填 controller获取get请求参数_传递参数_14

其他情况如同上面

controller get java 请求参数不必填 controller获取get请求参数_spring_15

2.3 使用 map 来接收参数

Controller 还可以直接使用 map 来接收所有的请求参数:

@GetMapping("/hello")
public String hello(@RequestParam Map<String, Object> params) {
    String str = "name:" + params.get("name") + " age:" + params.get("age");
    System.out.println(str);
    return str;
}

controller get java 请求参数不必填 controller获取get请求参数_User_16


如果没有@RequestParam注解则无法接收

controller get java 请求参数不必填 controller获取get请求参数_spring_17

2.4 接收一个数组

@GetMapping("/hello")
public String hello(Integer[] age) {
    String str = "";
    for (Integer i : age) {
        str = str + i + "-";
    }
    return str;
}

controller get java 请求参数不必填 controller获取get请求参数_传递参数_18

2.5 使用对象来接收参数

2.5.1 基本用法

如果一个 get 请求的参数太多,我们构造一个对象来简化参数的接收方式:

@GetMapping("/hello")
public String hello(User user) {
    System.out.println(user);
    return user.toString();
}

User类:
可以直接将多个参数通过 getter、setter 方法注入到对象中去:

package com.jumper.demo.pojo;

public class User {
    private String name;
    private Integer age;

    public User(String name, Integer age) {
        this.name = name;
        this.age = age;
    }

    public User() {
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

controller get java 请求参数不必填 controller获取get请求参数_System_19

2.5.2 指定参数前缀

如果传递的参数有前缀,那么参数无法正常传递: 我们可以结合 @InitBinder 解决这个问题,通过参数预处理来指定使用的前缀为 u.
具体可看 https://www.hangge.com/blog/cache/detail_2483.html

@GetMapping("/hello")
public String hello(@ModelAttribute("u") User user) {
    System.out.println(user);
    return user.toString();
}

@InitBinder("u")
private void initBinder(WebDataBinder binder){
    binder.setFieldDefaultPrefix("u.");
}

重启程序可以看到参数以及成功接收了:

controller get java 请求参数不必填 controller获取get请求参数_User_20

2.5.3 构造多个对象来接收参数

如果一个 get 请求的参数分属不同的对象,也可以使用多个对象来接收参数:

@GetMapping("/hello")
public String hello(User user, Phone phone) {
    System.out.println(user + ":" + phone);
    return user + ":" + phone;
}

Phone 类定义如下:

public class Phone {
    private String number;

    public String getNumber() {
        return number;
    }

    public void setNumber(String number) {
        this.number = number;
    }

    public Phone() {
    }

    @Override
    public String toString() {
        return "Phone{" +
                "number='" + number + '\'' +
                '}';
    }

    public Phone(String number) {
        this.number = number;
    }
}

结果:

controller get java 请求参数不必填 controller获取get请求参数_System_21