Young Kbt blog
Young Kbt
2023-10-28
目录

Spring6 - 数据校验

这里是 Spring 的数据校验，如果使用了 SpringBoot，则建议学习 Spring Boot - 参数校验 学习 Spring Boot 的数据校验。

# Spring Validation 概述

image-20221206220207266

在开发中，我们经常遇到参数校验的需求，比如用户注册的时候，要校验用户名不能为空、用户名长度不超过 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>
1
2
3
4
5
6
7
8
9
10
11
12
13

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

package cn.youngkbt.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;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

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

package cn.youngkbt.Spring6.validation.method1;

import org.Springframework.validation.Errors;
import org.Springframework.validation.ValidationUtils;
import org.Springframework.validation.Validator;

public class PersonValidator implements Validator {

    @Override
    public boolean supports(Class<?> clazz) {
        return Person.class.equals(clazz);
    }

    @Override
    public void validate(Object object, Errors errors) {
        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");
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

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

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

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

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

package cn.youngkbt.Spring6.validation.method1;

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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

# Bean Validation 注解实现

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

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

@Configuration
@ComponentScan("cn.youngkbt.Spring6.validation.method2")
public class ValidationConfig {

    @Bean
    public LocalValidatorFactoryBean validator() {
        return new LocalValidatorFactoryBean();
    }
}
1
2
3
4
5
6
7
8
9

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

package cn.youngkbt.Spring6.validation.method2;

import jakarta.validation.constraints.Max;
import jakarta.validation.constraints.Min;
import jakarta.validation.constraints.NotNull;

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;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

常用注解说明：

  • @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 格式

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

使用 jakarta.validation.Validator 校验

package cn.youngkbt.Spring6.validation.method2;

import jakarta.validation.ConstraintViolation;
import jakarta.validation.Validator;
import org.Springframework.Beans.factory.annotation.Autowired;
import org.Springframework.stereotype.Service;
import Java.util.Set;

@Service
public class MyService1 {

    @Autowired
    private Validator validator;

    public  boolean validator(User user){
        Set<ConstraintViolation<User>> sets =  validator.validate(user);
        return sets.isEmpty();
    }

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

使用 org.Springframework.validation.Validator 校验

package cn.youngkbt.Spring6.validation.method2;

import org.Springframework.Beans.factory.annotation.Autowired;
import org.Springframework.stereotype.Service;
import org.Springframework.validation.BindException;
import 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();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

第四步：测试

package cn.youngkbt.Spring6.validation.method2;

import org.junit.jupiter.api.Test;
import org.Springframework.context.ApplicationContext;
import org.Springframework.context.annotation.AnnotationConfigApplicationContext;

public class TestMethod2 {

    @Test
    public void testMyService1() {
        ApplicationContext context = new AnnotationConfigApplicationContext(ValidationConfig.class);
        MyService1 myService = context.getBean(MyService1.class);
        User user = new User();
        user.setAge(-1);
        boolean validator = myService.validator(user);
        System.out.println(validator);
    }

    @Test
    public void testMyService2() {
        ApplicationContext context = new AnnotationConfigApplicationContext(ValidationConfig.class);
        MyService2 myService = context.getBean(MyService2.class);
        User user = new User();
        user.setName("lucy");
        user.setAge(130);
        user.setAge(-1);
        boolean validator = myService.validaPersonByValidator(user);
        System.out.println(validator);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

# 基于方法实现校验

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

package cn.youngkbt.Spring6.validation.method3;

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("cn.youngkbt.Spring6.validation.method3")
public class ValidationConfig {

    @Bean
    public MethodValidationPostProcessor validationPostProcessor() {
        return new MethodValidationPostProcessor();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

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

package cn.youngkbt.Spring6.validation.method3;

import jakarta.validation.constraints.*;

public class User {

    @NotNull
    private String name;

    @Min(0)
    @Max(120)
    private int age;

    @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;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

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

package cn.youngkbt.Spring6.validation.method3;

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 {
    
    public String testParams(@NotNull @Valid User user) {
        return user.toString();
    }

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

第四步：测试

package cn.youngkbt.Spring6.validation.method3;

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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

# 实现自定义校验

第一步：自定义校验注解

package cn.youngkbt.Spring6.validation.method4;

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();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

第二步：编写真正的校验类

package cn.youngkbt.Spring6.validation.method4;

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;
        }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
编辑此页 (opens new window)
#Spring6
更新时间: 2023/10/27, 16:55:50
Spring6 - 国际化
Spring - Cache

← Spring - Cache→

最近更新
01
技术随笔 - Element Plus 修改包名 原创
11-02
02
Reactor - 扩展性
11-02
03
Reactor - 最佳实践
11-02
更多文章>
Theme by Vdoing | Copyright © 2021-2024 Young Kbt | blog
桂ICP备2021009994号