`@ModelAttribute`

@ModelAttribute方法参数注解将请求参数绑定到模型对象上。例如：

Java
Kotlin

@PostMapping("/owners/{ownerId}/pets/{petId}/edit")
public String processSubmit(@ModelAttribute Pet pet) { } (1)

1	绑定到一个`Pet`实例。

@PostMapping("/owners/{ownerId}/pets/{petId}/edit")
fun processSubmit(@ModelAttribute pet: Pet): String { } (1)

1	绑定到一个`Pet`实例。

Pet实例可能是：

可以从模型中访问，可能是通过Model添加的。
如果模型属性在类级别的@SessionAttributes中列出，则可以从HTTP会话中访问。
通过默认构造函数实例化。
通过与Servlet请求参数匹配的“主构造函数”实例化。参数名称是通过字节码中保留的运行时参数名称确定的。

默认情况下，构造函数和属性数据绑定都会被应用。然而，模型对象设计需要仔细考虑，出于安全原因，建议要么使用专门为Web绑定设计的对象，要么仅应用构造函数绑定。如果仍然必须使用属性绑定，则应设置allowedFields模式以限制可以设置的属性。有关此内容和示例配置的更多详细信息，请参阅模型设计。

在使用构造函数绑定时，您可以通过@BindParam注解自定义请求参数名称。例如：

Java
Kotlin

class Account {

    private final String firstName;

	public Account(@BindParam("first-name") String firstName) {
		this.firstName = firstName;
	}
}

class Account(@BindParam("first-name") val firstName: String)

可以将@BindParam放置在与构造函数参数对应的字段上。虽然@BindParam是开箱即用的，但您也可以通过在DataBinder上设置DataBinder.NameResolver来使用不同的注解

与Spring MVC不同，WebFlux支持模型中的响应式类型，例如Mono<Account>。您可以声明带有或不带有响应式类型包装器的@ModelAttribute参数，并且它将根据实际值相应解析。

如果数据绑定导致错误，默认情况下会引发WebExchangeBindException，但您还可以在@ModelAttribute旁边立即添加一个BindingResult参数来处理控制器方法中的此类错误。例如：

Java
Kotlin

@PostMapping("/owners/{ownerId}/pets/{petId}/edit")
public String processSubmit(@ModelAttribute("pet") Pet pet, BindingResult result) { (1)
	if (result.hasErrors()) {
		return "petForm";
	}
	// ...
}

1	添加一个`BindingResult`。

@PostMapping("/owners/{ownerId}/pets/{petId}/edit")
fun processSubmit(@ModelAttribute("pet") pet: Pet, result: BindingResult): String { (1)
	if (result.hasErrors()) {
		return "petForm"
	}
	// ...
}

1	添加一个`BindingResult`。

要使用BindingResult参数，必须在没有响应式类型包装器的情况下在其前面声明@ModelAttribute参数。如果要使用响应式类型，可以直接通过它处理错误。例如：

Java
Kotlin

@PostMapping("/owners/{ownerId}/pets/{petId}/edit")
public Mono<String> processSubmit(@Valid @ModelAttribute("pet") Mono<Pet> petMono) {
	return petMono
		.flatMap(pet -> {
			// ...
		})
		.onErrorResume(ex -> {
			// ...
		});
}

@PostMapping("/owners/{ownerId}/pets/{petId}/edit")
fun processSubmit(@Valid @ModelAttribute("pet") petMono: Mono<Pet>): Mono<String> {
	return petMono
			.flatMap { pet ->
				// ...
			}
			.onErrorResume{ ex ->
				// ...
			}
}

在数据绑定后，您可以通过添加jakarta.validation.Valid注解或Spring的@Validated注解自动应用验证（请参阅Bean验证和Spring验证）。例如：

Java
Kotlin

@PostMapping("/owners/{ownerId}/pets/{petId}/edit")
public String processSubmit(@Valid @ModelAttribute("pet") Pet pet, BindingResult result) { (1)
	if (result.hasErrors()) {
		return "petForm";
	}
	// ...
}

1	在模型属性参数上使用`@Valid`。

@PostMapping("/owners/{ownerId}/pets/{petId}/edit")
fun processSubmit(@Valid @ModelAttribute("pet") pet: Pet, result: BindingResult): String { (1)
	if (result.hasErrors()) {
		return "petForm"
	}
	// ...
}

1	在模型属性参数上使用`@Valid`。

如果方法验证适用于其他参数具有@Constraint注解的情况，则会引发HandlerMethodValidationException。请参阅有关控制器方法的部分验证。

使用@ModelAttribute是可选的。默认情况下，任何不是由BeanUtils#isSimpleProperty确定为简单值类型的参数，且未由任何其他参数解析器解析的参数，都被视为隐式@ModelAttribute。

在使用GraalVM编译为本机映像时，上述隐式@ModelAttribute支持不允许正确的提前推断相关数据绑定反射提示。因此，建议在GraalVM本机映像中使用时明确地为方法参数添加@ModelAttribute注解。