SpringBoot使用validation做参数校验说明
作者:??小小小LIN子???? 时间:2022-04-24 09:18:03
1.添加依赖
直接添加 hibernate-validator
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.2.Final</version>
</dependency>
添加spring-boot-starter-validation
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
<version>1.4.0.RELEASE</version>
</dependency>
添加spring-boot-starter-web
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
2. 配置文件
如果想要设置fail_fast
属性的话,true
表示有一个参数出错即返回,默认的时检验所有的参数,那么必须要有配置文件
import org.hibernate.validator.HibernateValidator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.validation.beanvalidation.MethodValidationPostProcessor;
import org.springframework.validation.beanvalidation.SpringValidatorAdapter;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
/**
* hibernate参数验证配置
*/
@Configuration
public class ValidatorConfig extends WebMvcConfigurerAdapter {
@Bean
public Validator validator() {
ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
.configure()
// 将fail_fast设置为true即可,如果想验证全部,则设置为false或者取消配置即可
.failFast(true)
// .addProperty("hibernate.validator.fail_fast", "true")
.buildValidatorFactory();
return validatorFactory.getValidator();
}
/**
* requestParam方式的校验
* @return
*/
@Bean
public MethodValidationPostProcessor methodValidationPostProcessor() {
MethodValidationPostProcessor methodValidationPostProcessor = new MethodValidationPostProcessor();
methodValidationPostProcessor.setValidator(validator());
return methodValidationPostProcessor;
}
@Override
public org.springframework.validation.Validator getValidator() {
return new SpringValidatorAdapter(validator());
}
}
其中methodValidationPostProcessor是对requestParam起作用
继承WebMvcConfigurerAdapter
并且重写getValidator()
方法,是让spring的请求校验Validator
使用我们上边的validator,让设置的failFast
生效,具体可参考org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport#mvcValidator
方法
3.统一异常处理
/**
* hibernate-valid实体类形式接受参数验证失败
* @param ex
* @return
*/
@ExceptionHandler(BindException.class)
@ResponseBody
public WebResult validationErrorHandler(BindException ex) {
List<String> collect = ex.getBindingResult().getAllErrors()
.stream()
.map(ObjectError::getDefaultMessage)
.collect(Collectors.toList());
return new WebResult(Errors.INCORRECT_PARAM_FORMAT.getError(), StringUtils.join(collect, ";"));
}
/**
* hibernate-valid实体类形式接受参数验证失败
* @param ex
* @return
*/
@ExceptionHandler(MethodArgumentNotValidException.class)
@ResponseBody
public WebResult validationErrorHandler(MethodArgumentNotValidException ex) {
List<String> collect = ex.getBindingResult().getAllErrors()
.stream()
.map(ObjectError::getDefaultMessage)
.collect(Collectors.toList());
return new WebResult(Errors.INCORRECT_PARAM_FORMAT.getError(), StringUtils.join(collect, ";"));
}
/**
* RequestParam方式参数校验
* @param ex
* @return
*/
@ExceptionHandler(ConstraintViolationException.class)
@ResponseBody
public WebResult validationErrorHandler(ConstraintViolationException ex) {
List<String> errorInformation = ex.getConstraintViolations()
.stream()
.map(ConstraintViolation::getMessage)
.collect(Collectors.toList());
return new WebResult(Errors.INCORRECT_PARAM_FORMAT.getError(),StringUtils.join(errorInformation, ";"));
}
4.使用
如果是
@RequestParam
这样直接写参数校验的话,在类上或者对应方法上加上Validated
注解,如果是实体类接受的话,在参数中的实体前加上@Valid
即可
来源:https://juejin.cn/post/6959055654480773134
标签:SpringBoot,validation,参数,校验
0
投稿
猜你喜欢
详解java整合solr5.0之solrj的使用
2023-07-23 03:12:06
记一次springboot服务凌晨无故宕机问题的解决
2023-07-25 04:50:23
Java类库BeanUtils组件使用方法及实例详解
2022-09-28 00:37:49
C#6.0新语法示例详解
2023-11-16 03:43:42
MyBatis-Plus分页插件不生效的解决方法
2023-03-10 20:24:58
Java 线程对比(Thread,Runnable,Callable)实例详解
2022-10-20 21:34:08
java编程实现优先队列的二叉堆代码分享
2022-11-13 15:32:13
java HttpClient传输json格式的参数实例讲解
2023-08-08 13:21:26
java 非对称加密算法RSA实现详解
2023-11-25 07:41:36
springboot整合shiro实现记住我功能
2023-07-29 20:21:34
java数据结构与算法之快速排序详解
2023-02-23 10:23:43
SpringBoot中@Import注解如何正确使用
2023-07-28 12:36:16
详解SpringBoot如何实现统一后端返回格式
2022-11-27 05:26:24
详谈Java中net.sf.json包关于JSON与对象互转的坑
2023-03-02 12:38:31
IDEA使用SpringAssistant插件创建SpringCloud项目
2021-06-06 10:47:46
Java Bean 作用域及它的几种类型介绍
2022-12-02 20:39:42
ShardingSphere jdbc实现分库分表核心概念详解
2023-11-24 12:09:45
Java基于命令模式实现邮局发信功能详解
2023-07-03 04:57:25
VS2019配置OpenCV4.1.0详细教程与测试代码(推荐)
2021-11-06 21:55:24
使用SpringBoot获取resources文件路径
2022-10-12 15:29:56