`@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 添加。
从 HTTP 会话中访问，如果模型属性在类级别的 @SessionAttributes 中列出。
通过默认构造函数实例化。
通过“主构造函数”实例化，其参数与 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 Validation和Spring validation）在数据绑定后自动应用验证。例如

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 注释方法参数。