@Validated
一、优雅的参数验证@Validated
@Valid和@Validated是Spring Validation
框架提供的参数验证功能。
1.@Valid和@Validated的用法(区别)
二者主要作用在于 都作为标准JSR-303规范,在检验Controller的入参是否符合规范时,使用@Validated
或者@Valid
在基本验证功能上没有太多区别。但是在分组、注解地方、嵌套验证等功能上两个有所不同:
@Valid:
@Valid注解用于校验,所属包为:javax.validation.Valid
。
用在方法入参上无法单独提供嵌套验证功能。能够用在成员属性(字段)上,提示验证框架进行嵌套验证。能配合嵌套验证注解@Valid进行嵌套验证。
@Validated:
@Validated
是@Valid
的一次封装,是Spring提供的校验机制使用。
用在方法入参上无法单独提供嵌套验证功能。不能用在成员属性(字段)上,也无法提示框架进行嵌套验证。能配合嵌套验证注解@Valid进行嵌套验证。
- @Validated:用在类型、方法和方法参数上。但不能用于成员属性(field)
- @Valid:可以用在方法、构造函数、方法参数和成员属性(field)
2.引入并使用@Validated参数验证
引入校验的依赖包
<!--第一种方式导入校验依赖:使用springboot时,在org\springframework\spring-context\5.2.1.RELEASE\spring-context-5.2.1.RELEASE.jar-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<!--第二种方式导入校验依赖-->
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>2.0.1.Final</version>
</dependency>
<!--第三种方式导入校验依赖-->
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
</dependency>
2.引入并使用@Validated参数验证
引入校验的依赖包
<!--第一种方式导入校验依赖:使用springboot时,在org\springframework\spring-context\5.2.1.RELEASE\spring-context-5.2.1.RELEASE.jar-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<!--第二种方式导入校验依赖-->
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>2.0.1.Final</version>
</dependency>
<!--第三种方式导入校验依赖-->
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
</dependency>
3.在controller的入参处添加@Validated注解(@Validated
可以指定groups区别验证,@Valid不可以指定groups
@Validated(addGroup.class)
就是给参数进行了分组校验
定义分组接口:
public interface IGroupA {
}
public interface IGroupB {
}
public class StudentBean implements Serializable{
@NotBlank(message = "用户名不能为空")
private String name;
//只在分组为IGroupB的情况下进行验证
@Min(value = 18, message = "年龄不能小于18岁", groups = {IGroupB.class})
private Integer age;
@Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\\d{8}$", message = "手机号格式错误")
private String phoneNum;
@Email(message = "邮箱格式错误")
private String email;
@MyConstraint
private String className;
}
检验分组为IGroupA的情况
@RestController
public class CheckController {
@PostMapping("stu")
public String addStu(@Validated({IGroupA.class}) @RequestBody StudentBean studentBean){
return "add student success";
}
}
1、不分 配groups,默认每次都要进行验证
2、对一个参数需要多种验证方式时,也可通过分配不同的组达到目的。
组序列
定义组序列:
@GroupSequence({Default.class, IGroupA.class, IGroupB.class})
public interface IGroup {
}
需要校验的Bean,分别定义IGroupA对age进行校验,IGroupB对className进行校验:
public class StudentBean implements Serializable{
@NotBlank(message = "用户名不能为空")
private String name;
@Min(value = 18, message = "年龄不能小于18岁", groups = IGroupA.class)
private Integer age;
@Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\\d{8}$", message = "手机号格式错误")
private String phoneNum;
@Email(message = "邮箱格式错误")
private String email;
@MyConstraint(groups = IGroupB.class)
private String className;
二、javax.validation.constraints下参数条件注解详解
实现参数验证功能,我们需要@Validated
注解配合 在实体类的的参数加上条件验证注解(设置具体的条件限制规则)一起实现参数验证功能。
而这些参数条件注解是由javax.validation.constraints
包下提供,主要如下:
-
@NotNull :被注解的元素必须不为null
-
@NotBlank注解 :验证注解的元素值不为空(不为null、去除首位空格后长度为0) ,并且类型为String。
-
@NotEmpty注解 :验证注解的元素值不为null且不为空(字符串长度不为0、集合大小不为0) ,并且类型为String。
-
@AssertTrue注解 :被注解的元素必须为true,并且类型为boolean。
-
@AssertFalse注解 :被注解的元素必须为false,并且类型为boolean。
-
@Min注解 :被注解的元素其值必须大于等于最小值,并且类型为int,long,float,double。
-
@Max注解:被注解的元素其值必须小于等于最小值,并且类型为int,long,float,double。
-
@DecimalMin注解 :验证注解的元素值大于等于
@DecimalMin
指定的value值,并且类型为BigDecimal。 -
@DecimalMax注解 :验证注解的元素值小于等于
@DecimalMax
指定的value值 ,并且类型为BigDecimal。 -
@Range注解 :验证注解的元素值在最小值和最大值之间,并且类型为BigDecimal,BigInteger,CharSequence,byte,short,int,long。
-
@Past注解 :被注解的元素必须为过去的一个时间,并且类型为
java.util.Date
。另外,搜索公众号Linux就该这样学后台回复“Linux”,获取一份惊喜礼包。 -
@Future注解 :被注解的元素必须为未来的一个时间,并且类型为
java.util.Date
。 -
@Size注解 :被注解的元素的长度必须在指定范围内,并且类型为String,Array,List,Map。
-
@Length注解 :验证注解的元素值长度在min和max区间内 ,并且类型为String。
-
@Digits注解 :验证注解的元素值的整数位数和小数位数上限 ,并且类型为float,double,BigDecimal。
-
@Pattern注解 :被注解的元素必须符合指定的正则表达式,并且类型为String。
-
@Email注解:验证注解的元素值是Email,也可以通过regexp和flag指定自定义的email格式,类型为String。
三、自定义条件注解
如果在写项目的过程中,参数需要的条件注解满足不上,则我们需要自定义注解来完成
步骤:
1.创建一个自定义的注解类
/**自定义条件注解
* @author:wxh
* @version:v1.0
*/
@Target({ElementType.FIELD,ElementType.METHOD,ElementType.ANNOTATION_TYPE,ElementType.CONSTRUCTOR,ElementType.PARAMETER,ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = {ListValueConstraintValidator.class})
public @interface ListValue {
//配置路径,后端传递信息
String message() default "{com.itfuture.e.valid.ListValue.message}";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
//自定义一个类型来存放数据(数组)
int[] values() default {};
}
2.创建一个逻辑处理数据的方法
/**自定义显示状态
* @author:wxh
* @version:v1.0
*/
public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {
//set存储
private Set<Integer> set = new HashSet<>();
//初始化数据
//listValue拿到的是注解中的数据
@Override
public void initialize(ListValue constraintAnnotation) {
//拿到注解中自定义的数据,且是数组型的
int[] values = constraintAnnotation.values();
//放在数组里,遍历判断
for(int value:values){
set.add(value);
}
}
//判断数据是否相同
@Override
public boolean isValid(Integer integer, ConstraintValidatorContext constraintValidatorContext) {
if(set.contains(integer)){
return true;
}
return false;
}
}
3.String message() default “{com.atguigu.common.valid.ListValue.message}”;
这个消息:message() default "{com.atguigu.common.valid.ListValue.message}"
也可以通过配置文件去配置:
4.在实体类的参数条件中来调用:
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】博客园社区专享云产品让利特惠,阿里云新客6.5折上折
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 清华大学推出第四讲使用 DeepSeek + DeepResearch 让科研像聊天一样简单!
· 推荐几款开源且免费的 .NET MAUI 组件库
· 实操Deepseek接入个人知识库
· 易语言 —— 开山篇
· Trae初体验
2022-08-15 Nacos 实现原理详解