经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » Java相关 » Spring » 查看文章
Spring WebFlux实现参数校验的示例代码
来源:jb51  时间:2021/8/9 10:07:17  对本文有异议

请求参数校验,在实际的应用中很常见,网上的文章大部分提供的使用注解的方式做参数校验。本文主要介绍 Spring Webflux Function Endpoint 使用 Spring Validation 来校验请求的参数。使用上一篇文章的示例来演示。

使用步骤如下:

1.创建校验器 Validator

2.运用校验器

3.抛出异常,返回 http status 400 错误

PersonValidator.java

  1. package com.example.springbootdemo.webflux.restful;
  2.  
  3. import org.springframework.stereotype.Component;
  4. import org.springframework.validation.Errors;
  5. import org.springframework.validation.ValidationUtils;
  6. import org.springframework.validation.Validator;
  7.  
  8. @Component
  9. public class PersonValidator implements Validator {
  10.  
  11. @Override
  12. public boolean supports(Class<?> clazz) {
  13. return Person.class.isAssignableFrom(clazz);
  14. }
  15.  
  16. // 校验参数的方法
  17. @Override
  18. public void validate(Object o, Errors errors) {
  19. ValidationUtils.rejectIfEmpty(errors, "name", "name.required");
  20. ValidationUtils.rejectIfEmpty(errors, "age", "age.required");
  21. Person p = (Person) o;
  22. if (p.getAge() != null && p.getAge() < 0) {
  23. errors.rejectValue("age", "negative.value");
  24. } else if (p.getAge() != null && p.getAge() > 200) {
  25. errors.rejectValue("age", "too.old");
  26. }
  27. }
  28. }

校验器在 savePerson 方法中的使用

  1. @Slf4j
  2. @Component
  3. public class PersonHandler {
  4.  
  5. @Autowired
  6. private PersonRepository repository;
  7. @Autowired
  8. private PersonValidator validator;
  9.  
  10. public Mono<ServerResponse> savePerson(ServerRequest request) {
  11. Mono<Person> personMono = request.bodyToMono(Person.class).doOnNext(this::validate);
  12. return ServerResponse.ok().contentType(MediaType.APPLICATION_JSON)
  13. .body(this.repository.savePerson(personMono), Void.class);
  14. }
  15. public void validate(Person person) {
  16. Errors errors = new BeanPropertyBindingResult(person, Person.class.getName());
  17. validator.validate(person, errors);
  18. if (errors.hasErrors()) {
  19. // 抛出 http status 400 异常
  20. throw new ServerWebInputException(errors.toString());
  21. }
  22. }
  23. // .... 省略
  24. }

请求效果:

官方校验参数示例的地址 https://docs.spring.io/spring-framework/docs/current/reference/html/web-reactive.html

使用 Spring 官方文档提供的示例不会抛出 http code 400 错误,返回的是http code 为 200。

接下来,我们来看一下Validator 接口中的两个方法 supportsvalidate

  • supports(Class) : 判断当前的校验器用指定的类上。
  • validate(Object, org.springframework.validation.Errors) : 校验给定的对象,如果出现错误,就给Errors 注册 Error 信息。

另外,Spring 还提供了非常好用的 ValidationUtils 的工具类,提供了静态的方法

  • rejectIfEmpty
  • rejectIfEmptyOrWhitespace

全局异常的使用

  1. @Configuration
  2. @Slf4j
  3. public class GlobalErrorConfig {
  4.  
  5. private ObjectMapper objectMapper = new ObjectMapper();
  6.  
  7. @Bean
  8. @Order(-2)
  9. public WebExceptionHandler exceptionHandler() {
  10. return (ServerWebExchange serverWebExchange, Throwable t) -> {
  11. DataBuffer dataBuffer = serverWebExchange.getResponse().bufferFactory().allocateBuffer();
  12. Result result = new Result();
  13. if (t instanceof ServerWebInputException) {
  14. ServerWebInputException exception = (ServerWebInputException) t;
  15. result.setCode(exception.getStatus().value());
  16. result.setMessage(exception.getReason());
  17. } else {
  18. result.setCode(HttpStatus.INTERNAL_SERVER_ERROR.value());
  19. result.setMessage(HttpStatus.INTERNAL_SERVER_ERROR.toString());
  20. }
  21. try {
  22. dataBuffer.write(objectMapper.writeValueAsBytes(result));
  23. } catch (JsonProcessingException e) {
  24. log.error(NestedExceptionUtils.buildMessage("write error", e));
  25. }
  26. ServerHttpResponse response = serverWebExchange.getResponse();
  27. response.setRawStatusCode(result.getCode());
  28. return response.writeWith(Mono.just(dataBuffer));
  29. };
  30. }
  31. }

Result.java

  1. import lombok.Getter;
  2. import lombok.Setter;
  3.  
  4. @Getter
  5. @Setter
  6. public class Result {
  7.  
  8. private Integer code;
  9.  
  10. private String message;
  11. }

请求效果:

至此,Webflux 的Function Endpoint 的参数校验的使用结束了。

参考:

WebFlux Handler Validation

Spring Validator

到此这篇关于Spring WebFlux实现参数校验的示例代码的文章就介绍到这了,更多相关Spring WebFlux 参数校验内容请搜索w3xue以前的文章或继续浏览下面的相关文章希望大家以后多多支持w3xue!

 友情链接:直通硅谷  点职佳  北美留学生论坛

本站QQ群:前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

W3xue 的所有内容仅供测试,对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接(目前9元/月)请联系QQ:27243702 沸活量
皖ICP备17017327号-2 皖公网安备34020702000426号