@RequestParam

您可以使用 @RequestParam 注解将 Servlet 请求参数(即查询参数或表单数据)绑定到控制器中的方法参数。

以下示例展示了如何实现

  • Java

  • Kotlin

@Controller
@RequestMapping("/pets")
public class EditPetForm {

	// ...

	@GetMapping
	public String setupForm(@RequestParam("petId") int petId, Model model) { (1)
		Pet pet = this.clinic.loadPet(petId);
		model.addAttribute("pet", pet);
		return "petForm";
	}

	// ...

}
1 使用 @RequestParam 绑定 petId
import org.springframework.ui.set

@Controller
@RequestMapping("/pets")
class EditPetForm {

	// ...

	@GetMapping
	fun setupForm(@RequestParam("petId") petId: Int, model: Model): String { (1)
		val pet = this.clinic.loadPet(petId);
		model["pet"] = pet
		return "petForm"
	}

	// ...

}
1 使用 @RequestParam 绑定 petId

默认情况下,使用此注解的方法参数是必需的,但您可以通过将 @RequestParam 注解的 required 标志设置为 false 或通过使用 java.util.Optional 包装器声明参数来指定方法参数是可选的。

如果目标方法参数类型不是 String,则会自动应用类型转换。请参见类型转换

将参数类型声明为数组或列表允许解析相同参数名称的多个参数值。

@RequestParam 注解被声明为 Map<String, String>MultiValueMap<String, String>,且未在注解中指定参数名时,Map 将填充每个给定参数名的请求参数值。以下示例展示了如何使用表单数据处理来实现这一点

  • Java

  • Kotlin

@Controller
@RequestMapping("/pets")
class EditPetForm {

	// ...

	@PostMapping(path = "/process", consumes = MediaType.APPLICATION_FORM_URLENCODED_VALUE)
	public String processForm(@RequestParam MultiValueMap<String, String> params) {
		// ...
	}

	// ...
}
@Controller
@RequestMapping("/pets")
class EditPetForm {

	// ...

	@PostMapping("/process", consumes = [MediaType.APPLICATION_FORM_URLENCODED_VALUE])
	fun processForm(@RequestParam params: MultiValueMap<String, String>): String {
		// ...
	}

	// ...

}

请注意,@RequestParam 的使用是可选的(例如,用于设置其属性)。默认情况下,任何简单值类型(由BeanUtils#isSimpleProperty确定)且未被任何其他参数解析器解析的参数,都被视为已使用 @RequestParam 注解。