对于最新稳定版本,请使用 Spring Framework 7.0.6spring-doc.cadn.net.cn

Model

你可以使用 @ModelAttribute 注解:spring-doc.cadn.net.cn

  • xref page 方法的方法参数上, 用于从模型中创建或访问一个对象,并通过 WebDataBinder 将其绑定到请求。spring-doc.cadn.net.cn

  • 作为 @Controller@ControllerAdvice 类中的方法级注解,用于在调用任何 @RequestMapping 方法之前初始化模型。spring-doc.cadn.net.cn

  • @RequestMapping 方法上,用于将其返回值标记为模型属性。spring-doc.cadn.net.cn

本节讨论 @ModelAttribute 方法,即前述列表中的第二项。 一个控制器可以包含任意数量的 @ModelAttribute 方法。所有这些方法都会在同一个控制器中的 @RequestMapping 方法之前被调用。@ModelAttribute 方法还可以通过 @ControllerAdvice 在多个控制器之间共享。更多详细信息,请参阅控制器通知(Controller Advice)一节。spring-doc.cadn.net.cn

@ModelAttribute 方法具有灵活的方法签名。它们支持许多与 @RequestMapping 方法相同的参数(但不包括 @ModelAttribute 本身以及任何与请求体相关的内容)。spring-doc.cadn.net.cn

以下示例使用了一个 @ModelAttribute 方法:spring-doc.cadn.net.cn

@ModelAttribute
public void populateModel(@RequestParam String number, Model model) {
	model.addAttribute(accountRepository.findAccount(number));
	// add more ...
}
@ModelAttribute
fun populateModel(@RequestParam number: String, model: Model) {
	model.addAttribute(accountRepository.findAccount(number))
	// add more ...
}

以下示例仅添加一个属性:spring-doc.cadn.net.cn

@ModelAttribute
public Account addAccount(@RequestParam String number) {
	return accountRepository.findAccount(number);
}
@ModelAttribute
fun addAccount(@RequestParam number: String): Account {
	return accountRepository.findAccount(number);
}
当未明确指定名称时,将根据类型选择一个默认名称, 如 Conventions 的 Javadoc 中所述。 您始终可以通过使用重载的 addAttribute 方法, 或通过在 @ModelAttribute 上设置 name 属性(针对返回值)来分配一个显式名称。

与 Spring MVC 不同,Spring WebFlux 明确支持模型中的响应式类型 (例如,Mono<Account>io.reactivex.Single<Account>)。这类异步模型属性可以在调用 @RequestMapping 方法时透明地解析(并更新模型)为其实际值,前提是声明的 @ModelAttribute 参数不带包装类型,如下例所示:spring-doc.cadn.net.cn

@ModelAttribute
public void addAccount(@RequestParam String number) {
    Mono<Account> accountMono = accountRepository.findAccount(number);
    model.addAttribute("account", accountMono);
}

@PostMapping("/accounts")
public String handle(@ModelAttribute Account account, BindingResult errors) {
	// ...
}
import org.springframework.ui.set

@ModelAttribute
fun addAccount(@RequestParam number: String) {
	val accountMono: Mono<Account> = accountRepository.findAccount(number)
	model["account"] = accountMono
}

@PostMapping("/accounts")
fun handle(@ModelAttribute account: Account, errors: BindingResult): String {
	// ...
}

此外,任何具有响应式类型包装器的模型属性都会在视图渲染之前被解析为其实际值(并更新模型)。spring-doc.cadn.net.cn

你也可以在 @ModelAttribute 方法上将 @RequestMapping 用作方法级别的注解,此时 @RequestMapping 方法的返回值将被解释为模型属性。通常情况下,这并不是必需的,因为在 HTML 控制器中这是默认行为,除非返回值是一个 String,否则该字符串会被解释为视图名称。@ModelAttribute 还可用于自定义模型属性的名称,如下例所示:spring-doc.cadn.net.cn

@GetMapping("/accounts/{id}")
@ModelAttribute("myAccount")
public Account handle() {
	// ...
	return account;
}
@GetMapping("/accounts/{id}")
@ModelAttribute("myAccount")
fun handle(): Account {
	// ...
	return account
}