此版本仍在开发中,尚不被认为是稳定的。对于最新的稳定版本,请使用 Spring Framework 6.2.10! |
@ModelAttribute
这@ModelAttribute
method 参数注释将请求参数、URI 路径变量、和请求标头绑定到模型对象上。 例如:
-
Java
-
Kotlin
@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 变量和标头也包括在内,但前提是它们没有覆盖具有相同名称的请求参数。破折号从标头名称中被剥离。
这Pet
上面的例子可能是:
-
从模型访问,可以通过@ModelAttribute方法添加它。
-
如果模型属性列在类级
@SessionAttributes
注解。 -
通过
Converter
如果模型属性名称与请求值(例如 path 变量或请求参数)的名称匹配(示例如下)。 -
通过默认构造函数实例化。
-
通过“主构造函数”实例化,其参数与 Servlet 匹配请求参数。参数名称通过运行时保留的参数确定字节码中的名称。
如上所述,一个Converter<String, T>
如果模型属性名称与请求值的名称(例如 path 变量或request 参数)匹配,并且存在兼容的Converter<String, T>
. 在下面的示例中,模型属性名称account
匹配 URI 路径变量account
,并且有一个 注册Converter<String, Account>
这可能会从持久性存储中检索它:
-
Java
-
Kotlin
@PutMapping("/accounts/{account}")
public String save(@ModelAttribute("account") Account account) { (1)
// ...
}
@PutMapping("/accounts/{account}")
fun save(@ModelAttribute("account") account: Account): String { (1)
// ...
}
默认情况下,同时应用构造函数和属性数据绑定。 然而 模型对象设计需要仔细考虑,出于安全原因,它是建议使用专门为 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.NameResolver 上DataBinder
|
构造函数绑定支持List
,Map
,数组参数要么从单个字符串(例如逗号分隔列表)转换,要么基于索引键,例如accounts[2].name
或account[KEY].name
.
在某些情况下,您可能希望在没有数据绑定的情况下访问模型属性。对于此类情况,您可以注入Model
进入控制器并直接访问它,或者,或者,将@ModelAttribute(binding=false)
,如以下示例所示:
-
Java
-
Kotlin
@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
被引发,但你也可以添加一个BindingResult
参数紧邻@ModelAttribute
以处理控制器方法中的此类错误。 例如:
-
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 旁边的@ModelAttribute . |
@PostMapping("/owners/{ownerId}/pets/{petId}/edit")
fun processSubmit(@ModelAttribute("pet") pet: Pet, result: BindingResult): String { (1)
if (result.hasErrors()) {
return "petForm"
}
// ...
}
1 | 添加一个BindingResult 旁边的@ModelAttribute . |
-
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 | 验证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 实例。 |
如果没有BindingResult
参数@ModelAttribute
然后
一个MethodArgumentNotValidException
与验证错误一起引发。但是,如果方法
验证适用,因为其他参数具有@jakarta.validation.Constraint
附注
然后HandlerMethodValidationException
而是被提高。有关更多详细信息,请参阅验证部分。
用@ModelAttribute 是可选的。默认情况下,任何不是简单
由 BeanUtils#isSimpleProperty 确定的值类型,并且未由任何其他参数解析器解析的值类型被视为隐式@ModelAttribute . |
使用 GraalVM 编译为本机映像时,隐式@ModelAttribute 上述支持不允许对相关数据进行适当的提前推断
绑定反射提示。因此,建议显式注释
方法 参数为@ModelAttribute 用于 GraalVM 本机映像。 |