Spring WebFlux實現(xiàn)參數(shù)校驗的示例代碼
請求參數(shù)校驗,在實際的應(yīng)用中很常見,網(wǎng)上的文章大部分提供的使用注解的方式做參數(shù)校驗。本文主要介紹 Spring Webflux Function Endpoint 使用 Spring Validation 來校驗請求的參數(shù)。使用上一篇文章的示例來演示。
使用步驟如下:
1.創(chuàng)建校驗器 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);
}
// 校驗參數(shù)的方法
@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());
}
}
// .... 省略
}
請求效果:

官方校驗參數(shù)示例的地址 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): 判斷當(dāng)前的校驗器用指定的類上。validate(Object, org.springframework.validation.Errors): 校驗給定的對象,如果出現(xiàn)錯誤,就給Errors注冊Error信息。
另外,Spring 還提供了非常好用的 ValidationUtils 的工具類,提供了靜態(tài)的方法
- 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 的參數(shù)校驗的使用結(jié)束了。
參考:
到此這篇關(guān)于Spring WebFlux實現(xiàn)參數(shù)校驗的示例代碼的文章就介紹到這了,更多相關(guān)Spring WebFlux 參數(shù)校驗內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Intellij idea遠程debug連接tomcat實現(xiàn)單步調(diào)試
這篇文章主要介紹了Intellij idea遠程debug連接tomcat實現(xiàn)單步調(diào)試,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2018-05-05
Spring boot 數(shù)據(jù)庫連接斷線重連問題
這篇文章主要介紹了Spring boot 數(shù)據(jù)庫連接斷線重連問題,需要的朋友可以參考下2017-06-06
org.springframework.beans.BeanInstantiationException異常解決
本文主要介紹了org.springframework.beans.BeanInstantiationException異常解決,大多數(shù)情況下,這個異常是由于簡單的配置錯誤或者代碼問題導(dǎo)致的,下面就來具體解決一下2024-03-03
SpringBoot打成war包在tomcat或wildfly下運行的方法
這篇文章主要介紹了SpringBoot打成war包在tomcat或wildfly下運行的方法,本文給大家介紹的非常詳細,具有一定的參考借鑒價值,需要的朋友可以參考下2019-11-11
SpringBoot整合RestTemplate用法的實現(xiàn)
本篇主要介紹了RestTemplate中的GET,POST,PUT,DELETE、文件上傳和文件下載6大常用的功能,具有一定的參考價值,感興趣的可以了解一下2023-08-08
詳解Java并發(fā)工具類之CountDownLatch和CyclicBarrier
在JDK的并發(fā)包中,有幾個非常有用的并發(fā)工具類,它們分別是:CountDownLatch、CyclicBarrier、Semaphore和Exchanger,本文主要來講講其中CountDownLatch和CyclicBarrier的使用,感興趣的可以了解一下2023-06-06
springboot時間格式化的五種方法總結(jié)(解決后端傳給前端的時間顯示不一致)
這篇文章主要給大家介紹了關(guān)于springboot時間格式化的五種方法,文中介紹的方法解決了后端傳給前端的時間顯示不一致,文中通過圖文以及代碼介紹的非常詳細,需要的朋友可以參考下2024-01-01

