Spring WebFlux实现参数校验的示例代码

 更新时间:2021年08月08日 11:43:13   作者:lzyer  
请求参数校验,在实际的应用中很常见,网上的文章大部分提供的使用注解的方式做参数校验。本文主要介绍 Spring Webflux Function Endpoint 使用 Spring Validation 来校验请求的参数。感兴趣的可以了解一下

请求参数校验,在实际的应用中很常见,网上的文章大部分提供的使用注解的方式做参数校验。本文主要介绍 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 接口中的两个方法 supportsvalidate

  • 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中的@RestControllerAdvice注解使用解析

    Spring中的@RestControllerAdvice注解使用解析

    这篇文章主要介绍了Spring中的@RestControllerAdvice注解使用解析,@RestControllerAdvice 是 Spring 框架中一个用于统一处理控制器异常和返回结果的注解,它可以被用来定义全局异常处理程序和全局响应结果处理程序,需要的朋友可以参考下
    2024-01-01
  • 通过AOP环绕通知如何实现事务控制

    通过AOP环绕通知如何实现事务控制

    这篇文章主要介绍了通过AOP环绕通知如何实现事务控制的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • Mybatis输入输出映射及动态SQL Review

    Mybatis输入输出映射及动态SQL Review

    这篇文章主要介绍了Mybatis输入输出映射及动态SQL Review,需要的朋友可以参考下
    2017-02-02
  • Java线程之守护线程(Daemon)用法实例

    Java线程之守护线程(Daemon)用法实例

    这篇文章主要介绍了Java线程之守护线程(Daemon)用法,较为详细的分析了守护线程的功能与实现技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-07-07
  • 使用Spring AOP监控指定方法执行时间的代码详解

    使用Spring AOP监控指定方法执行时间的代码详解

    这篇文章主要介绍了使用Spring AOP监控指定方法执行时间,文中通过代码示例给大家介绍的非常详细,对大家的学习或工作有一定的帮助,需要的朋友可以参考下
    2024-08-08
  • 为什么JDK8中HashMap依然会死循环

    为什么JDK8中HashMap依然会死循环

    这篇文章主要介绍了为什么JDK8中HashMap依然会死循环,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-09-09
  • 盘点Java中延时任务的多种实现方式

    盘点Java中延时任务的多种实现方式

    当需要一个定时发布系统通告的功能,如何实现? 当支付超时,订单自动取消,如何实现?其实这些问题本质都是延时任务的实现,本文为大家盘点了多种常见的延时任务实现方法,希望对大家有所帮助
    2022-12-12
  • Java正则表达式判断是否包含数字、字母、特殊字符及中文的多种方法

    Java正则表达式判断是否包含数字、字母、特殊字符及中文的多种方法

    这篇文章主要给大家介绍了关于Java正则表达式判断是否包含数字、字母、特殊字符及中文的多种方法,Java正则表达式在字符串处理和模式匹配中扮演着重要角色,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2023-08-08
  • maven <repositories>标签和<pluginRepositories>标签的使用

    maven <repositories>标签和<pluginRepositories>标签的使用

    这篇文章主要介绍了maven <repositories>标签和<pluginRepositories>标签的使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-07-07
  • Kotlin教程之基本数据类型

    Kotlin教程之基本数据类型

    这篇文章主要介绍了Kotlin教程之基本数据类型的学习的相关资料,需要的朋友可以参考下
    2017-05-05

最新评论