Coding ManSpring 中的@RequestParam注解
1.概述
在这个快速教程中，我们将探索 Spring 的*@RequestParam注解及其属性。 *简单来说，我们可以使用@RequestParam从请求中提取查询参数、表单参数，甚至是文件。**
2. 一个简单的映射
假设我们有一个端点*/api/foos*接受一个名为 id的查询参数：
@GetMapping("/api/foos")
@ResponseBody
public String getFoos(@RequestParam String id) {
return "ID: " + id;
}
在此示例中，我们使用*@RequestParam来提取id*查询参数。
一个简单的 GET 请求会调用getFoos：
http://localhost:8080/spring-mvc-basics/api/foos?id=abc
----
ID: abc
接下来，让我们看一下注解的属性：name、 value、required和defaultValue。
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(value = “id”)或只是@RequestParam(“id”)。
4. 可选请求参数
默认情况下需要使用*@RequestParam*注解的方法参数 。 这意味着如果请求中不存在参数，我们将收到错误：
## GET /api/foos HTTP/1.1
400 Bad Request
Required String parameter 'id' is not present
不过，我们可以使用required属性将@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 Optional
或者，我们可以将参数包装在Optional *中：
@GetMapping("/api/foos")
@ResponseBody
public String getFoos(@RequestParam Optional<String> id){
return "ID: " + id.orElseGet(() -> "not provided");
}
在这种情况下，我们不需要指定required属性。 如果未提供请求参数，将使用默认值：
http://localhost:8080/spring-mvc-basics/api/foos
----
ID: not provided
5. 请求参数的默认值
我们还可以 使用defaultValue属性为*@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
请注意，当我们设置 defaultValue属性时， required确实设置为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;
}
Spring 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]