Spring Framework Validator：数据校验

各位观众老爷们，大家好！我是你们的老朋友，代码界的段子手，BUG界的终结者——BugHunter是也！今天，咱们要聊的是Spring Framework里一个既重要又容易被忽略的家伙：Validator！

别看它名字平平无奇，长得也不像钢铁侠那么威猛，但它却是我们代码的守护神，数据质量的把关人！

为什么我们需要Validator？

想象一下，如果你的网站允许用户随便输入数据，没有任何校验，那会发生什么？

• 用户输入一串乱码，数据库直接爆炸！
• 用户恶意输入SQL注入，你的服务器直接被黑客攻陷！
• 用户注册时，年龄填了-10岁，你的系统直接崩溃！

是不是想想都觉得可怕？所以，数据校验至关重要！它能帮助我们：

• 保证数据的合法性：防止无效数据进入系统。
• 提高系统的安全性：防止恶意攻击，如SQL注入、XSS等。
• 提升用户体验：及时反馈错误信息，引导用户正确输入。

可以这么说，Validator就是我们代码的“安全带”，确保我们在代码的道路上安全行驶！

Spring Validator：你的数据校验好帮手

Spring Framework提供了一套强大的Validator接口和实现，让我们能够轻松地进行数据校验。它就像一位经验丰富的质检员，一丝不苟地检查每一份数据，确保它们符合我们的要求。

1. Validator 接口：定义校验规则

Validator 接口是Spring Validator的核心，它定义了校验的契约。它有两个主要方法：

• boolean supports(Class<?> clazz): 判断该Validator是否支持校验给定的类。 这就像面试官问你“你会不会开挖掘机？”，你必须先确认你会，才能开始下一步操作。
• void validate(Object target, Errors errors): 执行实际的校验逻辑。 这里就是真正的校验环节了，就像质检员拿着放大镜仔细检查产品是否有瑕疵。

2. Errors 接口：收集错误信息

Errors 接口用于收集校验过程中发现的错误信息。 它提供了一系列方法来记录错误，例如：

• reject(String errorCode): 拒绝该对象，并设置错误代码。
• rejectValue(String field, String errorCode): 拒绝对象的某个字段，并设置错误代码。
• rejectValue(String field, String errorCode, String defaultMessage): 拒绝对象的某个字段，设置错误代码和默认错误信息。

Errors 接口就像一个“错误登记本”，记录了所有不合格的数据，方便我们后续处理。

3. 实现 Validator 接口：自定义校验逻辑

要使用Spring Validator，我们需要实现 Validator 接口，并编写自己的校验逻辑。 举个例子，假设我们要校验一个 User 类，它包含 username 和 age 两个字段：

public class User {
    private String username;
    private int age;

    // 省略 getter 和 setter 方法
}

我们可以创建一个 UserValidator 类来实现 Validator 接口：

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

public class UserValidator implements Validator {

    @Override
    public boolean supports(Class<?> clazz) {
        return User.class.equals(clazz); // 只有 User 类才会被校验
    }

    @Override
    public void validate(Object target, Errors errors) {
        User user = (User) target;

        // 校验 username 不能为空
        ValidationUtils.rejectIfEmptyOrWhitespace(errors, "username", "username.required", "Username is required");

        // 校验 age 必须大于 0
        if (user.getAge() <= 0) {
            errors.rejectValue("age", "age.invalid", "Age must be greater than 0");
        }
    }
}

在这个例子中：

• supports() 方法判断只有 User 类才会被这个Validator校验。
• validate() 方法执行实际的校验逻辑：
  • 使用 ValidationUtils.rejectIfEmptyOrWhitespace() 方法校验 username 不能为空。
  • 校验 age 必须大于 0。

4. 使用 Validator：让校验器发挥作用

有了自定义的 Validator，我们需要把它应用到我们的代码中。 Spring提供了多种方式来使用 Validator，例如：

a. 手动调用

这是最直接的方式，我们可以手动创建 Validator 实例，并调用 validate() 方法：

User user = new User();
user.setUsername("");
user.setAge(-10);

UserValidator validator = new UserValidator();
Errors errors = new BeanPropertyBindingResult(user, "user"); // 创建 Errors 对象

validator.validate(user, errors);

if (errors.hasErrors()) {
    // 处理错误信息
    errors.getAllErrors().forEach(error -> {
        System.out.println(error.getDefaultMessage());
    });
}

b. 在 Controller 中使用

在Spring MVC中，我们可以使用 @Valid 注解来触发校验。 首先，需要在 Controller 方法的参数上添加 @Valid 注解：

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;

import javax.validation.Valid;

@Controller
public class UserController {

    @GetMapping("/register")
    public String showRegistrationForm(Model model) {
        model.addAttribute("user", new User());
        return "register";
    }

    @PostMapping("/register")
    public String processRegistrationForm(@Valid User user, BindingResult result, Model model) {
        if (result.hasErrors()) {
            // 处理错误信息，例如将错误信息添加到 Model 中，并在 View 中显示
            return "register"; // 返回注册页面，显示错误信息
        }

        // 处理注册逻辑
        return "success"; // 注册成功，跳转到成功页面
    }
}

然后，需要在 Spring 配置中配置 Validator：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.validation.Validator;

@Configuration
public class WebConfig {

    @Bean
    public Validator userValidator() {
        return new UserValidator();
    }
}

或者，如果你的Validator使用了 @Component 注解，Spring会自动注册它。

c. 使用 JSR-303/JSR-380 注解（Hibernate Validator）

JSR-303（Bean Validation 1.0）和 JSR-380（Bean Validation 2.0）是Java Bean Validation的规范，它们定义了一套标准的注解来描述校验规则。 Hibernate Validator 是 JSR-303/JSR-380 的一个流行实现。

要使用Hibernate Validator，首先需要在项目中添加依赖：

<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.1.6.Final</version> <!-- 使用最新版本 -->
</dependency>

然后，在 User 类中使用注解来定义校验规则：

import javax.validation.constraints.Min;
import javax.validation.constraints.NotEmpty;

public class User {

    @NotEmpty(message = "Username cannot be empty")
    private String username;

    @Min(value = 1, message = "Age must be greater than 0")
    private int age;

    // 省略 getter 和 setter 方法
}

在这个例子中：

• @NotEmpty 注解表示 username 不能为空。
• @Min 注解表示 age 必须大于等于 1。

最后，在 Controller 中使用 @Valid 注解来触发校验，Spring会自动使用Hibernate Validator来校验数据。

进阶技巧：让你的Validator更强大

1. 自定义注解

JSR-303/JSR-380 提供了一些常用的注解，但有时我们需要自定义注解来满足特定的校验需求。 比如，我们可以创建一个 @ValidPassword 注解来校验密码的强度：

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

@Documented
@Constraint(validatedBy = PasswordConstraintValidator.class) // 指定校验器
@Target({ElementType.FIELD}) // 注解只能用在字段上
@Retention(RetentionPolicy.RUNTIME) // 运行时生效
public @interface ValidPassword {

    String message() default "Invalid password"; // 默认错误信息

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

然后，创建一个 PasswordConstraintValidator 类来实现校验逻辑：

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class PasswordConstraintValidator implements ConstraintValidator<ValidPassword, String> {

    @Override
    public boolean isValid(String password, ConstraintValidatorContext context) {
        // 校验密码的逻辑，例如密码长度必须大于 8 位，包含大小写字母和数字
        return password != null && password.length() > 8 && password.matches(".*[a-z].*") && password.matches(".*[A-Z].*") && password.matches(".*[0-9].*");
    }
}

最后，在 User 类中使用 @ValidPassword 注解：

public class User {

    @ValidPassword(message = "Password must be at least 8 characters long and contain uppercase letters, lowercase letters, and numbers")
    private String password;

    // 省略 getter 和 setter 方法
}

2. 分组校验

有时，我们需要根据不同的场景使用不同的校验规则。 例如，在注册时，我们需要校验所有的字段，但在更新用户信息时，我们可能只需要校验部分字段。 JSR-303/JSR-380 提供了分组校验的功能，让我们能够轻松地实现这种需求。

首先，定义一个或多个分组接口：

public interface RegistrationGroup {
}

public interface UpdateGroup {
}

然后，在注解中指定分组：

public class User {

    @NotEmpty(message = "Username cannot be empty", groups = RegistrationGroup.class)
    private String username;

    @Min(value = 1, message = "Age must be greater than 0", groups = {RegistrationGroup.class, UpdateGroup.class})
    private int age;

    // 省略 getter 和 setter 方法
}

最后，在 Controller 中使用 @Validated 注解来指定分组：

import org.springframework.validation.annotation.Validated;

@Controller
public class UserController {

    @PostMapping("/register")
    public String processRegistrationForm(@Validated(RegistrationGroup.class) User user, BindingResult result, Model model) {
        // ...
    }

    @PostMapping("/update")
    public String processUpdateForm(@Validated(UpdateGroup.class) User user, BindingResult result, Model model) {
        // ...
    }
}

3. 国际化

错误信息通常需要支持多种语言。 Spring Validator 和 JSR-303/JSR-380 都支持国际化。

首先，创建一个 messages.properties 文件，用于存储默认的错误信息：

username.required=Username is required
age.invalid=Age must be greater than 0

然后，创建不同语言的 messages_zh_CN.properties 文件：

username.required=用户名不能为空
age.invalid=年龄必须大于0

最后，在 Spring 配置中配置 MessageSource：

import org.springframework.context.MessageSource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.support.ReloadableResourceBundleMessageSource;

@Configuration
public class WebConfig {

    @Bean
    public MessageSource messageSource() {
        ReloadableResourceBundleMessageSource messageSource = new ReloadableResourceBundleMessageSource();
        messageSource.setBasename("classpath:messages"); // 指定 messages.properties 文件的位置
        messageSource.setDefaultEncoding("UTF-8");
        return messageSource;
    }
}

这样，Spring会自动根据用户的语言设置来加载对应的错误信息。

表格总结

功能	描述	示例
Validator 接口	定义校验的契约，包含 supports() 和 validate() 方法。	实现 Validator 接口，编写自定义校验逻辑。
Errors 接口	收集校验过程中发现的错误信息。	使用 reject() 和 rejectValue() 方法记录错误信息。
JSR-303/JSR-380	Java Bean Validation 的规范，提供了一套标准的注解来描述校验规则。	使用 @NotEmpty、@Min 等注解来定义校验规则。
自定义注解	创建自定义注解来满足特定的校验需求。	创建 @ValidPassword 注解来校验密码的强度。
分组校验	根据不同的场景使用不同的校验规则。	定义分组接口，并在注解中指定分组，然后使用 @Validated 注解来指定分组。
国际化	支持多种语言的错误信息。	创建不同语言的 messages.properties 文件，并在 Spring 配置中配置 MessageSource。

总结

Spring Validator 是一个强大的数据校验工具，它可以帮助我们保证数据的合法性，提高系统的安全性，提升用户体验。 掌握 Spring Validator 的使用技巧，能够让我们编写出更加健壮和可靠的代码。

希望今天的讲解能够帮助大家更好地理解和使用 Spring Validator。 记住，数据校验是代码质量的基石，让我们一起努力，打造更加安全、可靠的应用！

感谢大家的观看，我是BugHunter，我们下期再见！