@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>,且註解中未指定參數名稱時,則會使用每個給定參數名稱的請求參數值來填入映射。以下範例示範如何使用表單資料處理執行此操作

  • 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 註解。