Spring之数据校验：Validation-阿里云开发者社区

文章目录

前言

一、Spring Validation概述

二、实验一：通过Validator接口实现

三、实验二：Bean Validation注解实现

四、实验三：基于方法实现校验

五、实验四：实现自定义校验

总结

前言

一、Spring Validation概述

二、实验一：通过Validator接口实现

三、实验二：Bean Validation注解实现

四、实验三：基于方法实现校验

五、实验四：实现自定义校验

一、Spring Validation概述

在开发中，我们经常遇到参数校验的需求，比如用户注册的时候，要校验用户名不能为空、用户名长度不超过20个字符、手机号是合法的手机号格式等等。如果使用普通方式，我们会把校验的代码和真正的业务处理逻辑耦合在一起，而且如果未来要新增一种校验逻辑也需要在修改多个地方。而spring validation允许通过注解的方式来定义对象校验规则，把校验和业务逻辑分离开，让代码编写更加方便。Spring Validation其实就是对Hibernate Validator进一步的封装，方便在Spring中使用。

在Spring中有多种校验的方式

第一种是通过实现org.springframework.validation.Validator接口，然后在代码中调用这个类

第二种是按照Bean Validation方式来进行校验，即通过注解的方式。

第三种是基于方法实现校验

除此之外，还可以实现自定义校验

二、实验一：通过Validator接口实现

第一步创建子模块 spring6-validator

第二步引入相关依赖

<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>

第三步创建实体类，定义属性和方法

packagecom.atguigu.spring6.validation.method1;
publicclassPerson {
privateStringname;
privateintage;
publicStringgetName() {
returnname;
    }
publicvoidsetName(Stringname) {
this.name=name;
    }
publicintgetAge() {
returnage;
    }
publicvoidsetAge(intage) {
this.age=age;
    }
}

第四步创建类实现Validator接口，实现接口方法指定校验规则

packagecom.atguigu.spring6.validation.method1;
importorg.springframework.validation.Errors;
importorg.springframework.validation.ValidationUtils;
importorg.springframework.validation.Validator;
publicclassPersonValidatorimplementsValidator {
@Overridepublicbooleansupports(Class<?>clazz) {
returnPerson.class.equals(clazz);
    }
@Overridepublicvoidvalidate(Objectobject, Errorserrors) {
ValidationUtils.rejectIfEmpty(errors, "name", "name.empty");
Personp= (Person) object;
if (p.getAge() <0) {
errors.rejectValue("age", "error value < 0");
        } elseif (p.getAge() >110) {
errors.rejectValue("age", "error value too old");
        }
    }

上面定义的类，其实就是实现接口中对应的方法，

supports方法用来表示此校验用在哪个类型上，

validate是设置校验逻辑的地点，其中ValidationUtils，是Spring封装的校验工具类，帮助快速实现校验。

第五步使用上述Validator进行测试

packagecom.atguigu.spring6.validation.method1;
importorg.springframework.validation.BindingResult;
importorg.springframework.validation.DataBinder;
publicclassTestMethod1 {
publicstaticvoidmain(String[] args) {
//创建person对象Personperson=newPerson();
person.setName("lucy");
person.setAge(-1);
// 创建Person对应的DataBinderDataBinderbinder=newDataBinder(person);
// 设置校验binder.setValidator(newPersonValidator());
// 由于Person对象中的属性为空，所以校验不通过binder.validate();
//输出结果BindingResultresults=binder.getBindingResult();
System.out.println(results.getAllErrors());
    }
}

三、实验二：Bean Validation注解实现

使用Bean Validation校验方式，就是如何将Bean Validation需要使用的javax.validation.ValidatorFactory 和javax.validation.Validator注入到容器中。spring默认有一个实现类LocalValidatorFactoryBean，它实现了上面Bean Validation中的接口，并且也实现了org.springframework.validation.Validator接口。

第一步创建配置类，配置LocalValidatorFactoryBean

@Configuration@ComponentScan("com.atguigu.spring6.validation.method2")
publicclassValidationConfig {
@BeanpublicLocalValidatorFactoryBeanvalidator() {
returnnewLocalValidatorFactoryBean();
    }
}

第二步创建实体类，使用注解定义校验规则

packagecom.atguigu.spring6.validation.method2;
importjakarta.validation.constraints.Max;
importjakarta.validation.constraints.Min;
importjakarta.validation.constraints.NotNull;
publicclassUser {
@NotNullprivateStringname;
@Min(0)
@Max(120)
privateintage;
publicStringgetName() {
returnname;
    }
publicvoidsetName(Stringname) {
this.name=name;
    }
publicintgetAge() {
returnage;
    }
publicvoidsetAge(intage) {
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格式

第三步使用两种不同的校验器实现

（1）使用jakarta.validation.Validator校验

packagecom.atguigu.spring6.validation.method2;
importjakarta.validation.ConstraintViolation;
importjakarta.validation.Validator;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.stereotype.Service;
importjava.util.Set;
@ServicepublicclassMyService1 {
@AutowiredprivateValidatorvalidator;
publicbooleanvalidator(Useruser){
Set<ConstraintViolation<User>>sets=validator.validate(user);
returnsets.isEmpty();
    }
}

（2）使用org.springframework.validation.Validator校验

packagecom.atguigu.spring6.validation.method2;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.stereotype.Service;
importorg.springframework.validation.BindException;
importorg.springframework.validation.Validator;
@ServicepublicclassMyService2 {
@AutowiredprivateValidatorvalidator;
publicbooleanvalidaPersonByValidator(Useruser) {
BindExceptionbindException=newBindException(user, user.getName());
validator.validate(user, bindException);
returnbindException.hasErrors();
    }
}

第四步测试

packagecom.atguigu.spring6.validation.method2;
importorg.junit.jupiter.api.Test;
importorg.springframework.context.ApplicationContext;
importorg.springframework.context.annotation.AnnotationConfigApplicationContext;
publicclassTestMethod2 {
@TestpublicvoidtestMyService1() {
ApplicationContextcontext=newAnnotationConfigApplicationContext(ValidationConfig.class);
MyService1myService=context.getBean(MyService1.class);
Useruser=newUser();
user.setAge(-1);
booleanvalidator=myService.validator(user);
System.out.println(validator);
    }
@TestpublicvoidtestMyService2() {
ApplicationContextcontext=newAnnotationConfigApplicationContext(ValidationConfig.class);
MyService2myService=context.getBean(MyService2.class);
Useruser=newUser();
user.setName("lucy");
user.setAge(130);
user.setAge(-1);
booleanvalidator=myService.validaPersonByValidator(user);
System.out.println(validator);
    }
}

四、实验三：基于方法实现校验

第一步创建配置类，配置MethodValidationPostProcessor

packagecom.atguigu.spring6.validation.method3;
importorg.springframework.context.annotation.Bean;
importorg.springframework.context.annotation.ComponentScan;
importorg.springframework.context.annotation.Configuration;
importorg.springframework.validation.beanvalidation.LocalValidatorFactoryBean;
importorg.springframework.validation.beanvalidation.MethodValidationPostProcessor;
@Configuration@ComponentScan("com.atguigu.spring6.validation.method3")
publicclassValidationConfig {
@BeanpublicMethodValidationPostProcessorvalidationPostProcessor() {
returnnewMethodValidationPostProcessor();
    }
}

第二步创建实体类，使用注解设置校验规则

packagecom.atguigu.spring6.validation.method3;
importjakarta.validation.constraints.*;
publicclassUser {
@NotNullprivateStringname;
@Min(0)
@Max(120)
privateintage;
@Pattern(regexp="^1(3|4|5|7|8)\\d{9}$",message="手机号码格式错误")
@NotBlank(message="手机号码不能为空")
privateStringphone;
publicStringgetName() {
returnname;
    }
publicvoidsetName(Stringname) {
this.name=name;
    }
publicintgetAge() {
returnage;
    }
publicvoidsetAge(intage) {
this.age=age;
    }
publicStringgetPhone() {
returnphone;
    }
publicvoidsetPhone(Stringphone) {
this.phone=phone;
    }
}

第三步定义Service类，通过注解操作对象

packagecom.atguigu.spring6.validation.method3;
importjakarta.validation.Valid;
importjakarta.validation.constraints.NotNull;
importorg.springframework.stereotype.Service;
importorg.springframework.validation.annotation.Validated;
@Service@ValidatedpublicclassMyService {
publicStringtestParams(@NotNull@ValidUseruser) {
returnuser.toString();
    }
}

第四步测试

packagecom.atguigu.spring6.validation.method3;
importorg.junit.jupiter.api.Test;
importorg.springframework.context.ApplicationContext;
importorg.springframework.context.annotation.AnnotationConfigApplicationContext;
publicclassTestMethod3 {
@TestpublicvoidtestMyService1() {
ApplicationContextcontext=newAnnotationConfigApplicationContext(ValidationConfig.class);
MyServicemyService=context.getBean(MyService.class);
Useruser=newUser();
user.setAge(-1);
myService.testParams(user);
    }
}

五、实验四：实现自定义校验

第一步自定义校验注解

packagecom.atguigu.spring6.validation.method4;
importjakarta.validation.Constraint;
importjakarta.validation.Payload;
importjava.lang.annotation.*;
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented@Constraint(validatedBy= {CannotBlankValidator.class})
public@interfaceCannotBlank {
//默认错误消息Stringmessage() default"不能包含空格";
//分组Class<?>[] groups() default {};
//负载Class<?extendsPayload>[] payload() default {};
//指定多个时使用@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
@Documented@interfaceList {
CannotBlank[] value();
    }
}

第二步编写真正的校验类

packagecom.atguigu.spring6.validation.method4;
importjakarta.validation.ConstraintValidator;
importjakarta.validation.ConstraintValidatorContext;
publicclassCannotBlankValidatorimplementsConstraintValidator<CannotBlank, String> {
@Overridepublicvoidinitialize(CannotBlankconstraintAnnotation) {
        }
@OverridepublicbooleanisValid(Stringvalue, ConstraintValidatorContextcontext) {
//null时不进行校验if (value!=null&&value.contains(" ")) {
//获取默认提示信息StringdefaultConstraintMessageTemplate=context.getDefaultConstraintMessageTemplate();
System.out.println("default message :"+defaultConstraintMessageTemplate);
//禁用默认提示信息context.disableDefaultConstraintViolation();
//设置提示语context.buildConstraintViolationWithTemplate("can not contains blank").addConstraintViolation();
returnfalse;
                }
returntrue;
        }
}

总结

以上就是Spring之数据校验：Validation的相关知识点，希望对你有所帮助。

积跬步以至千里，积怠惰以至深渊。时代在这跟着你一起努力哦！

Spring之数据校验：Validation

文章目录

前言

一、Spring Validation概述

二、实验一：通过Validator接口实现

三、实验二：Bean Validation注解实现

四、实验三：基于方法实现校验

五、实验四：实现自定义校验

总结

云原生

热门文章

最新文章

相关课程

相关电子书