SpringBoot使用validation做参数校验说明

 更新时间:2022年04月28日 10:37:58   作者:​ 小小小LIN子   ​  
这篇文章主要介绍了SpringBoot使用validation做参数校验说明,首先通过添加hibernate-validator展开全文内容,具有一定的参考价值,需要的小伙伴可以参考与喜爱

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即可

到此这篇关于SpringBoot使用validation做参数校验说明的文章就介绍到这了,更多相关SpringBoot参数校验内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java教程各种接口的介绍

    Java教程各种接口的介绍

    Java教程各种接口的介绍,需要的朋友可以参考一下
    2013-02-02
  • Java单元测试Mockito的使用详解

    Java单元测试Mockito的使用详解

    Mockito是一个强大的mock工具,本文将重点讲述Mockito的基本使用及注意事项,以及Controller测试用例,本文通过示例代码给大家介绍的非常详细,需要的朋友参考下吧
    2021-07-07
  • Netty4之如何实现HTTP请求、响应

    Netty4之如何实现HTTP请求、响应

    这篇文章主要介绍了Netty4之如何实现HTTP请求、响应问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-04-04
  • 详解Spring Boot + Mybatis 实现动态数据源

    详解Spring Boot + Mybatis 实现动态数据源

    这篇文章主要介绍了Spring Boot + Mybatis 实现动态数据源,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-04-04
  • spring security CSRF防护的示例代码

    spring security CSRF防护的示例代码

    这篇文章主要介绍了spring security CSRF防护的示例代码,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-03-03
  • restemplate请求乱码之content-encoding=“gzip“示例详解

    restemplate请求乱码之content-encoding=“gzip“示例详解

    RestTemplate从Spring3.0开始支持的一个HTTP请求工具,它提供了常见的REST请求方案的模板,及一些通用的请求执行方法 exchange 以及 execute,接下来通过本文给大家介绍restemplate请求乱码之content-encoding=“gzip“,需要的朋友可以参考下
    2024-03-03
  • 软件开发七大过程模型

    软件开发七大过程模型

    这篇文章主要介绍了Java七大过程模型详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2021-08-08
  • 在Spring Boot中实现文件上传与管理的操作

    在Spring Boot中实现文件上传与管理的操作

    在 Spring Boot 中实现文件上传与管理非常简单,通过配置文件上传、创建文件上传、下载、列表和删除接口,我们可以轻松地处理文件操作,结合前端页面,可以提供一个完整的文件管理系统,这篇文章主要介绍了在Spring Boot中实现文件上传与管理,需要的朋友可以参考下
    2024-07-07
  • JDBC之PreparedStatement类中预编译的综合应用解析

    JDBC之PreparedStatement类中预编译的综合应用解析

    SQL 语句被预编译并存储在 PreparedStatement 对象中。然后可以使用此对象多次高效地执行该语句
    2013-07-07
  • SpringMVC中RequestMapping注解(作用、出现的位置、属性)

    SpringMVC中RequestMapping注解(作用、出现的位置、属性)

    这篇文章主要介绍了SpringMVC中RequestMapping注解(作用、出现的位置、属性),本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-01-01

最新评论