一、@Valid 简介
Bean Validation 内置的校验器
| 校验器 | 说明 |
|---|---|
| @Null | 被注解的元素必须为 null |
| @NotNull | 被注解的元素必须不为 null |
| @AssertTrue | 被注解的元素必须为 true |
| @AssertFalse | 被注解的元素必须为 false |
| @Min(value) | 被注解的元素必须是一个数字，其值必须大指定的最小值 |
| @Max | 被注解的元素必须是一个数字，其值必须小于指定的最大值 |
| @DecimalMin | 限制必须为一个不小于指定值的数字 |
| @DecimalMax(value) | 限制必须为一个不大于指定值的数字 |
| @Digits(integer,fraction) | 限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction |
| @Future | 限制必须是一个将来的日期 |
| @Past | 限制必须是一个过去的日期 |
| @Pattern(value) | 限制必须符合指定的正则表达式 |
| @Size(max,min) | 限制字符长度必须在min到max之间 |
| @NotEmpty | 验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0） |
| @NotBlank | 验证注解的元素值不为空（不为null、去除首位空格后长度为0） |
| 验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式 |
二、使用说明
引入依赖
引入Hibernate依赖
<!-- hibernate.validator jar包-->
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
<version>${hibernate.version}</version>
</dependency>
引入spring-boot依赖
<!-- 通过spring-boot依赖引入 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
<version>${validation.version}</version>
</dependency>
单个使用
在需要验证的实体类属性上加入需要验证注解
-
在请求参数加入
@Valid或者@Validated注解@Valid // Java自带的校验器，，不支持组校验 @Validated // Spring 扩展的校验器，支持组校验
分组使用
有时在同一个 PO 类上，同一个属性在不同的请求中验证规则不一样，比如 ID， 在新增时可以为空，但是在更新是不能为空。这种校验方式可以使用 @Validated 根据分组指定校验规则。
1、定义分组
// 分组必须为接口，它只是一个标记类，不需要有任何方法
// 更新分组，
public interface Update {
}
// 新增分组
public interface Add {
}
2、PO指定分组
@Data
public class BannersEntity implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 编号
* 指定校验分组为 Update
*/
@TableId
@NotNull(message = "id不能为空", groups = {Update.class}) //
private Long id;
/**
* 图片名称
* 指定校验分组为 Update 和 add
*/
@NotBlank(message = "图片名称不能为空", groups = {Add.class, Update.class})
private String name;
}
3、请求指定分组
/**
* 保存
* 校验器 @Validated 指定 Add 分组
*/
@RequestMapping("/save")
public R save(@RequestBody
@Validated(value = {Add.class}) BannersEntity banners) {
bannersService.save(banners);
return R.ok();
}
/**
* 修改
* 校验器 @Validated 指定 Update 分组
*/
@RequestMapping("/update")
public R update(@RequestBody @Validated(value = {Update.class}) BannersEntity banners) {
bannersService.updateById(banners);
return R.ok();
}
三、自定义校验
当 组件提供的校验器， 不满足需求时，可以自定义校验器，步骤如下：
1、定义校验注解
// 定义 MyValid 校验主机
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.PARAMETER, ElementType.FIELD}) // 指定可以使用的目标
@Retention(RetentionPolicy.RUNTIME) //
@Constraint(validatedBy = {MyValidConstraint.class}) //指定校验器
public @interface MyValid {
// 其中
String message() default "校验失败"; // 校验不通过时的提示信息
Class<?>[] groups() default {}; // 分组
Class<? extends Payload>[] payload() default {}; // 载体
}
==说明：自定义校验器必须要有 message，groups，payload 这三项，此外可以进行扩展==
2、定义校验器
// 实现接口 ConstraintValidator
public class MyValidConstraint implements ConstraintValidator<MyValid, Object> {
private MyValid myValid;
@Override
public void initialize(MyValid myValid) {
this.myValid = myValid;
}
@Override
public boolean isValid(Object value, ConstraintValidatorContext context) {
// TODO 此处些具体校验逻辑
return true; // 返回 true 表示验证通过，false 表示验证失败
}
}
