Spring 使用Validation 验证框架的问题详解

更新时间：2021年07月30日 15:34:21 作者：小毕超

Spring Boot在内部通过集成hibernate-validation已经实现了JSR-349验证规范接口，在Spring Boot项目中只要直接使用就行了。一般用在Controller中用于验证前端传来的参数。这篇文章给大家介绍Spring Validation 验证框架的相关知识，感兴趣的朋友一起看看吧

一、介绍

Spring Validation 验证框架对参数的验证机制提供了@Validated （Spring's JSR-303 规范，是标准 JSR-303 的一个变种），javax 提供了@Valid（标准 JSR-303 规范），配合 BindingResult 可以直接提供参数验证结果。其中对于字段的特定验证注解，比如 @NotNull。
两者在检验 Controller 的入参是否符合规范时，使用@Validated 或者 @Valid 在基本验证功能上没有太多区别。但是在分组、注解地方、嵌套验证等功能上两个有所不同：

1.@Validated
分组：提供分组功能，可在入参验证时，根据不同的分组采用不同的验证机制。
可注解位置：可以用在类型、方法和方法参数上。但是不能用在成员属性上
嵌套验证：用在方法入参上无法单独提供嵌套验证功能；不能用在成员属性上；也无法提供框架进行嵌套验证；能配合嵌套验证注解 @Valid 进行嵌套验证。

2.@Valid
分组：无分组功能
可注解位置：可以用在方法、构造函数、方法参数和成员属性上（两者是否能用于成员属性上直接影响能否提供嵌套验证的功能）
嵌套验证：用在方法入参上无法单独提供嵌套验证功能；能够用在成员属性上，提示验证框架进行嵌套验证；能配合嵌套验证注解@Valid进行嵌套验证。

二、使用

1. SpringBoot 2.3.0后需要添加依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

2. 配置 validation 使出现校验失败即返回

@Configuration
public class WebConfig {
    @Bean
    public Validator validator() {
        ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
                .configure()
                //failFast的意思只要出现校验失败的情况，就立即结束校验，不再进行后续的校验。
                .failFast(true)
                .buildValidatorFactory();
 
        return validatorFactory.getValidator();
    }
 
    @Bean
    public MethodValidationPostProcessor methodValidationPostProcessor() {
        MethodValidationPostProcessor methodValidationPostProcessor = new MethodValidationPostProcessor();
        methodValidationPostProcessor.setValidator(validator());
        return methodValidationPostProcessor;
    }
}

4. 编写全局异常捕获，捕获验证失败，统一返回

@Slf4j
@ControllerAdvice
public class ValidatedExceptionHandler {

    @ResponseBody
    @ExceptionHandler(BindException.class)
    public String exceptionHandler2(BindException exception) {
        BindingResult result = exception.getBindingResult();
        if (result.hasErrors()) {
            return result.getAllErrors().get(0).getDefaultMessage();
        }
        return "参数不可为空！";
    }

    @ResponseBody
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public String exceptionHandler2(MethodArgumentNotValidException exception) {
        BindingResult result = exception.getBindingResult();
        if (result.hasErrors()) {
            return result.getAllErrors().get(0).getDefaultMessage();
        }
        return "参数不可为空！";
    }
}

5. 定义Dto，在参数上添加注解校验

@Data
public class ValidDto {
    @NotEmpty(message = "name 不可为空！")
    private String name;

    @NotBlank(message = "userId 不可为空！")
    private String userId;

    @Min(value = 1, message = "年龄有误！")
    @Max(value = 120, message = "年龄有误！")
    private int age;

    @NotBlank(message = "邮箱不可为空！")
    @Email(message = "邮箱有误！")
    private String email;

    @NotBlank(message = "mobile不可为空！")
    @Pattern(regexp = "^(13[0-9]|14[579]|15[0-3,5-9]|16[6]|17[0135678]|18[0-9]|19[89])\\d{8}$", message = "手机号码有误！")
    private String mobile;

    @NotNull(message = "validVo 不可为空！")
    @Valid
    private ValidVo validVo;

    @NotEmpty(message = "list1 不可为空！")
    @Size(min = 1, max = 2, message = "list1 数据过大")
    @Valid
    private List<ValidVo> list1;
}

@Data
public class ValidVo {
    @NotBlank(message = "gender is null")
    private String gender;
    @NotBlank(message = "test is null")
    private String test;
}

6. Controller

@RestController
@RequestMapping("/valid")
@CrossOrigin
public class ValidController {

    @GetMapping("/GetTest")
    public String getTest(@Valid ValidDto dto, BindingResult result) {
        if (result.hasErrors()) {
            return result.getAllErrors().get(0).getDefaultMessage();
        }
        return "success";
    }

    @GetMapping("/GetTest2")
    public String getTest2(@Validated ValidDto dto) {

        return "success";
    }

    @GetMapping("/GetTest3")
    public String getTest3(@Validated @RequestBody ValidDto dto) {

        return "success";
    }
}

到此这篇关于Spring 使用Validation 验证框架的问题详解的文章就介绍到这了,更多相关Spring Validation 验证框架内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java 实现判定顺序表中是否包含某个元素(思路详解)
这篇文章主要介绍了Java 实现判定顺序表中是否包含某个元素，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2023-06-06
SpringBoot热部署和整合Mybatis的过程
热部署,就是在应用正在运行的时候升级软件,却不需要重新启动应用,本文给大家详细介绍SpringBoot热部署和整合Mybatis的过程,感兴趣的朋友跟随小编一起看看吧
2023-10-10
java工具类static静态方法读取yml配置过程
文章介绍了在工具类中获取YAML配置时遇到的问题,由于变量是静态的,而Spring加载静态方法比IOC容器早,导致无法直接使用@Value注解读取YAML配置,从而读取结果为null
2024-11-11
Java Scanner类及其方法使用图解
这篇文章主要介绍了Java Scanner类及其方法使用图解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-05-05
详解怎么用Java的super关键字
今天带大家学习Java中super关键字是怎么用的,文中有非常详细的介绍,对正在学习的小伙伴们很有帮助,需要的朋友可以参考下
2021-06-06
java正则表达式校验日期格式实例代码
如果使用得当,正则表达式是匹配各种模式的强大工具,下面这篇文章主要给大家介绍了关于java正则表达式校验日期格式的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
2023-05-05
Flink部署集群整体架构源码分析
这篇文章主要为大家介绍了Flink部署集群及整体架构示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-12-12
Linux下java环境配置图文方法
这篇文章主要介绍了Linux下java环境配置图文方法,需要的朋友可以参考下
2023-06-06
Spring Boot 中的 Native SQL基本概念及使用方法
在本文中，我们介绍了 Spring Boot 中的 Native SQL，以及如何使用 JdbcTemplate 和 NamedParameterJdbcTemplate 来执行自定义的 SQL 查询或更新语句，需要的朋友跟随小编一起看看吧
2023-07-07
springboot之使用logback日志框架的图文教程
这篇文章主要介绍了springboot之使用logback日志框架的图文教程，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-06-06

Spring 使用Validation 验证框架的问题详解

一、介绍

二、使用

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具