此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Framework 6.2.0! |
验证
Spring MVC 内置了对@RequestMapping
方法,包括 Java Bean Validation。
验证可以应用于以下两个级别之一:
-
@ModelAttribute、@RequestBody 和 @RequestPart 参数 如果 method 参数被注释,则解析程序会单独验证 method 参数 与 Jakarta 合作
@Valid
或 Spring 的@Validated
,并且没有Errors
或BindingResult
parameter 之后,不需要 AND 方法验证(要 接下来讨论)。在这种情况下引发的异常是MethodArgumentNotValidException
. -
什么时候
@Constraint
注解,例如@Min
,@NotBlank
和其他 直接在 method parameters 上,或在 method(对于返回值)上,然后依次在 method 必须应用 validation,并且这会取代 method 参数级别的 validation 因为方法验证同时涵盖方法参数约束和嵌套约束 通过@Valid
.在这种情况下引发的异常是HandlerMethodValidationException
.
应用程序必须同时处理MethodArgumentNotValidException
和HandlerMethodValidationException
因为根据控制器的不同,可能会引发
方法签名。但是,这两个例外的设计非常相似,并且可以
使用几乎相同的代码处理。主要区别在于前者是针对单个
object,而后者用于方法参数列表。
@Valid 不是约束注释,而是用于
一个 Object。因此,就其本身而言@Valid 不会导致方法验证。@NotNull 另一方面是一个 constraint,将其添加到@Valid 参数导致方法
验证。具体来说,对于可为 null 性,您还可以使用required 的标志@RequestBody 或@ModelAttribute . |
方法验证可与Errors
或BindingResult
方法
参数。但是,仅当所有验证错误都处于打开状态时,才会调用 controller 方法
方法参数替换为Errors
紧随其后。如果 上的 存在验证错误
任何其他方法参数HandlerMethodValidationException
被提升。
您可以配置Validator
通过 WebMvc 配置全局,或通过 @InitBinder 中的 方法在本地通过@Controller
或@ControllerAdvice
.您还可以使用多个验证器。
如果控制器具有类级别@Validated ,则通过 AOP 代理应用方法验证。为了利用 Spring MVC 内置的对
在 Spring Framework 6.1 中添加的方法验证,你需要删除 class 级别@Validated 注解。 |
错误响应部分进一步提供了
有关如何作的详细信息MethodArgumentNotValidException
和HandlerMethodValidationException
的 Git,以及如何通过MessageSource
和
特定于区域设置和语言的资源包。
要进一步自定义处理方法验证错误,您可以扩展ResponseEntityExceptionHandler
或使用@ExceptionHandler
控制器中的方法
或在@ControllerAdvice
和句柄HandlerMethodValidationException
径直。
该异常包含ParameterValidationResult
对验证错误进行分组
by 方法参数。您可以迭代这些内容,也可以为访客提供回传
按控制器方法参数类型划分的方法:
-
Java
-
Kotlin
HandlerMethodValidationException ex = ... ;
ex.visitResults(new HandlerMethodValidationException.Visitor() {
@Override
public void requestHeader(RequestHeader requestHeader, ParameterValidationResult result) {
// ...
}
@Override
public void requestParam(@Nullable RequestParam requestParam, ParameterValidationResult result) {
// ...
}
@Override
public void modelAttribute(@Nullable ModelAttribute modelAttribute, ParameterErrors errors) {
// ...
@Override
public void other(ParameterValidationResult result) {
// ...
}
});
// HandlerMethodValidationException
val ex
ex.visitResults(object : HandlerMethodValidationException.Visitor {
override fun requestHeader(requestHeader: RequestHeader, result: ParameterValidationResult) {
// ...
}
override fun requestParam(requestParam: RequestParam?, result: ParameterValidationResult) {
// ...
}
override fun modelAttribute(modelAttribute: ModelAttribute?, errors: ParameterErrors) {
// ...
}
// ...
override fun other(result: ParameterValidationResult) {
// ...
}
})