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 参数校验内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 微信游戏打飞机游戏制作(java模拟微信打飞机游戏)

    微信游戏打飞机游戏制作(java模拟微信打飞机游戏)

    java模拟微信打飞机游戏,大家参考使用吧
    2013-12-12
  • java后台处理前端传的json串方法

    java后台处理前端传的json串方法

    今天小编就为大家分享一篇java后台处理前端传的json串方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-08-08
  • 一文带你学会Java网络编程

    一文带你学会Java网络编程

    网络编程是指编写运行在多个设备(计算机)的程序,这些设备都通过网络连接起来。这篇文章将带大家深入了解一下Java的网络编程,需要的可以了解一下
    2022-08-08
  • java输出镂空金字塔实现案例

    java输出镂空金字塔实现案例

    小编最近接到领导安排,要求根据用户输入,打印出相应层数的镂空金字塔效果,本文分步骤通过实例代码给大家介绍的非常详细,需要的朋友参考下吧
    2021-09-09
  • Java线程池FutureTask实现原理详解

    Java线程池FutureTask实现原理详解

    这篇文章主要介绍了Java线程池FutureTask实现原理详解,小编觉得还是挺不错的,具有一定借鉴价值,需要的朋友可以参考下
    2018-02-02
  • Java线程和操作系统线程的关系解读

    Java线程和操作系统线程的关系解读

    这篇文章主要介绍了Java线程和操作系统线程的关系解读,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-06-06
  • 详解Java时区处理之Date,Calendar,TimeZone,SimpleDateFormat

    详解Java时区处理之Date,Calendar,TimeZone,SimpleDateFormat

    这篇文章主要介绍了Java时区处理之Date,Calendar,TimeZone,SimpleDateFormat的区别于用法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-07-07
  • Spring中@ConditionalOnProperty注解的作用详解

    Spring中@ConditionalOnProperty注解的作用详解

    这篇文章主要介绍了Spring中@ConditionalOnProperty注解的作用详解,@ConditionalOnProperty注解主要是用来判断配置文件中的内容来决定配置类是否生效用的,如果条件不匹配,则配置类不生效,需要的朋友可以参考下
    2024-01-01
  • Spring Boot中操作使用Redis实现详解

    Spring Boot中操作使用Redis实现详解

    Spring Boot与Redis结合使用,通过使用Spring Data Redis来实现对Redis的操作,实现数据缓存和高效存储,提高应用程序的性能和响应速度。可以利用Spring Boot自带的Redis Starter方便地集成和配置Redis
    2023-04-04
  • Java二维数组计算集合总结

    Java二维数组计算集合总结

    本篇文章给大家整理了关于Java二维数组计算集合的内容总结,有需要的读者们可以参考下。
    2018-02-02

最新评论