Spring @RequestParam与@PathVariable注释

╰半夏微凉° 2023-09-25 12:16 67阅读 0赞

### **1. 概述** ###

在这个快速教程中，我们将探讨Spring[的@RequestParam][RequestParam]和*@PathVariable*注释之间的差异。

*@RequestParam*和*@PathVariable*都可用于从请求 URI 中提取值，但它们略有不同。

### **2. 查询参数与 URI 路径** ###

**从查询字符串*@RequestParam*s 个数据提取值时，*@PathVariable*从 URI 路径中提取数据提取值**：

@GetMapping("/foos/{id}")
    @ResponseBody
    public String getFooById(@PathVariable String id) {
        return "ID: " + id;
    }Copy

然后我们可以根据路径进行映射：

http://localhost:8080/spring-mvc-basics/foos/abc
    ----
    ID: abcCopy

*对于@RequestParam*，它将是：

@GetMapping("/foos")
    @ResponseBody
    public String getFooByIdUsingQueryParam(@RequestParam String id) {
        return "ID: " + id;
    }Copy

这将给我们相同的响应，只是一个不同的URI：

http://localhost:8080/spring-mvc-basics/foos?id=abc
    ----
    ID: abcCopy

### **3. 编码值与精确值** ###

由于*@PathVariable*从 URI 路径中提取值，因此未对其进行编码。另一方面，*@RequestParam*是编码的。

使用前面的示例，*ab+c* 将按原样返回：

http://localhost:8080/spring-mvc-basics/foos/ab+c
    ----
    ID: ab+cCopy

**但对于*@RequestParam*请求，参数是 URL 解码的**：

http://localhost:8080/spring-mvc-basics/foos?id=ab+c
    ----
    ID: ab cCopy

### **4. 可选值** ###

***@RequestParam*和*@PathVariable*都可以是可选的。**

我们可以从Spring 4.3.3开始使用*所需的*属性使*@PathVariable*可选：

@GetMapping({"/myfoos/optional", "/myfoos/optional/{id}"})
    @ResponseBody
    public String getFooByOptionalId(@PathVariable(required = false) String id){
        return "ID: " + id;
    }Copy

然后我们可以做以下两件事之一：

http://localhost:8080/spring-mvc-basics/myfoos/optional/abc
    ----
    ID: abc
    Copy

艺术

http://localhost:8080/spring-mvc-basics/myfoos/optional
    ----
    ID: nullCopy

对于*@RequestParam*，我们还可以使用[所需的][Link 1]属性。

请注意，**在使*@PathVariable*可选时，我们应该小心，以避免路径冲突。**

### **5. 结论** ###

在本文中，我们了解了*@RequestParam*和*@PathVariable*之间的差异。

示例的完整源代码可以在 [GitHub 上][GitHub]找到。

[RequestParam]: https://www.baeldung.com/spring-request-param
[Link 1]: https://www.baeldung.com/spring-request-param#making-an-optional-request-parameter
[GitHub]: https://github.com/eugenp/tutorials/tree/master/spring-web-modules/spring-mvc-basics-5