Spring的RequestParam注释

时间:2020-02-23 14:34:39  来源:igfitidea点击:

当我们想读取controller类中的web请求参数时,将使用RequestParam注释。换句话说,前端用键向我们发送一些参数(例如从一个填充的表单)。

用例

假设我们有一个表单,其目的是向数据库中添加一个雇员。每位员工将拥有:

  • 身份证件

  • 名字

因此,我们的表单如下所示(假设ID不是自动递增的):

员工表单示例

想象一下,上面这张丑陋的表格中填写了以下信息:

  • Id=1

  • 名字=Joe

  • 姓=姓

现在假设我们有以下代码:

@Controller
@RequestMapping("/employee/*")
public class EmployeeController {
 @GetMapping("/fill")
 public String fill() {
    return "employeeForm";
 }

 @PostMapping("/fill/process")
 public String processForm(ModelMap model, @RequestParam("id") int id, @RequestParam("First Name") String firstName, @RequestParam("Last Name") String lastName) {
    model.addAttribute("id", id);
    model.addAttribute("firstName", firstName);
    model.addAttribute("lastName", lastName);
    return "index";
 }
}

我们只是将web请求参数绑定到方法参数(id,firstName,lastName)。然而,为了让这个例子起作用,我们需要从前端接收到相应的键,否则它们将为null。

在上面的示例代码中,我们为请求参数提供值,例如@RequestParam(“id”)。但是,如果目标变量名与参数名相同,则可以省略该值。所以我们可以让上面的代码片段这样工作:

@Controller
@RequestMapping("/employee/*")
public class EmployeeController {
 @GetMapping("/fill")
 public String fill() {
    return "employeeForm";
 }

 @PostMapping("/fill/process")
 public String processForm(ModelMap model, @RequestParam int id, @RequestParam("First Name") String firstName, @RequestParam("Last Name") String lastName) {
    model.addAttribute("id", id);
    model.addAttribute("firstName", firstName);
    model.addAttribute("lastName", lastName);
    return "index";
 }
}

它之所以有效,是因为“id”与我们作为方法参数给它的名称相同,实际上是“id”。另外,我们不能对其他参数做同样的处理,因为“First Name”与“firstName”不一样。

@RequestParam的必选元素

还有一个RequestParam支持的“required”元素,它几乎可以做到它所说的-它指定是否需要特定的param。对于我们的例子,我们可以说不需要名字。默认情况下,required将设置为true。

@Controller
@RequestMapping("/employee/*")
public class EmployeeController {
 @GetMapping("/fill")
 public String fill() {
    return "employeeForm";
 }

 @PostMapping("/fill/process")
 public String processForm(ModelMap model, @RequestParam int id, @RequestParam(value = "First Name", requried=false) String firstName, @RequestParam("Last Name") String lastName) {
    model.addAttribute("id", id);
    model.addAttribute("lastName", lastName);
    return "index";
 }
}

现在firstName不是一个必需的参数,因此我们没有将它添加到我们的模型/映射中。

@RequestParam还有“defaultValue”元素

如果我们需要在表单中填充一个值,但是我们并不真正关心这个值是什么,我们可以将它设置为默认值,这样如果用户没有填充它,它将只包含我们设置的任何值。请参阅以下代码片段作为参考:

@Controller
@RequestMapping("/employee/*")
public class EmployeeController {
 @GetMapping("/fill")
 public String fill() {
    return "employeeForm";
 }

 @PostMapping("/fill/process")
 public String processForm(ModelMap model, @RequestParam int id, @RequestParam(value = "First Name", requried=false) String firstName, @RequestParam(value = "Last Name", defaultValue="Doe") String lastName) {
    model.addAttribute("id", id);
    model.addAttribute("lastName", lastName);
    return "index";
 }
}

现在,即使表单没有完全填充(last name字段被用户省略),如果我们引用lastName参数,我们将其中存储“Doe”。我们为什么要使用“defaultValue”元素的一个著名例子是日期。假设我们有与上面相同的形式,但我们也有一个“日期”字段。如果用户/员工没有在这个字段中输入任何内容,我们可以假设它是今天,所以我们将把今天的日期作为默认值。这只是众多例子中的一个。