接口参数校验javax.validation.constraints的使用

javax.validation.constraints的使用
后台开发需要对对象的传进来的参数进行校验,有专门的校验工具,validation bean 是基于JSR-303标准开发出来的,使用注解方式实现,及其方便,但是这只是一个接口,没有具体实现.Hibernate Validator是一个hibernate独立的包,可以直接引用,他实现了validation bean同时有做了扩展,比较强大。

git项目介绍为:

https://github.com/CodingDocs/springboot-guide/blob/master/docs/spring-bean-validation.md

要使用在pom.xml里添加依赖

 

常用注解:
代码    说明
@Null     被注解的元素必须为null
@NotNull     被注解的元素必须不为null
@AssertTrue     被注解的元素必须为true
@AssertFalse     被注解的元素必须为false
@Min(value)     被注解的元素必须为数字,其值必须大于等于最小值
@Max(value)     被注解的元素必须为数字,其值必须小于等于最小值
@Size(max,min)     被注解的元素的大小必须在指定范围内
@Past     被注解的元素必须为过去的一个时间
@Future     被注解的元素必须为未来的一个时间
@Pattern     被注解的元素必须符合指定的正则表达式

在方法入参中添加
@NotNull(message = "公共入参不能为空") CommonParam commonParam调用方法时即可验证
或者利用
 @Valid
  private CarrierInfoDTO carrierInfoDTO;
 @Length(
        max = 200,
        message = "年龄不能超过200"
    )
 @Range(
     min = 2L,
     max = 4L,
     message = "改址类型不合要求"
  )
 @NotNull(
        message = "号码为空"
    )
 @Within(
        values = {0L, 2L, 3L, 4L, 7L, 9L, 10L, 11L, 12L},
        message = "类型(signType)不合法"
    )
    
<dependency>
            <groupId>javax.validation</groupId>
            <artifactId>validation-api</artifactId>
            <scope>provided</scope>
            <version>2.0.1.Final</version>
        </dependency>
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-validator</artifactId>
            <scope>provided</scope>
            <version>6.0.16.Final</version>
        </dependency>

可以先封装如下一个方法:        
public static String validateObject(Object object) {
        Set<ConstraintViolation<Object>> constraintViolations = validator.validate(object, new Class[0]);
        StringBuilder sb = new StringBuilder();
        Iterator var3 = constraintViolations.iterator();

        while(var3.hasNext()) {
            ConstraintViolation violation = (ConstraintViolation)var3.next();
            sb.append(violation.getMessage()).append(";");
        }

        return sb.toString();
    }
调用时用
// 参数校验
        String errorMsg = validateObject(UserDto);
        if (StringUtils.isNotBlank(errorMsg)) {
            throw new IllegalArgumentException("用户添加信息失败结果" + errorMsg);
        }
或者在controller方法处添加NOTNull注解,在调用到时会进入判断
@NotNull(message = "公共入参不能为空") CommonParam commonParam

也可使用google的Preconditions进行判断
为啥要用Preconditions,如果是空指针在用的时候,他自己就会抛出异常啊。
但是我们期望的是尽早抛出异常,而不是等到数据被层层传递,传递到非常深的位置,
这样浪费系统资源更不利于我们开发精确定位错误。
所以推荐在方法的入口,或运算开始前,先检查数据。
  Preconditions.checkArgument(StringUtils.isNotBlank(userDao.getRName()), "用户名称不能为空");
  主要有如下方法

1 .checkArgument(boolean) :
功能描述:检查boolean是否为真。 用作方法中检查参数
失败时抛出的异常类型: IllegalArgumentException

2.checkNotNull(T):     
功能描述:检查value不为null, 直接返回value;
失败时抛出的异常类型:NullPointerException

3.checkState(boolean):
功能描述:检查对象的一些状态,不依赖方法参数。 例如, Iterator可以用来next是否在remove之前被调用。
失败时抛出的异常类型:IllegalStateException

4.checkElementIndex(int index, int size):
功能描述:检查index是否为在一个长度为size的list, string或array合法的范围。 index的范围区间是[0, size)(包含0不包含size)。无需直接传入list, string或array, 只需传入大小。返回index。   
失败时抛出的异常类型:IndexOutOfBoundsException


5.checkPositionIndex(int index, int size):
功能描述:检查位置index是否为在一个长度为size的list, string或array合法的范围。 index的范围区间是[0, size)(包含0不包含size)。无需直接传入list, string或array, 只需传入大小。返回index。
失败时抛出的异常类型:IndexOutOfBoundsException

6.checkPositionIndexes(int start, int end, int size):
功能描述:检查[start, end)是一个长度为size的list, string或array合法的范围子集。伴随着错误信息。
失败时抛出的异常类型:IndexOutOfBoundsException

 

  • 1
    点赞
  • 20
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
javax.validation.constraints.NotEmpty是一个用于验证字段不为空的约束注解。它可以应用于String、Collection、Map和数组等类型的字段上。被@NotEmpty注解修饰的字段不能为null且不能为空。\[3\]在引用\[2\]中的示例中,@NotEmpty(message = "ID不能为空")应用于List<String>类型的userIds字段,表示该字段不能为null且不能为空。因此,在创建的类对象中,如果userIds字段为null或者为空集合,就会出现"执行报错:No validator could be found for constraint 'javax.validation.constraints.NotEmpty' validating type 'java.lang.Long'. Check configuration for 'id'"的错误提示。\[1\] #### 引用[.reference_title] - *1* [No validator could be found for constraint ‘javax.validation.constraints.NotEmpty‘...报错解决](https://blog.csdn.net/qq_40816795/article/details/127109993)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^insertT0,239^v3^insert_chatgpt"}} ] [.reference_item] - *2* [validation校验包常用校验注解@NotEmpty,@NotBlank,@NotNull等注解](https://blog.csdn.net/Ying_ph/article/details/125908693)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^insertT0,239^v3^insert_chatgpt"}} ] [.reference_item] - *3* [javax.validation.constraints中@NotEmpty,@NotNull,@NotBlank的区别](https://blog.csdn.net/m0_51176516/article/details/117456403)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^insertT0,239^v3^insert_chatgpt"}} ] [.reference_item] [ .reference_list ]

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值