当前位置：首页 > article >正文

Guava中Preconditions校验

article 2024/9/23 18:09:01

Guava中Preconditions校验

- 场景引入
- Guava 参数校验 Preconditions
- - pom 依赖引入
  - 常用的方法

场景引入

提出疑问？为什么不直接使用 jsr330校验注解对实体类进行校验呢？

答：不同的场景，如短信码验证登录，账号密码登录此类的实体，对于字段是否必填并不是必须的。

@Data
class UserLoginDTO {
    // @NotBlank(message = "手机号不能为空")
    private String phone;

    // @NotBlank(message = "验证码不能为空")
    private String code;
    
    // @NotBlank(message = "密码不能为空")
    private String password;
}

应对这样的dto实体，只能在业务中进行判空处理，如下面的操作：

if (StringUtils.isBlank(userLoginDTO.getPhone())) {
    // ...
}
if (StringUtils.isBlank(userLoginDTO.getCode())) {
    // ...
}
if (StringUtils.isBlank(userLoginDTO.getPassword())) {
    // ...
}

如果输入参数少的时候，还好，如果很多就会变成大量的if(判空操作)，很不优雅…

此时就可以使用 guava 的 Preconditions来完成上面的判空操作了，如：

Preconditions.checkArgument(StringUtils.isNotBlank(userLoginDTO.getPhone()), "手机号不能为空");
Preconditions.checkArgument(StringUtils.isNotBlank(userLoginDTO.getCode()), "验证码不能为空");
Preconditions.checkArgument(StringUtils.isNotBlank(userLoginDTO.getPassword()), "密码不能为空");

Guava 参数校验 Preconditions

pom 依赖引入

<dependency>
  <groupId>com.google.guava</groupId>
  <artifactId>guava</artifactId>
  <version>版本号</version>
</dependency

常用的方法

简单的列举Guava中Preconditions类的一些常用校验方法：

方法名	描述	抛出异常
`checkArgument(boolean expression, String errorMessageTemplate, Object... errorMessageArgs)`	校验方法参数。如果`expression`为`false`，则抛出`IllegalArgumentException`	`IllegalArgumentException`
`checkNotNull(T reference)`	校验`reference`不为`null`。如果为`null`，则抛出`NullPointerException`	`NullPointerException`
`checkNotNull(T reference, String errorMessage)`	类似于`checkNotNull(T reference)`，但允许提供一个错误消息	`NullPointerException`
`checkState(boolean expression)`	校验程序状态。如果`expression`为`false`，则抛出`IllegalStateException`	`IllegalStateException`
`checkState(boolean expression, String errorMessageTemplate, Object... errorMessageArgs)`	类似于`checkArgument`，但抛出的是`IllegalStateException`	`IllegalStateException`
`checkElementIndex(int index, int size, String desc)`	校验索引是否有效（大于等于0且小于`size`）。如果无效，则抛出`IndexOutOfBoundsException`	`IndexOutOfBoundsException`
`checkPositionIndex(int index, int size, String desc)`	类似于`checkElementIndex`，但允许索引等于`size`	`IndexOutOfBoundsException`
`checkPositionIndexes(int start, int end, int size, String desc)`	校验起始和结束索引是否有效，用于表示子序列范围	`IndexOutOfBoundsException`