0%

SpringBoot统一校验工具类

基于SpringBoot引入依赖

1
2
3
4
 <dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
</dependency>

JSR 303规范

空检查

注解 详情
@Null 验证对象是否为null
@NotNull 验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty 检查约束元素是否为NULL或者是EMPTY.

Booelan检查

注解 详情
@AssertTrue 验证 Boolean 对象是否为 true
@AssertFalse 验证 Boolean 对象是否为 false

长度检查

注解 详情
@Size(min=, max=) 验证对象(Array,Collection,Map,String)长度是否在给定的范围之内
@Length(min=, max=) Validates that the annotated string is between min and max included.

日期检查

注解 详情
@Past 验证 Date 和 Calendar 对象是否在当前时间之前,验证成立的话被注释的元素一定是一个过去的日期
@Future 验证 Date 和 Calendar 对象是否在当前时间之后 ,验证成立的话被注释的元素一定是一个将来的日期
@Pattern 验证 String 对象是否符合正则表达式的规则,被注释的元素符合制定的正则表达式,regexp:正则表达式 flags: 指定 Pattern.Flag 的数组,表示正则表达式的相关选项。

数值检查

建议使用在Stirng,Integer类型,不建议使用在int类型上,因为表单值为“”时无法转换为int,但可以转换为Stirng为”“,Integer为null

注解 详情
@Min 验证 Number 和 String 对象是否大等于指定的值
@Max 验证 Number 和 String 对象是否小等于指定的值
@DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
@DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
@Digits 验证 Number 和 String 的构成是否合法
@Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字,interger指定整数精度,fraction指定小数精度。
@Range(min=, max=) 被指定的元素必须在合适的范围内
@Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
@CreditCardNumber 信用卡验证
@Email 验证是否是邮件地址,如果为null,不进行验证,算通过验证。
@ScriptAssert(lang= ,script=, alias=) 指定校验方法
@URL(protocol=,host=, port=,regexp=, flags=) 校验URL

校验工具类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
/**
* 校验参数
*
*/
public class VerifyUtils {

/**
* 使用Validator框架校验类
*
* @param detail 要校验的类
* @param exception 是否直接抛出异常
* @return 校验失败的字段。。只会返回其中一个
*/
public static <T> String verifyObject(T detail, boolean exception) {
String res = verifyObject(detail);
if (exception) {
if (StringUtils.isNotBlank(res)) {
throw new Exception(ResultCode.PRECONDITION_CHECK_ERROR, res);
}
}
return res;
}

/**
* 使用Validator框架校验类
*
* @param detail 要校验的类
* @return 校验失败的字段。。只会返回其中一个
*/
public static <T> String verifyObject(T detail) {
ValidatorFactory vf = Validation.buildDefaultValidatorFactory();
Validator validator = vf.getValidator();
Set<ConstraintViolation<T>> set = validator.validate(detail);
for (ConstraintViolation<T> constraintViolation : set) {
return constraintViolation.getPropertyPath().toString() + constraintViolation.getMessage();
}
return null;
}

}

Controller

在Controller中开启,需要在controller上加上@Validated注解。

1
2
3
4
5
6
7
8
9
10
11
12
import javax.validation.Valid;
import org.springframework.validation.annotation.Validated;

@RestController
@RequestMapping("/test")
@Validated
public class TestController{

public void createProcess(@RequestBody @Valid TestParam param) {

}
}

在校验不通过时会抛出MethodArgumentNotValidException异常,可使用@ExceptionHandler对这种参数异常统一返回结果