Spring Validation参数效验的各种使用姿势总结

Spring Validation是一个用于参数效验的强大工具，它可以帮助我们在应用程序中对输入参数进行验证，确保数据的合法性和完整性。本文将详细介绍Spring Validation的各种使用姿势，并提供两个示例说明。

1. 添加依赖

首先，我们需要在项目的pom.xml文件中添加以下依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

这将引入Spring Validation的相关库。

2. 创建验证器

接下来，我们需要创建一个验证器类，用于定义参数的验证规则。验证器类需要实现Validator接口，并重写supports和validate方法。

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);
    }

    @Override
    public void validate(Object target, Errors errors) {
        ValidationUtils.rejectIfEmptyOrWhitespace(errors, \"name\", \"field.required\");
        ValidationUtils.rejectIfEmptyOrWhitespace(errors, \"age\", \"field.required\");
        // 添加其他验证规则
    }
}

在上面的示例中，我们创建了一个UserValidator类，用于验证User对象的参数。supports方法用于指定该验证器支持的参数类型，validate方法用于定义具体的验证规则。

3. 在Controller中使用验证器

在Controller中，我们可以使用验证器对参数进行验证。首先，我们需要在Controller类上添加@Validated注解，以启用参数验证功能。然后，我们可以在方法参数上添加@Valid注解，以指定需要验证的参数。

import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Validated
public class UserController {

    @PostMapping(\"/users\")
    public void createUser(@Valid @RequestBody User user) {
        // 处理创建用户的逻辑
    }
}

在上面的示例中，我们在createUser方法的参数上添加了@Valid注解，表示需要对User对象进行验证。

示例说明

示例一：验证用户名和年龄

假设我们有一个User类，包含name和age两个参数。我们希望验证用户名和年龄是否为空。

public class User {
    private String name;
    private Integer age;

    // 省略getter和setter方法
}

我们可以使用上述的UserValidator类对User对象进行验证。

示例二：验证邮箱格式

假设我们有一个Email类，包含address参数，我们希望验证邮箱地址的格式是否正确。

public class Email {
    private String address;

    // 省略getter和setter方法
}

我们可以创建一个新的验证器类EmailValidator，并在其中添加验证规则。

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

public class EmailValidator implements Validator {

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

    @Override
    public void validate(Object target, Errors errors) {
        Email email = (Email) target;
        if (!email.getAddress().matches(\"[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\\\.[A-Za-z]{2,4}\")) {
            errors.rejectValue(\"address\", \"email.invalid\");
        }
    }
}

然后，在Controller中使用EmailValidator对Email对象进行验证。

以上就是关于Spring Validation参数效验的使用姿势总结，通过创建验证器并在Controller中使用，我们可以轻松地对参数进行验证，确保数据的合法性和完整性。

希望本文对您有所帮助！