一、前言
搭建springboot项目,我们都是采用的Restful接口,那么问题来了,当前端调用接口或者是其他项目调用时,我们不能单一靠调用方来控制参数的准确性,自己也要对一些非空的值进行判定。
二、方案
按照我们以往的做法,都是对request中的参数一个一个进行非空判定。
Model:
-
public class Order {
-
private Long userID;
-
private Long addressID;
-
private String comment;
-
}
Controller:
-
@PostMapping("/createOrders")
-
public String createOrders(@RequestBody Order dto) {
-
if(dto.getUserID==null)
-
return "userID不能为空";
-
if(dto.getAddressID==null)
-
return "addressID不能为空";
-
if(dto.getComment==null)
-
return "comment不能为空";
-
return "sucess";
-
}
这种做法首先是可取的,能达到我们的要求,但是这样如果model字段过多,判定的就很多,相对维护起来就不是那么方便,其次增加controller层的负担,既然我们来到spring4的时代,就应该适应使用注解的趋势,下面是使用注解后的比变化。
Model:
-
public class Order {
-
@NotNull(message = "用户ID不能为空")
-
private Long userID;
-
-
@NotNull(message = "收货人地址id不能为空")
-
private Long addressID;
-
-
@NotBlank(message = "备注不为空")
-
private String comment;
-
}
Controller:
-
@PostMapping("/createOrders")
-
public String createOrders(@RequestBody @Valid Order dto, BindingResult results) {
-
if (results.hasErrors())
-
return results.getFieldError().getDefaultMessage();
-
return "success";
-
}
这样我们就只需要在model字段上加上非空验证和相应提示语就好了。
三、常用的校验注解
-
javax.validation.constraints.NotNull
-
@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(value) 被注释的元素必须符合指定的正则表达式。
-
@Email 被注释的元素必须是电子邮件地址
-
@Length 被注释的字符串的大小必须在指定的范围内
-
@NotEmpty 被注释的字符串必须非空
-
@Range 被注释的元素必须在合适的范围内
补充:
@Valid 注解类型的使用:
@Null
限制只能为null
@NotNull
限制必须不为null
@AssertFalse
限制必须为false
@AssertTrue
限制必须为true
@DecimalMax(value)
限制必须为一个不大于指定值的数字
@DecimalMin(value)
限制必须为一个不小于指定值的数字
@Digits(integer,fraction)
限制必须为一个小数,且整数部分的位数不能超过integer,小数部分的位数不能超过fraction
@Future
限制必须是一个将来的日期
@Max(value)
限制必须为一个不大于指定值的数字
@Min(value)
限制必须为一个不小于指定值的数字
@Past
限制必须是一个过去的日期
@Pattern(value)
限制必须符合指定的正则表达式
@Size(max,min)
限制字符长度必须在min到max之间
@Past
验证注解的元素值(日期类型)比当前时间早
@NotEmpty
验证注解的元素值不为null且不为空(字符串长度不为0、集合大小不为0)
@NotBlank
验证注解的元素值不为空(不为null、去除首位空格后长度为0),不同于@NotEmpty,@NotBlank只应用于字符串且在比较时会去除字符串的空格
@Email
验证注解的元素值是Email,也可以通过正则表达式和flag指定自定义的email格式
原文地址:https://blog.csdn.net/albenxie/article/details/91884052