SpringMVC 中的数据验证如何使用自定义验证器

我就是我 2024-03-17 18:50 18阅读 0赞

## SpringMVC 中的数据验证如何使用自定义验证器 ##

### 简介 ###

SpringMVC 是一个基于 Spring 框架的 Web 框架，它提供了一套完整的 MVC 架构，可以帮助开发者快速构建 Web 应用程序。在 Web 开发中，数据验证是非常重要的一环，它可以帮助我们保证数据的有效性和完整性，防止恶意攻击和数据泄露。

SpringMVC 提供了强大的数据验证机制，可以方便地验证表单提交的数据。除了自带的验证器之外，SpringMVC 还支持自定义验证器，允许开发者根据业务需求自定义验证规则。本文将介绍如何在 SpringMVC 中使用自定义验证器。

![在这里插入图片描述][3e8d1831d4ba4ba8a4a71a80f1826a68.png]

### SpringMVC 数据验证机制 ###

SpringMVC 的数据验证机制基于 JSR 303 规范，即 Bean Validation 规范。该规范定义了一套标准的注解，用于描述数据验证规则。SpringMVC 提供了一个统一的验证器接口 `Validator`，用于执行数据验证。开发者可以实现该接口，编写自定义验证器。

在 SpringMVC 中，数据验证是在控制器方法执行之前进行的。当表单数据提交到控制器方法时，SpringMVC 会自动将表单数据转换成 Java 对象，并执行数据验证。如果验证失败，则会抛出 `org.springframework.validation.BindException` 异常，开发者可以在异常处理器中处理该异常。

### 自定义验证器 ###

自定义验证器是指开发者根据业务需求编写的验证器。在 SpringMVC 中，自定义验证器需要实现 `Validator` 接口，并重写 `supports()` 和 `validate()` 方法。

#### `supports()` 方法 ####

`supports()` 方法用于判断当前验证器是否支持某个验证对象。该方法的参数是一个 `Class` 对象，表示待验证对象的类型。开发者需要在该方法中判断该类型是否满足验证器的要求，如果满足，则返回 `true`，否则返回 `false`。

public class MyValidator implements Validator {
        
        @Override
        public boolean supports(Class<?> clazz) {
        
            // 判断 clazz 是否是待验证对象的类型
            // 如果是，则返回 true，否则返回 false
        }
    }

#### `validate()` 方法 ####

`validate()` 方法用于执行数据验证。该方法的参数有两个，分别是待验证对象和 `Errors` 对象。`Errors` 对象用于保存验证错误信息。开发者需要在该方法中编写验证逻辑，并将验证结果保存到 `Errors` 对象中。

public class MyValidator implements Validator {
        
        @Override
        public void validate(Object target, Errors errors) {
        
            // 编写验证逻辑
            // 如果验证失败，则调用 errors.reject() 方法保存错误信息
        }
    }

### 在 SpringMVC 中使用自定义验证器 ###

使用自定义验证器的步骤如下：

1.  定义待验证对象
2.  编写自定义验证器
3.  在控制器方法中注入自定义验证器
4.  执行数据验证

#### 定义待验证对象 ####

待验证对象是指表单提交的数据所对应的 Java 对象。在定义该对象时，需要使用 Bean Validation 规范的注解来描述验证规则。例如，下面是一个简单的待验证对象：

public class User {
        
        @NotNull
        private String username;
        
        @Size(min = 6, max = 20)
        private String password;
        
        // 省略 getter 和 setter 方法
    }

在上面的代码中，`username` 属性使用了 `@NotNull` 注解，表示该属性不能为空；`password` 属性使用了 `@Size` 注解，表示该属性的长度必须在 6 到 20 之间。

#### 编写自定义验证器 ####

编写自定义验证器的步骤已经在前面介绍过了，这里就不再赘述。

#### 在控制器方法中注入自定义验证器 ####

在控制器方法中，需要使用 `@InitBinder` 注解来注册自定义验证器。例如，下面是一个简单的控制器方法：

@PostMapping("/register")
    public String register(@Valid User user, BindingResult result) {
        
        if (result.hasErrors()) {
        
            // 处理验证错误
        }
        // 处理注册逻辑
    }

在上面的代码中，`@Valid` 注解表示对 `User` 对象进行数据验证，`BindingResult` 对象用于保存验证错误信息。如果验证失败，则可以在 `BindingResult` 对象中获取错误信息。

为了使用自定义验证器，需要在控制器中添加 `@InitBinder` 注解，并在该注解中注册自定义验证器。例如，下面是一个简单的自定义验证器和控制器方法：

public class MyValidator implements Validator {
        
        @Override
        public boolean supports(Class<?> clazz) {
        
            return User.class.isAssignableFrom(clazz);
        }
    
        @Override
        public void validate(Object target, Errors errors) {
        
            User user = (User) target;
            if (!user.getPassword().equals(user.getConfirmPassword())) {
        
                errors.rejectValue("confirmPassword", "password.not.match");
            }
        }
    }
    
    @Controller
    public class UserController {
        
        @InitBinder
        public void initBinder(WebDataBinder binder) {
        
            binder.addValidators(new MyValidator());
        }
    
        @PostMapping("/register")
        public String register(@Valid User user, BindingResult result) {
        
            if (result.hasErrors()) {
        
                // 处理验证错误
            }
            // 处理注册逻辑
        }
    }

在上面的代码中，`MyValidator` 类实现了自定义验证器，它验证用户输入的密码和确认密码是否一致。在控制器中，使用 `@InitBinder` 注解注册自定义验证器，然后在控制器方法中使用 `@Valid` 注解对 `User` 对象进行数据验证。

### 总结 ###

SpringMVC 提供了强大的数据验证机制，可以方便地验证表单提交的数据。除了自带的验证器之外，SpringMVC 还支持自定义验证器，允许开发者根据业务需求自定义验证规则。本文介绍了如何在 SpringMVC 中使用自定义验证器，包括定义待验证对象、编写自定义验证器、在控制器方法中注入自定义验证器等步骤。开发者可以根据自己的业务需求，编写自定义验证器，确保数据的有效性和完整性，提高 Web 应用程序的安全性和稳定性。

[3e8d1831d4ba4ba8a4a71a80f1826a68.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/000e835fe6674adfaca1b41d41200f65.png