返回顶部
首页 > 资讯 > 后端开发 > JAVA >【优雅的参数验证@Validated】@Validated参数校验的使用及注解详解——你还在用if做条件验证?
  • 104
分享到

【优雅的参数验证@Validated】@Validated参数校验的使用及注解详解——你还在用if做条件验证?

springjavaspringboot 2023-08-16 18:08:28 104人浏览 八月长安
摘要

@Validated参数校验的使用及注解详解 你还在用if做条件验证吗?一、优雅的参数验证@Validated1.@Valid和@Validated的用法(区别)2.引入并使用@Validated参数验证 二、javax.val

你还在用if做条件验证吗?

请先看看下面代码:(简单举个例子,代码并不规范)

    @apiOperation("新增用户")    @PostMapping("/addUser")    public ResultVo insert(@ApiParam("用户信息实体") @RequestBody User user){        if(user.getUserName!=null){           throw new BusinessException("用户名称不能为空");        }        if(user.getUserPhone!=null){           throw new BusinessException("用户电话不能为空");        }        if( user.getUserPhone().length()){           throw new BusinessException("用户电话格式不规范");        }        return new ResultVo(userService.insert(user));    }

以上代码主要是为了对用户user实体进行条件验证。
但是那么多的if, 写得纯纯得小白一个,也使得代码显得臃肿不美观不优雅!
接下来,让我们学习使用优雅的参数验证@Validated!

一、优雅的参数验证@Validated

@Valid和@Validated是spring Validation框架提供的参数验证功能。

1.@Valid和@Validated的用法(区别)

二者主要作用在于 都作为标准jsR-303规范,在检验Controller的入参是否符合规范时,使用@Validated或者@Valid在基本验证功能上没有太多区别。但是在分组、注解地方、嵌套验证等功能上两个有所不同:

@Valid:
@Valid注解用于校验,所属包为:javax.validation.Valid。

用在方法入参上无法单独提供嵌套验证功能。**能够用在成员属性(字段)**上,提示验证框架进行嵌套验证。能配合嵌套验证注解@Valid进行嵌套验证。

@Validated:
@Validated是@Valid 的一次封装,是Spring提供的校验机制使用。

用在方法入参上无法单独提供嵌套验证功能。不能用在成员属性(字段)上,也无法提示框架进行嵌套验证。能配合嵌套验证注解@Valid进行嵌套验证。

2.引入并使用@Validated参数验证

  1. 引入校验的依赖包
                    org.springframework.boot            spring-boot-starter                                    javax.validation            validation-api            2.0.1.Final                                    org.hibernate.validator            hibernate-validator        
  1. 找到自己的实体类定义自己要校验的参数
    在这里插入图片描述

在controller的入参处添加@Validated注解(@Validated可以指定groups区别验证,@Valid不可以指定groups,见上面二者区别)

@Validated(addGroup.class)就是给参数进行了分组校验

    @ApiOperation("新增用户")    @PostMapping("/addUser")    public ResultVo insert(@ApiParam("用户信息实体") @Validated(addUser.class) @RequestBody User user){        return new ResultVo(userService.insert(user));    }

那么addGroup.class是哪里来的??什么作用?
addGroup.class:是一个接口类,简单的来说:就是用来给参数做标记的(里面不需要写任何代码)
在这里插入图片描述

到这里基本的使用就结束了!

二、javax.validation.constraints下参数条件注解详解

实现参数验证功能,我们需要@Validated注解配合 在实体类的的参数加上条件验证注解(设置具体的条件限制规则)一起实现参数验证功能。

而这些参数条件注解是由javax.validation.constraints包下提供,主要如下:

  1. @NotNull :被注解的元素必须不为null

  2. @NotBlank注解 :验证注解的元素值不为空(不为null、去除首位空格后长度为0) ,并且类型为String。

  3. @NotEmpty注解 :验证注解的元素值不为null且不为空(字符串长度不为0、集合大小不为0) ,并且类型为String。

  4. @AssertTrue注解 :被注解的元素必须为true,并且类型为boolean。

  5. @AssertFalse注解 :被注解的元素必须为false,并且类型为boolean。

  6. @Min注解 :被注解的元素其值必须大于等于最小值,并且类型为int,long,float,double。

  7. @Max注解:被注解的元素其值必须小于等于最小值,并且类型为int,long,float,double。

  8. @DecimalMin注解 :验证注解的元素值大于等于@DecimalMin指定的value值,并且类型为BigDecimal。

  9. @DecimalMax注解 :验证注解的元素值小于等于@DecimalMax指定的value值 ,并且类型为BigDecimal。

  10. @Range注解 :验证注解的元素值在最小值和最大值之间,并且类型为BigDecimal,BigInteger,CharSequence,byte,short,int,long。

  11. @Past注解 :被注解的元素必须为过去的一个时间,并且类型为java.util.Date。

  12. @Future注解 :被注解的元素必须为未来的一个时间,并且类型为java.util.Date。

  13. @Size注解 :被注解的元素的长度必须在指定范围内,并且类型为String,Array,List,Map。

  14. @Length注解 :验证注解的元素值长度在min和max区间内 ,并且类型为String。

  15. @Digits注解 :验证注解的元素值的整数位数和小数位数上限 ,并且类型为float,double,BigDecimal。

  16. @Pattern注解 :被注解的元素必须符合指定的正则表达式,并且类型为String。

  17. @Email注解: 验证注解的元素值是Email,也可以通过regexp和flag指定自定义的email格式,类型为String。

三、自定义条件注解

如果在写项目的过程中,参数需要的条件注解满足不上,则我们需要自定义注解来完成

步骤:

创建一个自定义的注解类

@Target({ElementType.FIELD,ElementType.METHOD,ElementType.ANNOTATION_TYPE,ElementType.CONSTRUCTOR,ElementType.PARAMETER,ElementType.TYPE_USE})@Retention(RetentionPolicy.RUNTIME)@Documented@Constraint(validatedBy = {ListValueConstraintValidator.class})public @interface ListValue {    //配置路径,后端传递信息    String message() default "{com.itfuture.e.valid.ListValue.message}";        Class[] groups() default {};    Class[] payload() default {};    //自定义一个类型来存放数据(数组)    int[] values() default {};}

创建一个逻辑处理数据的方法

public class ListValueConstraintValidator implements ConstraintValidator {    //set存储    private Set set = new HashSet<>();    //初始化数据    //listValue拿到的是注解中的数据    @Override    public void initialize(ListValue constraintAnnotation) {        //拿到注解中自定义的数据,且是数组型的        int[] values = constraintAnnotation.values();        //放在数组里,遍历判断        for(int value:values){            set.add(value);        }    }    //判断数据是否相同    @Override    public boolean isValid(Integer integer, ConstraintValidatorContext constraintValidatorContext) {        if(set.contains(integer)){            return true;        }        return false;    }}

String message() default “{com.atguigu.common.valid.ListValue.message}”;

这个消息:message() default "{com.atguigu.common.valid.ListValue.message}"也可以通过配置文件去配置:
在这里插入图片描述

在实体类的参数条件中来调用:

在这里插入图片描述

至此,参数验证基本完述!

来源地址:https://blog.csdn.net/weixin_43431218/article/details/127870470

--结束END--

本文标题: 【优雅的参数验证@Validated】@Validated参数校验的使用及注解详解——你还在用if做条件验证?

本文链接: https://lsjlt.com/news/371835.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

猜你喜欢
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作