`@ModelAttribute`

@ModelAttribute 方法参数注解将表单数据、查询参数、URI 路径变量和请求头绑定到模型对象上。例如：

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` 实例。

表单数据和查询参数优先于 URI 变量和请求头，后者仅在不覆盖同名请求参数的情况下包含。头名称中的连字符会被去除。

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 来使用不同的注解

构造函数绑定支持 List、Map 和数组参数，这些参数可以从单个字符串（例如，逗号分隔列表）转换，或者基于索引键（例如 accounts[2].name 或 account[KEY].name）。

与 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 验证）。例如：

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