Spring中的PathVariable注释

梦里梦外; 2023-02-13 14:43 9阅读 0赞

就像@RequestParam一样，@PathVariable批注用于从HTTP request中提取数据。但是，它们略有不同。区别在于@RequestParam从URL获取参数，而@PathVariable只是从URI中提取参数。

### 例子 ###

让我们假设你有一个以下 URL 的网站:

http://www.yourwebsite.net/employee/1

上面 URL 中的1表示雇员的 ID。 到目前为止一切ok。 但是现在，从 Spring 控制器看，路径看起来是这样的(取决于您给 id 的名称) :

/employee/{id}

上面的 URL 路径对我们有什么帮助？ 因为这个\{\}语法(碰巧被称为 URI 模板) ，你现在可以把它传递给一个使用@pathvariable 的方法，你的方法和注释看起来如下所示:

@RequestMapping(value="/employee/{id}", method=RequestMethod.GET)
    <Access Modifier> <Return Type> <Method Name> (@PathVariable <Type> id) {  <body> }

从上面的代码片段可以看到，现在“ id”将从路径中引用\{ id \}。 让我们用一个真实的例子来尝试:

@Controller
    @SpringBootApplication
    public class EmployeeManager { 
       @RequestMapping(value=" /employee/{id}")
       public String pathVariableDemo(Model model, @PathVariable int id) { 
          model.addAttribute("id", id);
          return "demo";
       }
    }

现在，Spring查看输出id参数，并将其与模板变量“ id”进行匹配。

请记住，如果我的代码使用“ id”(参数)命名为其他名称，那么它将无法工作。 然而，如果你不想对参数和模板变量使用相同的名字，你可以像这样命名 PathVariable 注释的名字：

@Controller
    @SpringBootApplication
    public class EmployeeManager { 
       @RequestMapping(value=" /employee/{id}")
       public String pathVariableDemo(Model model, @PathVariable("id") int someRandomName) { 
          model.addAttribute("id", someRandomName);
          return "demo";
       }
    }

从上面的示例中可以看到，我将参数的名称更改为 \_someRandomName，\_但还添加了@PathVariable **（“ id”）**，它再次指定了我们要引用的模板变量。

最终您有两个选择：

1.  为方法参数使用相同的名称
2.  在@PathVariable批注中指定模板变量的名称

### 多个@PathVariable批注 ###

如果你可以有多个@pathvariable 会怎么样？ 我们能做到吗？ 是的，我们可以！ 事实上，这和添加一个@pathvariable 非常相似。

我们来演示一下：

@Controller
    @SpringBootApplication
    public class EmployeeManager { 
       @RequestMapping(value="/{company}/employee/{id}", method=RequestMethod.GET)
       public String pathVariableDemo(@PathVariable("company") String companyName, @PathVariable("id") int employeeId) { 
          // handle the code
          return "demo";
       }
    }

从上面的代码片段中可以看到，我们有两个模板变量：

1.  **company**
2.  **id**

然后，我们提取每个模板变量，然后通过指定方法参数所引用的临时变量将它们“分配”给方法参数。

## @PathVariable vs @RequestParam结论 ##

尽管@PathVariable和@RequestParam都用于从URL提取值，但是可以根据URL的设计使用它们。

通常，@PathVariable通常用于RESTful Web服务中，而@RequestParam用于从查询参数中提取数据。