验证

Spring WebFlux 为 @RequestMapping 方法内置了 验证 功能,包括 Java Bean 验证。验证可以应用在以下两个层面之一

  1. @ModelAttribute@RequestBody@RequestPart 参数解析器会单独验证方法参数,如果方法参数被 Jakarta @Valid 或 Spring 的 @Validated 注解,并且紧随其后没有 ErrorsBindingResult 参数,并且不需要方法验证(将在后面讨论)。在这种情况下抛出的异常是 WebExchangeBindException

  2. @Constraint 注解(例如 @Min@NotBlank 等)直接声明在方法参数上或方法上(针对返回值)时,必须应用方法验证,这会覆盖方法参数级别的验证,因为方法验证同时涵盖了方法参数约束和通过 @Valid 的嵌套约束。在这种情况下抛出的异常是 HandlerMethodValidationException

应用必须处理 WebExchangeBindExceptionHandlerMethodValidationException,因为根据控制器方法签名,两者都可能被抛出。然而,这两个异常设计得非常相似,并且可以使用几乎相同的代码进行处理。主要区别在于前者针对单个对象,而后者针对方法参数列表。

@Valid 不是一个约束注解,而是用于对象内的嵌套约束。因此,单独使用 @Valid 不会导致方法验证。另一方面,@NotNull 是一个约束,将其添加到带有 @Valid 的参数上会导致方法验证。特别对于可空性,您也可以使用 @RequestBody@ModelAttributerequired 标志。

方法验证可以与 ErrorsBindingResult 方法参数结合使用。但是,只有当所有验证错误都发生在紧随其后带有 Errors 的方法参数上时,才会调用控制器方法。如果任何其他方法参数上存在验证错误,则会抛出 HandlerMethodValidationException

您可以通过 WebFlux 配置 全局配置 Validator,或者通过 @Controller@ControllerAdvice 中的 @InitBinder 方法进行本地配置。您还可以使用多个验证器。

如果控制器类上带有 @Validated 注解,则通过 AOP 代理应用方法验证。为了利用 Spring Framework 6.1 中添加的 Spring MVC 内置方法验证支持,您需要从控制器中移除类级别的 @Validated 注解。

错误响应 部分提供了关于如何处理 WebExchangeBindExceptionHandlerMethodValidationException 的更多详细信息,以及如何通过 MessageSource 和特定于区域设置和语言的资源包定制其渲染。

为了进一步自定义处理方法验证错误,您可以扩展 ResponseEntityExceptionHandler 或在控制器或 @ControllerAdvice 中使用 @ExceptionHandler 方法,并直接处理 HandlerMethodValidationException。该异常包含一个 ParameterValidationResult 列表,这些列表按方法参数对验证错误进行分组。您可以遍历这些结果,或者提供一个访问者,该访问者根据控制器方法参数类型提供回调方法

  • 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) {
			// ...
	}
})