1. 概述
在这个快速教程中,我们将探讨Spring的@RequestParam注释及其属性。
简而言之,我们可以使用@RequestParam从请求中提取查询参数,表单参数甚至文件。
2. 简单的映射
假设我们有一个端点 /api/foos,它采用一个名为 id 的查询参数:
@GetMapping("/api/foos")
@ResponseBody
public String getFoos(@RequestParam String id) {
return "ID: " + id;
}
在此示例中,我们使用 @RequestParam 来提取 id 查询参数。
一个简单的 GET 请求将调用获取:
http://localhost:8080/spring-mvc-basics/api/foos?id=abc
----
ID: abc
接下来,让我们看一下注释的属性:名称、值、必需和默认值。
3. 指定请求参数名称
在前面的示例中,变量名称和参数名称是相同的。
不过,有时我们希望这些是不同的。或者,如果我们不使用Spring Boot,我们可能需要进行特殊的编译时配置,否则参数名称实际上不会在字节码中。
幸运的是,我们可以使用 name 属性配置@RequestParam名称:
@PostMapping("/api/foos")
@ResponseBody
public String addFoo(@RequestParam(name = "id") String fooId, @RequestParam String name) {
return "ID: " + fooId + " Name: " + name;
}
我们也可以做@RequestParam(值= “id”)或只是@RequestParam(“id”)。
4. 可选请求参数
默认情况下,使用@RequestParam批注的方法参数是必需的。
这意味着,如果请求中不存在该参数,我们将收到错误:
GET /api/foos HTTP/1.1
-----
400 Bad Request
Required String parameter 'id' is not present
但是,我们可以将@RequestParam配置为可选,并具有必需的属性:
@GetMapping("/api/foos")
@ResponseBody
public String getFoos(@RequestParam(required = false) String id) {
return "ID: " + id;
}
在这种情况下,两者:
http://localhost:8080/spring-mvc-basics/api/foos?id=abc
----
ID: abc
和
http://localhost:8080/spring-mvc-basics/api/foos
----
ID: null
将正确调用该方法。
如果未指定该参数,则方法参数将绑定为 null。
4.1. 使用 Java 8 可选
或者,我们可以将参数包装在可选中:
@GetMapping("/api/foos")
@ResponseBody
public String getFoos(@RequestParam Optional<String> id){
return "ID: " + id.orElseGet(() -> "not provided");
}
在这种情况下,我们不需要指定所需的属性。
如果未提供请求参数,则将使用默认值:
http://localhost:8080/spring-mvc-basics/api/foos
----
ID: not provided
5. 请求参数的默认值
我们还可以使用默认值属性将默认值设置为@RequestParam:
@GetMapping("/api/foos")
@ResponseBody
public String getFoos(@RequestParam(defaultValue = "test") String id) {
return "ID: " + id;
}
这就像 required=false,因为用户不再需要提供参数:
http://localhost:8080/spring-mvc-basics/api/foos
----
ID: test
虽然,我们仍然可以提供它:
http://localhost:8080/spring-mvc-basics/api/foos?id=abc
----
ID: abc
请注意,当我们设置默认值属性时,“必需”确实设置为 false。
6. 映射所有参数
我们还可以使用Map来定义多个参数,而无需定义它们的名称或计数:
@PostMapping("/api/foos")
@ResponseBody
public String updateFoos(@RequestParam Map<String,String> allParams) {
return "Parameters are " + allParams.entrySet();
}
然后,这将反映发送的任何参数:
curl -X POST -F 'name=abc' -F 'id=123' http://localhost:8080/spring-mvc-basics/api/foos
-----
Parameters are {[name=abc], [id=123]}
7. 映射多值参数
单个@RequestParam可以有多个值:
@GetMapping("/api/foos")
@ResponseBody
public String getFoos(@RequestParam List<String> id) {
return "IDs are " + id;
}
春季 MVC 将映射一个逗号分隔的 id 参数:
http://localhost:8080/spring-mvc-basics/api/foos?id=1,2,3
----
IDs are [1,2,3]
或单独 id 参数的列表:
http://localhost:8080/spring-mvc-basics/api/foos?id=1&id=2
----
IDs are [1,2]
8. 结论
在本文中,我们学习了如何使用@RequestParam。
示例的完整源代码可以在 GitHub 项目中找到。