Spring WebFlux实现参数校验的示例代码
请求参数校验,在实际的应用中很常见,网上的文章大部分提供的使用注解的方式做参数校验。本文主要介绍 Spring Webflux Function Endpoint 使用 Spring Validation 来校验请求的参数。使用上一篇文章的示例来演示。
使用步骤如下:
1.创建校验器 Validator
2.运用校验器
3.抛出异常,返回 http status 400 错误
PersonValidator.java
package com.example.springbootdemo.webflux.restful; import org.springframework.stereotype.Component; import org.springframework.validation.Errors; import org.springframework.validation.ValidationUtils; import org.springframework.validation.Validator; @Component public class PersonValidator implements Validator { @Override public boolean supports(Class<?> clazz) { return Person.class.isAssignableFrom(clazz); } // 校验参数的方法 @Override public void validate(Object o, Errors errors) { ValidationUtils.rejectIfEmpty(errors, "name", "name.required"); ValidationUtils.rejectIfEmpty(errors, "age", "age.required"); Person p = (Person) o; if (p.getAge() != null && p.getAge() < 0) { errors.rejectValue("age", "negative.value"); } else if (p.getAge() != null && p.getAge() > 200) { errors.rejectValue("age", "too.old"); } } }
校验器在 savePerson
方法中的使用
@Slf4j @Component public class PersonHandler { @Autowired private PersonRepository repository; @Autowired private PersonValidator validator; public Mono<ServerResponse> savePerson(ServerRequest request) { Mono<Person> personMono = request.bodyToMono(Person.class).doOnNext(this::validate); return ServerResponse.ok().contentType(MediaType.APPLICATION_JSON) .body(this.repository.savePerson(personMono), Void.class); } public void validate(Person person) { Errors errors = new BeanPropertyBindingResult(person, Person.class.getName()); validator.validate(person, errors); if (errors.hasErrors()) { // 抛出 http status 400 异常 throw new ServerWebInputException(errors.toString()); } } // .... 省略 }
请求效果:
官方校验参数示例的地址 https://docs.spring.io/spring-framework/docs/current/reference/html/web-reactive.html
使用 Spring 官方文档提供的示例不会抛出 http code 400 错误,返回的是http code 为 200。
接下来,我们来看一下Validator
接口中的两个方法 supports
和 validate
supports(Class)
: 判断当前的校验器用指定的类上。validate(Object, org.springframework.validation.Errors)
: 校验给定的对象,如果出现错误,就给Errors
注册Error
信息。
另外,Spring 还提供了非常好用的 ValidationUtils
的工具类,提供了静态的方法
- rejectIfEmpty
- rejectIfEmptyOrWhitespace
全局异常的使用
@Configuration @Slf4j public class GlobalErrorConfig { private ObjectMapper objectMapper = new ObjectMapper(); @Bean @Order(-2) public WebExceptionHandler exceptionHandler() { return (ServerWebExchange serverWebExchange, Throwable t) -> { DataBuffer dataBuffer = serverWebExchange.getResponse().bufferFactory().allocateBuffer(); Result result = new Result(); if (t instanceof ServerWebInputException) { ServerWebInputException exception = (ServerWebInputException) t; result.setCode(exception.getStatus().value()); result.setMessage(exception.getReason()); } else { result.setCode(HttpStatus.INTERNAL_SERVER_ERROR.value()); result.setMessage(HttpStatus.INTERNAL_SERVER_ERROR.toString()); } try { dataBuffer.write(objectMapper.writeValueAsBytes(result)); } catch (JsonProcessingException e) { log.error(NestedExceptionUtils.buildMessage("write error", e)); } ServerHttpResponse response = serverWebExchange.getResponse(); response.setRawStatusCode(result.getCode()); return response.writeWith(Mono.just(dataBuffer)); }; } }
Result.java
import lombok.Getter; import lombok.Setter; @Getter @Setter public class Result { private Integer code; private String message; }
请求效果:
至此,Webflux 的Function Endpoint 的参数校验的使用结束了。
参考:
WebFlux Handler Validation
Spring Validator
到此这篇关于Spring WebFlux实现参数校验的示例代码的文章就介绍到这了,更多相关Spring WebFlux 参数校验内容请搜索猪先飞以前的文章或继续浏览下面的相关文章希望大家以后多多支持猪先飞!
相关文章
- 这篇文章主要介绍了Spring AOP 对象内部方法间的嵌套调用方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-08-29
Spring Cloud 中@FeignClient注解中的contextId属性详解
这篇文章主要介绍了Spring Cloud 中@FeignClient注解中的contextId属性详解,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-09-25Springboot如何实现Web系统License授权认证
这篇文章主要介绍了Springboot如何实现Web系统License授权认证,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-05-28如何在Spring WebFlux的任何地方获取Request对象
这篇文章主要介绍了如何在Spring WebFlux的任何地方获取Request对象,帮助大家更好的理解和使用springboot框架,感兴趣的朋友可以了解下...2021-01-26- 这篇文章主要介绍了详解SpringCloudGateway内存泄漏问题,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2020-07-16
- @Autowired 注解的主要功能就是完成自动注入,使用也非常简单,但这篇文章主要给大家介绍了关于Spring为什么不推荐使用@Autowired注解的相关资料,需要的朋友可以参考下...2021-11-03
Springboot如何使用mybatis实现拦截SQL分页
这篇文章主要介绍了Springboot使用mybatis实现拦截SQL分页,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-06-19- 这篇文章主要介绍了SpringMVC文件上传原理及实现过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-07-15
Spring Data JPA 关键字Exists的用法说明
这篇文章主要介绍了Spring Data JPA 关键字Exists的用法说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-06-10tomcat启动完成执行 某个方法 定时任务(Spring)操作
这篇文章主要介绍了tomcat启动完成执行 某个方法 定时任务(Spring)操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-09-25使用Maven 搭建 Spring MVC 本地部署Tomcat的详细教程
这篇文章主要介绍了使用Maven 搭建 Spring MVC 本地部署Tomcat,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2021-08-16- 这篇文章主要介绍了Spring Cloud负载均衡及远程调用实现详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2021-09-18
- 这篇文章主要介绍了SpringMvc自动装箱及GET请求参数原理解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-09-19
- 这篇文章主要介绍了SpringMvc获取请求头请求体消息过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-09-17
- 这篇文章主要介绍了Springboot使用thymeleaf动态模板实现刷新,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-08-31
Idea打包springboot项目没有.original文件解决方案
这篇文章主要介绍了Idea打包springboot项目没有.original文件解决方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-07-26- 这篇文章主要介绍了spring boot 使用utf8mb4的操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2021-02-20
Springmvc ResponseBody响应json数据实现过程
这篇文章主要介绍了Springmvc ResponseBody响应json数据实现过程,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-10-26- 这篇文章主要介绍了SpringData Repository接口用法解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-08-27
- 这篇文章主要介绍了Spring boot 无法注入service问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-10-09