Spring Validation参数校验

Validation

Validation是Spring提供的一个参数校验框架，使用预定义的注解完成参数校验

使用步骤

1. 引入Spring Validation起步依赖
2. 在需要校验的参数所在的类上添加@Validated注解
3. 在需要校验的参数前面加上@Pattern注解

    <!--参数校验依赖--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-validation</artifactId></dependency>

引入起步依赖后要刷新maven

//值不能为null
@NotNull//值不能为null，并且内容不为空
@NotEmpety//满足邮箱格式
@Email//验证传递数据是不是URL
@URL

Validation校验失败，异常处理

使用全局异常处理器

由于各个接口需要校验的条件不同，则需要使用分组校验

分组校验：把校验项归类分组，在完成不同的功能时，校验可以指定组中的校验项

实施步骤

1. 定义分组
   1. 在实体类部定义接口，一个接口表示一个分组
2. 定义校验时 指定归属的分组
   1. 在校验项中，通过给groups赋值，指定校验项的分组
   2. groups是一个数组，同一个校验项 可以指定 多个分组
3. 校验时 指定要校验的分组
   1. 通过给@Validated注解的value属性赋值指定校验分组

@Validated
public class Category {//@NotNull表示不能不传//@NotEmpty表示必须传，传的字符串还不能是空字符串//定义校验时指定归属的分组//属于Update组@NotNull(groups = Update.class)private Integer id;@NotEmpty//属于default分组，(groups = {Update.class, Add.class})private String categoryName;//分类名称//如果说某个校验项没有指定分组，默认属于default分租//分组之间可以继承，A extends B  那么A中拥有B中所有的校验项//定义分组校验//add校验组public interface Add extends Default {}//Update校验组public interface Update extends Default{}
}

自定义校验

已有的注解不能满足所有的校验需求，特殊的情况需要自定义校验（自定义校验注解）

1. 自定义注解State 
2. 自定义校验数据的类StateValidation，实现ConstraintValidator接口
3. 在需要校验的地方使用自定义注解

//自定义validation注解@Documented//元注解，标识State//元注解，用来标识这个State注解可以用在那些地方，类、属性、方法
@Target({FIELD})//元注解，标识State注解会在哪个阶段保留，编译、源码阶段、运行时阶段
@Retention(RetentionPolicy.RUNTIME)//指定谁给注解提供校验规则，校验的类还未定义好，因此{}里为空
//指定提供校验规则的类StateValidation.class
@Constraint(validatedBy = {StateValidation.class})public @interface State {//提供校验失败时的提示信息String message() default "校验失败";//指定分组Class<?>[] groups() default {};//负载，获取到State注解的附加信息Class<? extends Payload>[] payload() default {};
}

自定义校验数据的类StateValidation

//ConstraintValidator<给哪个注解提供校验规则,校验的数据类型>
public class StateValidation implements ConstraintValidator<State,String> {/*** @param value 将来要校验的数据* @param constraintValidatorContext* @return false:校验不通过，true：校验通过*/@Overridepublic boolean isValid(String value, ConstraintValidatorContext constraintValidatorContext) {//提供校验规则if (value==null){return false;}if (value.equals("已发布")||value.equals("草稿")) {return true;}return false;}
}

dto校验也不错