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;@Componentpublic 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@Componentpublic 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@Slf4jpublic 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@Setterpublic class Result { private Integer code; private String message;}

請求效果：

至此，Webflux 的Function Endpoint 的參數校驗的使用結束了。

參考：

WebFlux Handler Validation

Spring Validator

到此這篇關于Spring WebFlux實現參數校驗的示例代碼的文章就介紹到這了,更多相關Spring WebFlux 參數校驗內容請搜索好吧啦網以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持好吧啦網！