模型

查看在Servlet堆栈中的等效内容

您可以使用@ModelAttribute注解：

  • 在@RequestMapping方法中的方法参数上，通过WebDataBinder创建或访问模型中的对象，并将其绑定到请求中。

  • 作为@Controller或@ControllerAdvice类中的方法级注解，在任何@RequestMapping方法调用之前初始化模型。

  • 在@RequestMapping方法上，将其返回值标记为模型属性。

本节讨论@ModelAttribute方法，即前述列表中的第二项。一个控制器可以有任意数量的@ModelAttribute方法。所有这些方法在同一控制器中的@RequestMapping方法之前被调用。一个@ModelAttribute方法也可以通过@ControllerAdvice在多个控制器之间共享。有关更多详细信息，请参阅Controller Advice部分。

@ModelAttribute方法具有灵活的方法签名。它们支持许多与@RequestMapping方法相同的参数（除了@ModelAttribute本身和与请求体相关的任何内容）。

以下示例使用了@ModelAttribute方法：

  • Java

  • Kotlin

@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 ...
}

以下示例仅添加一个属性：

  • Java

  • Kotlin

@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的名称属性（对于返回值）来分配显式名称。

与Spring MVC不同，Spring WebFlux明确支持模型中的响应式类型（例如Mono<Account>或io.reactivex.Single<Account>）。这种异步模型属性可以在@RequestMapping调用时透明地解析（并更新模型）为其实际值，前提是声明了一个没有包装器的@ModelAttribute参数，如下例所示：

  • Java

  • Kotlin

@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 {
	// ...
}

此外，任何具有响应式类型包装器的模型属性都会在视图渲染之前解析为其实际值（并更新模型）。

您还可以将@ModelAttribute用作@RequestMapping方法上的方法级注解，在这种情况下，@RequestMapping方法的返回值将被解释为模型属性。这通常不是必需的，在HTML控制器中是默认行为，除非返回值是一个String，否则将被解释为视图名称。如下例所示，@ModelAttribute还可以帮助自定义模型属性名称：

  • Java

  • Kotlin

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