此版本仍在开发中,尚不被认为是稳定的。对于最新的稳定版本,请使用 Spring Framework 6.2.10! |
@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
. -
通过默认构造函数实例化。
-
通过具有与 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.NameResolver 上DataBinder
|
构造函数绑定支持List
,Map
,数组参数从
单个字符串,例如逗号分隔的列表,或基于索引键(例如accounts[2].name
或account[KEY].name
.
WebFlux 与 Spring MVC 不同,它支持模型中的响应式类型,例如Mono<Account>
.
您可以声明一个@ModelAttribute
带有或不带有响应式类型包装器的参数,以及
它将根据实际值进行解析。
如果数据绑定导致错误,则默认情况下WebExchangeBindException
被抬起,
但您也可以添加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 . |
@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 ->
// ...
}
}
-
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 是可选的。默认情况下,任何不是简单的value 类型(由 BeanUtils#isSimpleProperty 确定且未被任何其他参数解析器解析)都被视为隐式@ModelAttribute . |
使用 GraalVM 编译为本机映像时,隐式@ModelAttribute 上述支持不允许对相关数据进行适当的提前推断绑定反射提示。因此,建议显式注释方法 参数@ModelAttribute 用于 GraalVM 本机映像。 |