@ModelAttribute

参见 Servlet 栈中的等效内容spring-doc.cadn.net.cn

@ModelAttribute 方法参数注解可将表单数据、查询参数、URI 路径变量和请求头绑定到一个模型对象上。例如：spring-doc.cadn.net.cn

@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 变量和请求头，只有当它们不会覆盖同名的请求参数时，才会包含 URI 变量和请求头。请求头名称中的连字符（-）会被移除。spring-doc.cadn.net.cn

Pet 实例可能是：spring-doc.cadn.net.cn

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

使用构造函数绑定时，可以通过 @BindParam 注解自定义请求参数的名称。例如：spring-doc.cadn.net.cn

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.NameResolver 上设置一个 DataBinder 来使用其他注解。

构造函数绑定支持 List、Map 和数组参数，这些参数既可以由单个字符串转换而来（例如，逗号分隔的列表），也可以基于带索引的键，如 accounts[2].name 或 account[KEY].name。spring-doc.cadn.net.cn

与 Spring MVC 不同，WebFlux 在模型中支持响应式类型，例如 Mono<Account>。 你可以声明一个带有或不带有响应式类型包装器的 @ModelAttribute 参数， 它将根据实际值进行相应解析。spring-doc.cadn.net.cn

如果数据绑定导致错误，默认会抛出一个 WebExchangeBindException 异常， 但你也可以在 BindingResult 参数旁边立即添加一个 @ModelAttribute 参数， 以便在控制器方法中处理此类错误。例如：spring-doc.cadn.net.cn

@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 参数，且不能使用响应式类型包装器。如果您希望使用响应式方式，可以直接通过它来处理错误。例如：spring-doc.cadn.net.cn

@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 验证）。例如：spring-doc.cadn.net.cn

@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 异常。请参阅控制器方法验证一节。spring-doc.cadn.net.cn

使用 @ModelAttribute 是可选的。默认情况下，任何未被判定为简单值类型（由 BeanUtils#isSimpleProperty 确定）并且未被其他任何参数解析器解析的参数，都会被隐式视为 @ModelAttribute。
在使用 GraalVM 编译为原生镜像时，上述描述的隐式 @ModelAttribute 支持无法正确进行相关数据绑定反射提示的提前推断。因此，建议在 GraalVM 原生镜像中显式地为方法参数添加 @ModelAttribute 注解。