此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Framework 6.2.0! |
@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
instance 可以是:
-
从模型访问,其中它可能由
Model
. -
如果 model 属性列在 类级别
@SessionAttributes
. -
通过默认构造函数实例化。
-
通过具有与 Servlet 匹配的参数的 “primary constructor” 实例化 request 参数。参数名称是通过运行时保留的参数确定的 名称。
默认情况下,构造函数和属性数据绑定都适用。然而 模型对象设计需要仔细考虑,出于安全原因,它是 建议使用专为 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 也可以放置在与 constructor 对应的字段上
参数。而@BindParam 支持开箱即用,您还可以使用
different 注解,方法是将DataBinder.NameResolver 上DataBinder
|
构造函数绑定支持List
,Map
和数组参数从
单个字符串(例如逗号分隔的列表)或基于索引键(如accounts[2].name
或account[KEY].name
.
与 Spring MVC 不同,WebFlux 在模型中支持响应式类型,例如,Mono<Account>
.
您可以声明@ModelAttribute
参数(无论是否带有反应式类型包装器),以及
它将根据实际值进行解析。
如果数据绑定导致错误,则默认情况下WebExchangeBindException
被提升,
但您也可以添加BindingResult
参数紧邻@ModelAttribute
为了在 controller 方法中处理此类错误。例如:
-
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 在 model 属性参数上。 |
@PostMapping("/owners/{ownerId}/pets/{petId}/edit")
fun processSubmit(@Valid @ModelAttribute("pet") pet: Pet, result: BindingResult): String { (1)
if (result.hasErrors()) {
return "petForm"
}
// ...
}
1 | 用@Valid 在 model 属性参数上。 |
如果方法验证适用,因为其他参数具有@Constraint
附注
然后HandlerMethodValidationException
将改为提高。请参阅
controller 方法 Validation。
用@ModelAttribute 是可选的。默认情况下,任何不是简单
由 BeanUtils#isSimpleProperty 确定的值类型,并且未由任何其他参数解析器解析的 value 类型被视为隐式@ModelAttribute . |
使用 GraalVM 编译为原生镜像时,隐式的@ModelAttribute 上述支持不允许对相关数据进行适当的提前推理
绑定反射提示。因此,建议显式注释
method 参数替换为@ModelAttribute 用于 GraalVM 原生映像。 |