spring mvc 支持jsr-303 Bean验证框架,默认实现是使用的Hibernate validator。在spring mvc中只需要使用@Validated注解在方法参数上即可对参数对象进行校验。校验结果放在BindingResult中,所以每个被校验的参数后面都需要放一个BindingResult。
因为有时候并不是所有的地方需要的验证都是一样的,例如更新的时候需要id notnull,而插入的时候确需要id为null,所以验证的时候在每个验证条件中都增加了groups属性,用于标识需要哪种校验,而在@validated中可以设置vlue属性,用于和验证条件中的groups配合使用,只有@Validated中的value类型和验证注解中的groups属性一致的时候才进行校验。
303提供的常用的校验注解主要有以下几类
空类型检查
@Null验证对象必须为空
@NotNull验证对象不能为空
@NotBlank 验证对象不能为空字符串
@NotEmpty 验证对象不能为空,集合类型不能为空
长度检查
@Size(min= ,max=) 验证对象长度,支持字符串和集合
@Length 验证字符串长度
数值检查
@Max 验证数字大小是否小于某个数值
@Min 验证数字大小是否大于某个数值
@Digits 验证数字是否符合某个格式例如:整数3为,小数2位
@Range 验证数值是否在某个范围之内
其他检查
@Email 验证是否位邮件格式,若为null则不做校验
@Pattern 验证是否符合正则表达式规则
1.基本使用
@Controller
@RequestMapping("valid")
@Slf4j
public class ValidateController {
private static final String BASE_PATH = "/valid/";
@RequestMapping("index")
public String index(@Validated() Student student,BindingResult result){
if(result.hasErrors()){
StringBuffer sb = new StringBuffer();
List<FieldError> errorList = result.getFieldErrors();
errorList.stream().forEach(error->{
String message = error.getDefaultMessage();
String field = error.getField();
sb.append(field).append(":").append(message).append(",");
});
log.error(sb.toString());
}
return BASE_PATH + "index";
}
}
2.在bean中使用验证注解
@Data
public class Student {
@Length(max = 32,min = 32,groups = {})
private String id;
@NotNull
@Size(max = 50)
private String name;
@Max(100)
@Min(12)
@NotNull
private Integer age;
@NotNull
private String email;
@AssertFalse
private Boolean isLeader;
@WorkOverTime
private String workOverTime;
}
这样在前台请求该方法的时候就会进行自动校验。而校验结果会保存在BindingResult中。可以通过hasErrors判断校验是否通过,getFieldErrors可以获取所有的错误。
3.自定义参数校验
有的时候自带的参数校验类型并不能满足我们的需求,这时我们可以自定校验注解。
定义自定义注解类:
@Constraint(validatedBy = {ValidatedWorkOverTime.class})
@Documented
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface WorkOverTime {
String message() default "加班时长不能超过{max}小时";
int max() default 5;
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
在这个类中我们使用Constraint注解声明我们需要使用哪个类来进行具体的验证。
注解类中必须包含1.错误信息。即message方法,2.验证规则分组,即gourps方法,3.验证的有效负荷即payload方法。
我们还必须实现一个类来进行具体的验证。即上面Constraint声明的类。
@Slf4j
public class ValidatedWorkOverTime implements ConstraintValidator<WorkOverTime,Object> {
private Integer max;
private WorkOverTime workOverTime;
@Override
public void initialize(WorkOverTime constraintAnnotation) {
this.max = constraintAnnotation.max();
this.workOverTime = constraintAnnotation;
}
@Override
public boolean isValid(Object integer, ConstraintValidatorContext constraintValidatorContext) {
Integer overWorkTime = Integer.MAX_VALUE;
if(integer instanceof Integer){
overWorkTime = (Integer) integer;
}else{
try {
overWorkTime = Integer.parseInt(integer.toString());
}catch (Exception e){
log.error(e.toString(),e);
if(e instanceof NumberFormatException){
}
}
}
return max>overWorkTime;
}
}
JSR提供的校验注解:
@Null 被注释的元素必须为 null
@NotNull 被注释的元素必须不为 null
@AssertTrue 被注释的元素必须为 true
@AssertFalse 被注释的元素必须为 false
@Min(value) 被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@Max(value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@DecimalMin(value) 被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@DecimalMax(value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@Size(max=, min=) 被注释的元素的大小必须在指定的范围内
@Digits (integer, fraction) 被注释的元素必须是一个数字,其值必须在可接受的范围内
@Past 被注释的元素必须是一个过去的日期
@Future 被注释的元素必须是一个将来的日期
@Pattern(regex=,flag=) 被注释的元素必须符合指定的正则表达式
Hibernate Validator提供的校验注解:
@NotBlank(message =) 验证字符串非null,且长度必须大于0
@Email 被注释的元素必须是电子邮箱地址
@Length(min=,max=) 被注释的字符串的大小必须在指定的范围内
@NotEmpty 被注释的字符串的必须非空
@Range(min=,max=,message=) 被注释的元素必须在合适的范围内