springboot中使用Hibernate-Validation校验参数详解

更新时间：2023年07月12日 09:09:51 作者：Geroge1226

这篇文章主要为大家介绍了springboot中使用Hibernate-Validation校验参数详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪

1、说明

后端接口设计时候，需要对前端请求参数进行'先校验后处理业务'情况，如果在业务代码中通过类似if这里逐个校验，会使得代码变得繁琐，开发工作者都是爱偷懒的。java中，Bean Validation 为JavaBean的验证定义了相关的元数据模型和API。

基于Bean-Validation封装，提供了更加丰富的Hibernate-Validation的校验包。也有开发会把这类校验交给前端来处理，但是接口暴露外网会存在直接调用情况（黄牛）。毕竟：前端校验是为了提高用户的体验度，后端校验则是为了保证数据的安全性

优点

1.验证逻辑与业务逻辑之间进行了分离，降低了程序耦合度

2.统一且规范的验证方式，无需你再次编写重复的验证代码

3.你将更专注于你的业务，将这些繁琐的事情统统丢在一边

2、Bean Validation与Hibernate Validation

2.1 Bean Validation中内置的constraint

包位置路径：javax.validation.constraints

注解	说明
@AssertFalse	注释的元素必须为False
@AssertTrue	注释的元素必须为True
@Email	注释的元素必须邮箱
@NotBlank	注释的元素不能为空，！null && size>0
@NotEmpty	注释的元素不能为空，数组，集合等
@NotNull	注释的元素必须为空，但可以为""字符串
@DecimalMin	注释的元素数字，最小不得小于Min
@DecimalMax	注释的元素为数字，最大不超过Max值

其中NotNull、NotEmpty、NotBlank区别

@NotNull
适用于基本数据类型(Integer，Long，Double等等)，当 @NotNull 注解被使用在 String 类型的数据上，则表示该数据不能为 Null（但是可以为 Empty）
@NotBlank
适用于 String 类型的数据上，加了@NotBlank 注解的参数不能为 Null 且 trim() 之后 size > 0
@NotEmpty
适用于 String、Collection集合、Map、数组等等，加了@NotEmpty 注解的参数不能为 Null 或者长度为 0

2.1 Hibernate Validation中添加的constraint

注解	说明
@Length	注释的元素字符串长度必须为制定返回内
@Range	注释的元素必须在指定范围内
@URL	注释的元素必须为链接

3、基于Hibernate Validation的实现

（1）pom包引用
查看spring-boot-start-web中已经集成了Hibernate Validation，所以可以不用额外引用包。同时spring-boot-start-validation也完成了Hibernate Validation的start封装（校验机制更加全面）。

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

（2）Bean对象中使用注解注释

     ...
    @ApiModelProperty(value = "收货人所在省",required = true)
    @NotNull(message = "省不能为空")
    private String recipientProvince;

    @ApiModelProperty(value = "收货人所在市")
    @NotNull(message = "市不能为空")
    private String recipientCity;

    @ApiModelProperty(value = "收货人所在区")
    @NotNull(message = "区不能为空")
    private String recipientDistrict;
    ...

（3）Controller层使用@Valid或者@Validated

 @PostMapping("/add")
 public UniformResultTemplate&lt;Boolean&gt; addAddress(@RequestBody @Validated AddressReqDto reqDto, HttpServletRequest request){
   return null;
 }

注意：Post请求方式区别，Get@Validated注解需要加在所在方法类前

@RestController
@RequestMapping("/api/address")
@Validated
public class AddressController extends BaseController{
  @ApiOperation("收获地址详情")
    @GetMapping("/detail")
    public UniformResultTemplate<AddressDetailRespDto> queryAddressList(@NotNull(message = "地址Id不能为空") 
@RequestParam(value = "addressId") Long addressId, HttpServletRequest request){
        return null;
    }
}

（4）使用@ControllerAdvice统一异常处理返回。

@Component
@ControllerAdvice
@Slf4j
public class GlobalExceptionHandler {
    // Post请求Bean中的校验抛出:MethodArgumentNotValidException
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    public UniformResultTemplate handleBindException(MethodArgumentNotValidException ex) {
        FieldError fieldError = ex.getBindingResult().getFieldError();
        log.warn("参数校验异常:{}({})", fieldError.getDefaultMessage(),fieldError.getField());
        return new UniformResultTemplate("10002",fieldError.getDefaultMessage());
    }
  // Get请求的参数校验，抛出的是ConstraintViolationException
  @ExceptionHandler(ConstraintViolationException.class)
    @ResponseBody
    public UniformResultTemplate handleGetBindException(ConstraintViolationException ex) {
        Set<ConstraintViolation<?>>  eSet = ex.getConstraintViolations();
        StringBuffer sb = new StringBuffer();
        if(!CollectionUtils.isEmpty(eSet)) {
            Iterator<ConstraintViolation<?>> iterator = eSet.iterator();
            while (iterator.hasNext()) {
                log.warn("参数校验异常:{}({})", iterator.next().getMessage());
                sb.append(iterator.next().getMessage()).append("::");
            }
        }
        return new UniformResultTemplate("10002",sb.toString());
    }
  // 方法签名参数错误
    @ExceptionHandler(MissingServletRequestParameterException.class)
    @ResponseBody
    public UniformResultTemplate handleGetBindException(MissingServletRequestParameterException ex) {
        log.warn("参数校验异常:{}", ex.getMessage());
        return new UniformResultTemplate("10002",ex.getMessage());
    }
}

（5）结果现象

{
"code": "10002",
"message": "市不能为空",
"result": null,
"totalTimes": null,
"interfaceTimes": null
}

4、编译器校验工具

防止因使用错误Hibernate-Validation注解而导致程序运行时报错，增加编译器校验工具，进行友好提示。

<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator-annotation-processor</artifactId>
    <version>6.1.5.Final</version>
</dependency>

以上就是springboot中使用Hibernate-Validation校验参数详解的详细内容，更多关于springboot Hibernate-Validation的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

Java实战之实现一个好用的MybatisPlus代码生成器
这篇文章主要介绍了Java实战之实现一个好用的MybatisPlus代码生成器,文中有非常详细的代码示例,对正在学习java的小伙伴们有非常好的帮助,需要的朋友可以参考下
2021-04-04
详解path和classpath的区别
这篇文章主要介绍了详解path和classpath的区别的相关资料,需要的朋友可以参考下
2017-06-06
java 中String.equals和==的比较
这篇文章主要介绍了java 中String.equals和==的比较的相关资料,需要的朋友可以参考下
2017-08-08
Java中实现对象深克隆的四种方式
这篇文章主要介绍了如何在Java中实现对象的深克隆,可以通过手动实现clone()方法、使用序列化、第三方库Apache Commons Lang或Hutool等几种方式,每种方式都有其特点,需要的朋友可以参考下
2025-10-10
解决SpringBoot框架因post数据量过大没反应问题（踩坑）
这篇文章主要介绍了解决SpringBoot框架因post数据量过大没反应问题（踩坑），具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-09-09
玩转SpringBoot2快速整合拦截器的方法
这篇文章主要介绍了玩转SpringBoot2快速整合拦截器的方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-09-09
JavaSE XML解析技术的使用方法详解
XML意为可扩展标记语言,被多数技术人员用以选择作为数据传输的载体,成为一种通用的数据交换格式,下面这篇文章主要给大家介绍了关于JavaSE XML解析技术的使用方法,需要的朋友可以参考下
2023-04-04
SpringBoot2整合Redis实现读写操作
Redis，对于大家来说应该不陌生，是经常使用的开发技术之一。本文将结合实例代码，介绍SpringBoot2整合Redis实现读写操作，感兴趣的小伙伴们可以参考一下
2021-07-07
Java中泛型的示例详解
泛型机制在项目中一直都在使用，不仅如此，很多源码中都用到了泛型机制。本文将通过一些示例带大家深入了解一下Java的泛型机制，需要的可以了解一下
2022-10-10
Java构造方法实例详解(动力节点java学院整理)
其实java构造方法很简单，下面通过示例给大家分享java构造方法，非常不错，具有参考借鉴价值，需要的朋友参考下
2017-04-04