当前使用版本
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.9.Final</version>
</dependency>
内容介绍
@Validator注解表示对当前参数的约束生效
常用的约束注解为
@NotNull 表示的对象不能为null
@Null 表示的对象只能为null
@NotEmpty 对于字符串表示的是不能为空字符串,对于数组表示的是不能为空数组
@NotBlank 表示的是 字符串 去掉所有空格 类似str.trim() 以后不能为空和null
@Min 如果为字符串表示的是 字符串的长度,如果为数字表示的是数字的大小,如果为list表示的是list的最小长度
@Size 如果为字符串表示的是 字符串的长度,如果为数字表示的是数字的大小,如果为list表示的是list的最小长度
@Max 如果为字符串表示的是 字符串的长度,如果为数字表示的是数字的大小,如果为list表示的是list的最小长度
使用方式
手动捕获异常
其中@Validated 作用到类
ValidUserBo
上表示对ValidUserBo
中的参数name
进行验证不能为空,如果为空,则result.hasErrors()
中则显示存在异常信息, 如果方法中定义啦BindingResult
类,则不会抛出异常;每个方法中都要进行处理;不推荐使用
@Data
public class ValidUserBo {
@NotNull(message = "name 不能为null")
private String name;
}
@GetMapping("/get/valid")
public ResponseVO valid(@Validated ValidUserBo validUserBo, BindingResult result) {
if (result.hasErrors()) {
throw new IllegalArgumentException("验证异常");
}
return ResponseUtil.success();
}
自动捕获异常
在方法中,不定义
BindingResult
则会吧异常进行抛出,然后用spring
统一异常进行处理
@Data
public class ValidUserBo {
@NotNull(message = "name 不能为null")
private String name;
}
@GetMapping("/get/valid")
public ResponseVO valid(@Validated ValidUserBo validUserBo) {
return ResponseUtil.success();
}
//统一异常处理
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(value = BindException.class)
public ResponseVO personException(BindException e){
log.info("GlobalExceptionHandler.personException ", e);
return ResponseUtil.fail(.getFieldError().getDefaultMessage());
}
}
@Builder
@AllArgsConstructor
@Getter
@Setter
public class ResponseVO<T> {
private int code;
private String message;
private T obj;
}
指定参数验证
对于指定使用参数验证,要使用到的是
@Validated(ValidUserBo.Name.class)
模式,此处验证的是group
为Name
类的参数才进行验证;
@Data
public class ValidUserBo {
@NotNull(message = "name 不能为null", groups = {Name.class})
private String name;
@NotNull(message = "name1 不能为null")
private String name1;
public interface Name{}
}
//使用方式:
@GetMapping("/get/valid")
public ResponseVO valid(@Validated(ValidUserBo.Name.class) ValidUserBo validUserBo) {
return ResponseUtil.success();
}
//此时验证的时候,只会验证 name不能为空,而name1 则不进行任何验证;
自定义 验证
定义注解:
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.TYPE})
@Constraint(validatedBy = CheckSql.class) //表示对应约束的类
public @interface PhoneNo {
String message() default "手机号码无效";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
定义类信息:
//注解两个参数 第一个表示的是,当前注解,第二个表示的是,定义到的字段
public class CheckSql implements ConstraintValidator<PhoneNo, String> {
@Override
public boolean isValid(String s, ConstraintValidatorContext constraintValidatorContext) {
if (s .equals("187")) {
return true;
}
return false;
}
}
用法:
public class ValidUserBo {
@PhoneNo(message = "号码有误", groups = {Name.class})
public String phone;
public interface Name{}
}