1. 概述
在开发中,我们经常遇到参数校验的需求,比如用户注册的时候,要校验用户名不能为空、用户名长度不超过20个字符、手机号是合法的手机号格式等等。如果使用普通方式,我们会把校验的代码和真正的业务处理逻辑耦合在一起,而且如果未来要新增一种校验逻辑也需要在修改多个地方。而spring validation允许通过注解的方式来定义对象校验规则,把校验和业务逻辑分离开,让代码编写更加方便。Spring Validation其实就是对Hibernate Validator进一步的封装,方便在Spring中使用。
在Spring中有多种校验的方式
2. 通过Validator接口实现数据校验
1.引入依赖
<dependencies>
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
<version>7.0.5.Final</version>
</dependency>
<dependency>
<groupId>org.glassfish</groupId>
<artifactId>jakarta.el</artifactId>
<version>4.0.1</version>
</dependency>
</dependencies>
2.定义实体类
public class Person {
private String name;
private Integer age;
3.实现Validator接口,设置校验规则
package com.itgyl.method1;
import org.springframework.validation.Errors;
import org.springframework.validation.ValidationUtils;
import org.springframework.validation.Validator;
public class PersonValidation implements Validator {
@Override
public boolean supports(Class<?> clazz) {
return Person.class.equals(clazz);
}
@Override
public void validate(Object target, Errors errors) {
//target为要校验的实例化对象
Person p = (Person) target;
//通过Validation工具类设置
ValidationUtils.rejectIfEmpty(errors, "name.empty", "name is empty");
if (p.getAge() < 0) {
errors.rejectValue("age", "age.value.error1", "age is error value1");
} else if (p.getAge() > 200) {
errors.rejectValue("age", "age.value.error2", "age is error value2");
}
}
}
4.测试代码
public static void main(String[] args) {
//创建person对象
Person p = new Person();
//p.setAge(201);
//创建对象p对应的数据校验器DataBinder
DataBinder db = new DataBinder(p);
//设置校验
db.setValidator(new PersonValidation());
//通过校验方法校验数据
db.validate();
//获取校验结果
BindingResult bindingResult = db.getBindingResult();
System.out.println(bindingResult.getAllErrors());
}
3. 通过注解方式实现数据校验
1.创建配置类
//创建配置类,基于bean注解方式实现
@Configuration
@ComponentScan("com.itgyl.method2")
public class validatorConfig {
@Bean
public LocalValidatorFactoryBean validator() {
return new LocalValidatorFactoryBean();
}
}
2.创建实体类,通过注解设置校验规则
//创建实体类,使用注解进行数据校验
public class User {
@NotNull
private String name;
@Min(0)
@Max(150)
private int age;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
}
@NotNull 限制必须不为null
@NotEmpty 只作用于字符串类型,字符串不为空,并且长度不为0
@NotBlank 只作用于字符串类型,字符串不为空,并且trim()后不为空串@DecimalMax(value) 限制必须为一个不大于指定值的数字
@DecimalMin(value) 限制必须为一个不小于指定值的数字
@Max(value) 限制必须为一个不大于指定值的数字
@Min(value) 限制必须为一个不小于指定值的数字
@Pattern(value) 限制必须符合指定的正则表达式
@Size(max,min) 限制字符长度必须在min到max之间
@Email 验证注解的元素值是Email,也可以通过正则表达式和flag指定自定义的email格式
3.使用两种不同校验器实现
校验器一:
//使用不同的校验器进行数据校验
//jakarta.validation.Validator原生校验器
@Service
public class MyService1 {
@Autowired
private Validator validator;
public boolean validator1(User user) {
Set<ConstraintViolation<User>> validate = validator.validate(user);
//返回是否为空
return validate.isEmpty();
}
}
校验器二:
//org.springframework.validation.Validator
@Service
public class MyService2 {
@Autowired
private Validator validator;
public boolean validator2(User user) {
BindException bindException = new BindException(user, user.getName());
validator.validate(user, bindException);
List<ObjectError> allErrors = bindException.getAllErrors();
System.out.println(allErrors);
//返回是否含有错误
return bindException.hasErrors();
}
}
4.测试代码
@Test
public void method1() {
//创建管理bean对象的IoC容器,基于全注解创建bean对象
AnnotationConfigApplicationContext context =
new AnnotationConfigApplicationContext(validatorConfig.class);
User user = new User();
//获取要实例化对象的bean的字节码文件,完成对象自动创建
MyService1 myService1 = context.getBean(MyService1.class);
System.out.println(myService1.validator1(user));
}
@Test
public void method2() {
//创建管理bean对象的IoC容器,基于全注解实例化bean对象
AnnotationConfigApplicationContext context =
new AnnotationConfigApplicationContext(validatorConfig.class);
//完成对象自动注入
MyService2 myService2 = context.getBean(MyService2.class);
User user = new User();
user.setName("张三");
user.setAge(250);
System.out.println(myService2.validator2(user));
}
4. 通过方法实现数据校验
1.创建配置类
//基于方法实现数据校验管理
@Configuration
@ComponentScan("com.itgyl.method3")
public class ValidatorConfig {
@Bean
public MethodValidationPostProcessor validationPostProcessor() {
return new MethodValidationPostProcessor();
}
}
2.创建实体类 ,通过注解设置校验规则
//定义实体类通过注解设置校验规则
public class User {
@NotNull
private String name;
@Pattern(regexp = "^1(3|4|5|7|8)\\d{9}$",message = "手机号码格式错误")
@NotBlank(message = "手机号不能为空")
private String phoneNum;
3.定义service类,通过注解操作对象
@Service
@Validated
public class MyService {
public String validator3(@NotNull @Valid User user) {
return user.toString();
}
}
4.测试类代码
@Test
public void testValidator() {
//通过全注解管理bean,创建IoC容器
AnnotationConfigApplicationContext context =
new AnnotationConfigApplicationContext(ValidatorConfig.class);
MyService myService = context.getBean(MyService.class);
User user = new User();
myService.validator3(user);
}
5. 自定义校验
1.自定义注解
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = {CannotBlankValidator.class})
public @interface CannotBlank {
//默认错误消息
String message() default "不能包含空格";
//分组
Class<?>[] groups() default {};
//负载
Class<? extends Payload>[] payload() default {};
//指定多个时使用
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@interface List {
CannotBlank[] value();
}
}
2.编写真正的校验类
public class CannotBlankValidator implements ConstraintValidator<CannotBlank, String> {
@Override
public void initialize(CannotBlank constraintAnnotation) {
}
@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
//null时不进行校验
if (value != null && value.contains(" ")) {
//获取默认提示信息
String defaultConstraintMessageTemplate = context.getDefaultConstraintMessageTemplate();
System.out.println("default message :" + defaultConstraintMessageTemplate);
//禁用默认提示信息
context.disableDefaultConstraintViolation();
//设置提示语
context.buildConstraintViolationWithTemplate("can not contains blank").addConstraintViolation();
return false;
}
return true;
}
}