跳到主要内容

参数校验指南

1.基础参数校验​

基础参数是指 方法中直接传入的 String、Integer 等，非封装的对象。

1) 需要在controller上添加@Validated

2) 在需要校验的参数前加校验注解和提示语：如@Email(message=”您输入的邮箱格式不正确”)

import org.springframework.validation.annotation.Validated;
import javax.validation.constraints.NotBlank;

@Validated
public class BrandAdminController {
    @PostMapping("/add")
    public String add (@NotBlank(message = "名称不能为空") String name){
        
        return '...';
    }
}

注意：注解是 javax.validation.constraints 包下的

2.以封装类型传入的参数。​

1)需要在封装的实体需要校验的属性上添加校验注解和提示语。

2)在实体类上加上相应的注解

3)需要在参数实体前加@Valid


 @PostMapping("/add")
public String add(@Valid Student student){

    return "...";
}
import javax.validation.constraints.NotBlank;
public class Student {
    @NotBlank(message="用户名不能为空")
    private String name;
     //geter and seter 
}

3.当传入的两个封装类型具有相同属性时，比如Student和Teacher都有name属性，那么需要在controller中进行前缀绑定，并且请求的参数需要添加前缀​

@InitBinder("student")
public void initStudentBinder(WebDataBinderbinder){
    binder.setFieldDefaultPrefix("student.");
}

@InitBinder("teacher")
public void initTeacherBinder(WebDataBinderbinder){

    binder.setFieldDefaultPrefix("teacher.");

}

4.一些常用的校验注解​

验证注解验证的数据类型说明
@AssertFalseBoolean,boolean验证注解的元素值是false
@AssertTrueBoolean,boolean验证注解的元素值是true
@NotNull任意类型验证注解的元素值不是null
@Null任意类型验证注解的元素值是null
@Min(value=值)BigDecimal，BigInteger,byte,short,int,long，等任何Number或CharSequence（存储的是数字）子类型验证注解的元素值大于等于@Min指定的value值
@Max（value=值）和@Min要求一样验证注解的元素值小于等于@Max指定的value值
@DecimalMin(value=值)和@Min要求一样验证注解的元素值大于等于@DecimalMin指定的value值
@DecimalMax(value=值)和@Min要求一样验证注解的元素值小于等于@DecimalMax指定的value值
@Digits(integer=整数位数,fraction=小数位数)和@Min要求一样验证注解的元素值的整数位数和小数位数上限
@Size(min=下限,max=上限)字符串、Collection、Map、数组等验证注解的元素值的在min和max（包含）指定区间之内，如字符长度、集合大小
@Pastjava.util.Date,java.util.Calendar;JodaTime类库的日期类型验证注解的元素值（日期类型）比当前时间早
@Future与@Past要求一样验证注解的元素值（日期类型）比当前时间晚
@NotBlankCharSequence子类型验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的首位空格
@Length(min=下限,max=上限)CharSequence子类型验证注解的元素值长度在min和max区间内
@NotEmptyCharSequence子类型、Collection、Map、数组验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
@Range(min=最小值,max=最大值)BigDecimal,BigInteger,CharSequence,byte,short,int,long等原子类型和包装类型验证注解的元素值在最小值和最大值之间
@Email(regexp=正则表达式,flag=标志的模式)CharSequence子类型（如String）验证注解的元素值是Email，也可以通过regexp和flag指定自定义的email格式
@Pattern(regexp=正则表达式,flag=标志的模式)String，任何CharSequence的子类型验证注解的元素值与指定的正则表达式匹配
@Valid任何非原子类型指定递归验证关联的对象；如用户对象中有个地址对象属性，如果想在验证用户对象时一起验证地址对象的话，在地址对象上加@Valid注解即可级联验证