此版本仍在开发中，尚未稳定。如需最新的稳定版本，请使用 Spring Framework 7.0.6！spring-doc.cadn.net.cn

@ModelAttribute

请参阅响应式栈中的等效项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)
	// method logic...
}
1 绑定到 Pet 的实例。 
@PostMapping("/owners/{ownerId}/pets/{petId}/edit")
fun processSubmit(@ModelAttribute pet: Pet): String { (1)
	// method logic...
}
1 绑定到 Pet 的实例。

请求参数是Servlet API中的一个概念，它包含来自请求体的表单数据以及查询参数。URI变量和头信息也被包括在内，但前提是它们不会覆盖同名的请求参数。头名称中的破折号将被移除。spring-doc.cadn.net.cn

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

如上所述，如果模型属性名称与请求值（例如路径变量或请求参数）的名称匹配，并且存在兼容的 Converter<String, T>，则可以使用 Converter<String, T> 来获取模型对象。在下面的示例中，模型属性名称 account 与 URI 路径变量 account 匹配，并且已注册了一个 Converter<String, Account>，该注册器可能会从持久化存储中检索它：spring-doc.cadn.net.cn

@PutMapping("/accounts/{account}")
public String save(@ModelAttribute("account") Account account) { (1)
	// ...
}
@PutMapping("/accounts/{account}")
fun save(@ModelAttribute("account") account: Account): String { (1)
	// ...
}

默认情况下，构造函数和属性 数据绑定 都会应用。但是， 模型对象的设计需要仔细考虑，出于安全原因，建议使用专门为 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 上设置一个 DataBinder.NameResolver 来使用其他注解

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

在某些情况下，你可能需要访问没有数据绑定的模型属性。对于这种情况，你可以将Model注入到控制器中并直接访问它，或者，设置@ModelAttribute(binding=false)，如下例所示：spring-doc.cadn.net.cn

@ModelAttribute
public AccountForm setUpForm() {
	return new AccountForm();
}

@ModelAttribute
public Account findAccount(@PathVariable String accountId) {
	return accountRepository.findOne(accountId);
}

@PostMapping("update")
public String update(AccountForm form, BindingResult result,
		@ModelAttribute(binding=false) Account account) { (1)
	// ...
}
1 设置 @ModelAttribute(binding=false). 
@ModelAttribute
fun setUpForm(): AccountForm {
	return AccountForm()
}

@ModelAttribute
fun findAccount(@PathVariable accountId: String): Account {
	return accountRepository.findOne(accountId)
}

@PostMapping("update")
fun update(form: AccountForm, result: BindingResult,
		   @ModelAttribute(binding = false) account: Account): String { (1)
	// ...
}
1 设置 @ModelAt\tribute(binding=false).

如果数据绑定导致错误，默认会抛出一个 MethodArgumentNotValidException，但你也可以在 @ModelAttribute 旁边立即添加一个 BindingResult 参数，以在控制器方法中处理此类错误。例如：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 在 @ModelAttribute 旁边添加一个 BindingResult。 
@PostMapping("/owners/{ownerId}/pets/{petId}/edit")
fun processSubmit(@ModelAttribute("pet") pet: Pet, result: BindingResult): String { (1)
	if (result.hasErrors()) {
		return "petForm"
	}
	// ...
}
1 在 @ModelAttribute 旁边添加一个 BindingResult。

您可以通过添加 jakarta.validation.Valid 注解或 Spring 的 @Validated 注解，在数据绑定后自动应用验证。 请参阅 Bean 验证 和 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 验证 Pet 实例。 
@PostMapping("/owners/{ownerId}/pets/{petId}/edit")
fun processSubmit(@Valid @ModelAttribute("pet") pet: Pet, result: BindingResult): String { (1)
	if (result.hasErrors()) {
		return "petForm"
	}
	// ...
}
1 验证 Pet 实例。

如果在@ModelAttribute之后没有BindingResult参数，则会引发MethodArgumentNotValidException并附带验证错误。但是，如果由于其他参数具有@jakarta.validation.Constraint注解而应用了方法验证，则改为引发HandlerMethodValidationException。更多详细信息，请参阅验证部分。spring-doc.cadn.net.cn

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