SpringBoot 表单验证

为什么要实现这个表单验证呢?举个例子,你辛辛苦苦的写了一个录入个人信息的功能,比如年龄这个位置,用户就没看到一下子写了个性别男,一提交,直接报错了。

常用表单验证注解

@NotNull
限制必须不为null

@NotEmpty
验证注解的元素值不为 null 且不为空(字符串长度不为0、集合大小不为0)

@NotBlank
验证注解的元素值不为空(不为null、去除首位空格后长度为0),不同于@NotEmpty,@NotBlank只应用于字符串且在比较时会去除字符串的空格

@Pattern(value)
限制必须符合指定的正则表达式

@Size(max,min)
限制字符长度必须在 min 到 max 之间(也可以用在集合上)

@Email
验证注解的元素值是Email,也可以通过正则表达式和flag指定自定义的email格式

@Max(value)
限制必须为一个不大于指定值的数字

@Min(value)
限制必须为一个不小于指定值的数字

@DecimalMax(value)
限制必须为一个不大于指定值的数字

@DecimalMin(value)
限制必须为一个不小于指定值的数字

@Null
限制只能为null(很少用)

@AssertFalse
限制必须为false (很少用)

@AssertTrue
限制必须为true (很少用)

@Past
限制必须是一个过去的日期

@Future
限制必须是一个将来的日期

@Digits(integer,fraction)
限制必须为一个小数,且整数部分的位数不能超过 integer,小数部分的位数不能超过 fraction (很少用)

SpringBoot 表单数据校验步骤

1. 在实体类中添加校验规则

在对象属性上添加验证,也可以直接在Controller入参上添加

@Data
public class OrderForm {
    //买家姓名
    @NotEmpty(message = "姓名必填")
    private String name;

    //买家手机号
    @NotEmpty(message = "手机号必填")
    private String phone;

    //买家地址
    @NotEmpty(message = "地址必填")
    private String address;

    //买家微信openid
    @NotEmpty(message = "openid必填")
    private String openid;

    //购物车
    @NotEmpty(message = "购物车不能为空")
    private String items;
}

2. 在 Controller 中开启校验

@RestController
@RequestMapping("/buyer/order")
@Slf4j
public class BuyerOrderController {
        public ResultVO<Map<String,String>> create(@Valid OrderForm orderForm,
                                                BindingResult bindingResult){
             //不符合要求
             if(bindingResult.hasErrors()){
		    log.error("【创建订单】 参数不正确,orderForm={}",orderForm);
		    throw new SellException(ResultEnum.PARAM_ERROR.getCode(),
		            bindingResult.getFieldError().getDefaultMessage());
             }
}

@Valid:开启数据校验,假如字段验证不通过,信息绑定到后面定义的 BindingResult;
result :封装了校验的结果

bindingResult.getFieldError().getDefaultMessage():返回的是message中的内容(@NotEmpty(message = “姓名必填”))

需要注意的是@Valid 和 BindingResult 是一 一对应的,如果有多个@Valid,那么每个@Valid后面都需要添加BindingResult用于接收bean中的校验信息

你可能感兴趣的:(SpringBoot)