@RequestParam

查看 Servlet 栈中的等效内容

你可以使用 @RequestParam 注解将查询参数绑定到控制器中的方法参数。以下代码片段展示了其用法

  • 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。 
import org.springframework.ui.set

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

	// ...

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

	// ...
}
1 使用 @RequestParam。
Servlet API 的“request parameter”概念将查询参数、表单数据和 Multipart 合并为一个。然而，在 WebFlux 中，每个都是通过 ServerWebExchange 单独访问的。虽然 @RequestParam 只绑定到查询参数，但你可以使用数据绑定将查询参数、表单数据和 Multipart 应用到命令对象。

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

如果目标方法参数类型不是 String，将自动应用类型转换。参见类型转换。

当 @RequestParam 注解声明在 Map<String, String> 或 MultiValueMap<String, String> 参数上时，Map 将填充所有查询参数。

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