Spring之数据校验：Vaildation
数据校验：Vaildation
前言
前言介绍了笔者所知道的最常用的技术，但是本文主要是用于Spring reviewed，所以下面步骤介绍不涉及到spring基础以外技术内容实现。
数据校验是在处理请求之前对数据进行验证的过程。Spring MVC提供了一个校验框架，可以使用注解和Validator接口来定义和执行校验规则。
1、注解
Spring MVC校验框架中最常用的注解是@Valid和@NotBlank。其中，@Valid注解用于对一个Java Bean对象进行校验，而@NotBlank注解则用于对一个String类型的数据进行非空校验。除此之外，Spring MVC校验框架还提供了许多其他的注解，包括：
- @NotNull：用于校验对象是否为null。
- @Size：用于校验字符串、集合或数组的长度。
- @Pattern：用于校验字符串是否符合正则表达式。
- @Min和@Max：用于校验数字的大小范围。
- @Email：用于校验邮箱地址是否符合规范等等。
2、Validator接口
Validator接口是Spring MVC校验框架中的另一种校验方式，它允许你自定义校验规则。要使用Validator接口，你需要实现它的validate方法，并在其中编写校验逻辑。Validator接口的使用步骤如下：
- 创建一个校验器类，实现Validator接口。
- 在校验器类中编写校验规则。
- 在Controller方法或模型(Model)对象上执行校验。
3、校验错误处理
当校验失败时，Spring MVC会生成一个包含错误信息的BindingResult对象。你可以在Controller方法或模型(Model)对象中使用BindingResult对象来获取校验失败的详细信息，并生成适当的错误响应。通常，你可以将BindingResult对象和Model对象一起传递给视图，以便在视图中显示错误信息。
综上所述，Spring MVC提供了强大的数据校验功能，可以大大简化数据校验的过程。如果你需要对请求参数或模型(Model)对象进行校验，Spring MVC的校验框架是一个非常有用的工具。
准备工作
1、引入依赖
hibernate-validator是一个流行的Java数据校验器库，它基于JSR 380规范实现了Bean Validation 2.0 API，并提供了许多常用的校验注解和校验器。jakarta.el是一个用于支持EL表达式的库，它是JavaEE规范的一部分，用于在Java应用程序中对数据进行动态绑定和计算。
如果你使用的是Spring Boot框架，它已经自带了数据校验器的依赖，并默认使用Hibernate Validator作为校验器实现。因此，你不需要手动配置这些依赖，只需要在代码中使用相关的注解和API即可。
<dependencies>
<dependency>
<groupId>org.hibernate.validatorgroupId>
<artifactId>hibernate-validatorartifactId>
<version>7.0.5.Finalversion>
dependency>
<dependency>
<groupId>org.glassfishgroupId>
<artifactId>jakarta.elartifactId>
<version>4.0.1version>
dependency>
dependencies>
具体实现
一、注解实现：Bean Validation
常用注解说明
@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、创建配置类，配置LocalVaildatorFactoryBean
在Spring中使用基于注解的数据校验时，需要先配置一个LocalValidatorFactoryBean实例，用于创建和管理校验器对象。这个校验器对象实际上就是javax.validation.Validator接口的一个实现，它提供了一系列校验方法，可以对Java对象进行校验。在配置类中，我们使用@Bean注解来声明一个名为validator的方法，这个方法返回一个LocalValidatorFactoryBean实例。这个实例会被Spring容器管理，并可以在其他组件中使用@Autowired注解进行注入。
其次 ，LocalValidatorFactoryBean 实例需要在Spring容器中创建和管理，而不是通过new操作符手动创建。这是因为校验器需要在创建过程中进行一些复杂的初始化和配置，例如加载校验注解、解析校验表达式、注册自定义校验器等。而Spring框架提供了一个强大的IoC容器，可以自动管理对象的生命周期和依赖关系，可以很方便地创建和管理复杂的对象。因此，我们可以通过在配置类中声明一个@Bean方法来创建LocalValidatorFactoryBean实例，并将其纳入Spring容器的管理范围内。这样，在其他组件中就可以通过注入validator实例来使用校验器的功能了。
@Configuration
@ComponentScan("com.lyz.spring6.validation.method2")
public class ValidationConfig {
@Bean
public LocalValidatorFactoryBean validator() {
return new LocalValidatorFactoryBean();
}
}
代码解析：
这段代码是一个配置类，主要作用是创建一个Validator对象用于数据校验。让我们逐行分析一下：
@Configuration 这个注解表明这是一个配置类。
@ComponentScan(“com.atguigu.spring6.validation.method2”) 这个注解表示需要扫描com.lyz.spring6.validation.method2包下的组件。
public class ValidationConfig 这是一个普通的Java类，用于配置Spring应用程序。
@Bean 这个注解表示这个方法将会返回一个Bean对象，该对象会被Spring容器管理。
public LocalValidatorFactoryBean validator() 这个方法创建了一个LocalValidatorFactoryBean对象，并返回该对象。LocalValidatorFactoryBean是一个Hibernate Validator提供的实现了Spring的Validator接口的数据校验器。它可以将Hibernate Validator和Spring Validator结合起来，提供更加灵活的数据校验功能。
整个配置类的作用就是创建一个 LocalValidatorFactoryBean 对象并将其交给Spring容器管理，以便在数据校验时使用。在需要进行数据校验的Controller方法中，可以通过 @Valid 注解来使用这个数据校验器，@Valid注解只有在Controller方法的参数列表中使用时才会生效。如果你要对其他对象进行数据校验，可以通过调用Validator对象的validate方法来实现。
2、创建实体类、使用注解定义校验规则
public class User {
@NotNull
private String name;
@Min(0)
@Max(120)
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;
}
}
3、使用org.springframework.validation.Validator校验：
@Service
public class MyService2 {
@Autowired
private Validator validator;
public boolean validaPersonByValidator(User user) {
BindException bindException = new BindException(user, user.getName());
validator.validate(user, bindException);
return bindException.hasErrors();
}
}
二、通过Validator接口实现
1、创建实体类
package com.atguigu.spring6.validation.method1;
public class Person {
private String name;
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;
}
}
2、创建类实现Validator接口，实现接口方法指定校验规则
（ 代码详解看注释 ）
public class PersonValidator implements Validator {
/* supports方法用来表示此校验用在哪个类型上，
validate是设置校验逻辑的地点，
其中ValidationUtils，是Spring封装的校验工具类，帮助快速实现校验。*/
@Override
public boolean supports(Class<?> clazz) {
return Person.class.equals(clazz);
}
@Override
public void validate(Object object, Errors errors) {
/*ValidationUtils.rejectIfEmpty是Spring框架提供的一个静态工具类方法，用于校验某个对象中的字段是否为空。它的语法如下：
ValidationUtils.rejectIfEmpty(errors, field, errorCode);
其中，errors是一个Errors对象，用于收集校验错误信息；field是一个字符串，表示要校验的字段名；errorCode是一个字符串，表示校验失败时的错误码。*/
ValidationUtils.rejectIfEmpty(errors, "name", "name.empty");
Person p = (Person) object;
if (p.getAge() < 0) {
errors.rejectValue("age", "error value < 0");
} else if (p.getAge() > 110) {
errors.rejectValue("age", "error value too old");
}
}
}
3、使用上述Validator进行测试
import org.springframework.validation.BindingResult;
import org.springframework.validation.DataBinder;
public class TestMethod1 {
public static void main(String[] args) {
//创建person对象
Person person = new Person();
person.setName("lucy");
person.setAge(-1);
// 创建Person对应的DataBinder
DataBinder binder = new DataBinder(person);
// 设置校验
binder.setValidator(new PersonValidator());
// 由于Person对象中的属性为空，所以校验不通过
binder.validate();
//输出结果
BindingResult results = binder.getBindingResult();
System.out.println(results.getAllErrors());
}
}
三、基于方法实现校验
1、创建配置类
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean;
import org.springframework.validation.beanvalidation.MethodValidationPostProcessor;
@Configuration
@ComponentScan("com.atguigu.spring6.validation.method3")
public class ValidationConfig {
@Bean
public MethodValidationPostProcessor validationPostProcessor() {
return new MethodValidationPostProcessor();
}
}
2、创建实体类，设置具体校验规则
一点题外话，不算正文内容，可直接跳过：
这里我一直很好奇，注解源码中的语法格式是不是java语法？是我们普通程序员不常用，所以学习过程中无人讲解？还是它不属于java语法体系？举例如下：
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Indexed
public @interface Component {
String value() default "";
}
题外话结束。
import jakarta.validation.constraints.*;
public class User {
@NotNull
private String name;
@Min(0)
@Max(120)
private int age;
/*
@Pattern注解是基于正则表达式对数据进行校验的注解。它可以用来约束一个字符串类型的字段，使其符合指定的正则表达式格式。在使用@Pattern注解时，需要指定一个regexp属性，用于设置正则表达式的匹配规则。如果字段的值不符合正则表达式的规则，则会触发校验失败，校验器会将message属性中指定的错误信息返回。
使用@Pattern注解时，需要在类或字段上添加@Validated注解，以启用Spring框架的数据校验功能。下文有应用。
正则表达式文章尾处有介绍。
*/
@Pattern(regexp = "^1(3|4|5|7|8)\\d{9}$",message = "手机号码格式错误")
@NotBlank(message = "手机号码不能为空")
private String phone;
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;
}
public String getPhone() {
return phone;
}
public void setPhone(String phone) {
this.phone = phone;
}
}
3、定义Service类，通过注解操作对象
import jakarta.validation.Valid;
import jakarta.validation.constraints.NotNull;
import org.springframework.stereotype.Service;
import org.springframework.validation.annotation.Validated;
@Service
@Validated
public class MyService {
/*
在这个参数里面，使用了两个注解，分别是@NotNull和@Valid。
@NotNull注解表示该参数不能为空，如果参数为null，则会抛出javax.validation.ConstraintViolationException异常。
@Valid注解表示该参数需要进行数据校验，对于复杂类型的参数，需要对其中的成员变量进行校验。如果校验失败，则同样会抛出 javax.validation.ConstraintViolationException异常。
*/
public String testParams(@NotNull @Valid User user) {
return user.toString();
}
}
4、校验测试
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
public class TestMethod3 {
@Test
public void testMyService1() {
ApplicationContext context = new AnnotationConfigApplicationContext(ValidationConfig.class);
MyService myService = context.getBean(MyService.class);
User user = new User();
user.setAge(-1);
myService.testParams(user);
}
}
四、实现自定义校验
1、自定义校验注解
import jakarta.validation.Constraint;
import jakarta.validation.Payload;
import java.lang.annotation.*;
@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、编写校验类
import jakarta.validation.ConstraintValidator;
import jakarta.validation.ConstraintValidatorContext;
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;
}
}
文尾
一、正则表达式
正则表达式是一种用来描述、匹配字符串的工具，它可以帮助我们快速有效地进行字符串的查找、替换、校验等操作。正则表达式通常由一些特殊字符和普通字符组成，其中特殊字符具有特殊的含义和功能。
常见的正则表达式特殊字符包括：
^：匹配输入字符串的开始位置；
$：匹配输入字符串的结束位置；
.：匹配任意单个字符；
*：匹配前面的字符零次或多次；
+：匹配前面的字符一次或多次；
?：匹配前面的字符零次或一次；
\：用于转义特殊字符；
[]：匹配方括号中任意一个字符；
|：用于分隔多个模式，表示"或"的意思；
()：用于分组，可以改变优先级或应用其他操作符。
例如，正则表达式^\d{3}-\d{3}-\d{4}$表示匹配一个形如123-456-7890的电话号码。其中，^表示匹配字符串的开始位置，\d表示匹配任意数字字符，{3}表示匹配前面的字符3次，-表示匹配连字符，$表示匹配字符串的结束位置。
在Java中，我们可以使用java.util.regex包中的类来处理正则表达式。例如，Pattern类用于表示正则表达式，Matcher类用于匹配字符串和正则表达式。我们可以使用Pattern.compile()方法来编译一个正则表达式，然后使用Matcher类的方法来匹配字符串和正则表达式。
例如，下面的Java代码演示了如何使用正则表达式来匹配一个电话号码：
i
mport java.util.regex.Matcher;
import java.util.regex.Pattern;
public class RegexExample {
public static void main(String[] args) {
String regex = "^\\d{3}-\\d{3}-\\d{4}$";
String input = "123-456-7890";
Pattern pattern = Pattern.compile(regex);
Matcher matcher = pattern.matcher(input);
if (matcher.matches()) {
System.out.println("匹配成功");
} else {
System.out.println("匹配失败");
}
}
}
在上面的示例中，我们先定义了一个正则表达式^\d{3}-\d{3}-\d{4}$，表示匹配一个电话号码。然后，我们将这个正则表达式编译成一个Pattern对象，使用matcher()方法将待匹配的字符串转换成一个Matcher对象，最后使用matches()方法匹配字符串和正则表达式，判断是否匹配成功。