`@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 验证和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注解。