公司动态

在现代Web应用程序开发中，数据校验是一个不可忽视的重要环节。Spring Boot 提供了对JSR 303（Java Bean Validation）标准的支持，使得数据校验变得更加简洁和高效。本文将详细介绍如何在Spring Boot中使用JSR 303进行数据校验，并探讨其实现原理和应用场景。

什么是JSR 303？

JSR 303是Java EE 6引入的一项规范，定义了Java Bean验证的标准API。通过使用注解，JSR 303允许开发者在Java类中声明验证规则，这些规则可以在数据传输对象（DTO）、实体类等Java Bean中使用。常见的JSR 303注解包括：

• @NotNull: 验证字段是否为非空。

• @Size: 验证字段的长度是否在指定范围内。

• @Min和@Max: 验证字段的值是否在指定范围内。

• @Pattern: 验证字段是否符合指定的正则表达式。

在Spring Boot中启用JSR 303校验

要在Spring Boot中启用JSR 303校验，我们需要遵循以下步骤：

1. 引入依赖

首先，在项目的pom.xml文件中添加对JSR 303的依赖：

<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>2.0.1.Final</version></dependency><dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.0.13.Final</version></dependency>

2. 创建数据传输对象（DTO）

接下来，创建一个包含校验注解的DTO。例如，我们创建一个简单的用户注册DTO：

import javax.validation.constraints.Email;import javax.validation.constraints.NotNull;import javax.validation.constraints.Size;public class UserRegistrationDTO {

    @NotNull(message = "Username cannot be null")
    @Size(min = 3, max = 20, message = "Username must be between 3 and 20 characters")
    private String username;

    @NotNull(message = "Password cannot be null")
    @Size(min = 6, message = "Password must be at least 6 characters")
    private String password;

    @NotNull(message = "Email cannot be null")
    @Email(message = "Email should be valid")
    private String email;

    // Getters and Setters}

3. 在控制器中使用JSR 303校验

在Spring Boot控制器中，我们可以使用@Valid注解来启用JSR 303校验，并通过BindingResult对象来处理校验结果：

import org.springframework.validation.BindingResult;import org.springframework.web.bind.annotation.PostMapping;import org.springframework.web.bind.annotation.RequestBody;import org.springframework.web.bind.annotation.RestController;@RestControllerpublic class UserController {

    @PostMapping("/register")
    public String registerUser(@RequestBody @Valid UserRegistrationDTO user, BindingResult result) {
        if (result.hasErrors()) {
            return result.getAllErrors().stream()
                    .map(ObjectError::getDefaultMessage)
                    .collect(Collectors.joining(", "));
        }
        // Proceed with registration logic
        return "User registered successfully";
    }}

在上述示例中，如果请求中的用户数据不符合DTO中定义的校验规则，校验错误信息将被收集并返回给客户端。

SR是 Java EE 的一种标准，用于基于注解的对象数据验证。在Spring Boot应用中，你可以通过添加注解直接在POJO类中声明验证规则。

这样可以确保在使用这些对象进行操作之前，它们满足业务规则。个人认为非常有用的，像我们中原六仔三合一平台出租系统重也是使用了SR，因为它减少了代码中的校验逻辑，使得校验逻辑更加集中且易于管理。

自定义校验注解

除了使用内置的校验注解外，Spring Boot还允许我们创建自定义校验注解。例如，我们创建一个自定义注解，用于验证密码是否包含至少一个数字和一个特殊字符：

1. 创建自定义注解

首先，定义一个新的注解@ValidPassword：

import javax.validation.Constraint;import javax.validation.Payload;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;@Constraint(validatedBy = PasswordValidator.class)@Target({ ElementType.FIELD, ElementType.METHOD })@Retention(RetentionPolicy.RUNTIME)public @interface ValidPassword {
    String message() default "Password must contain at least one number and one special character";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};}

2. 创建校验器

接下来，创建一个实现ConstraintValidator接口的校验器PasswordValidator：

import javax.validation.ConstraintValidator;import javax.validation.ConstraintValidatorContext;import java.util.regex.Pattern;public class PasswordValidator implements ConstraintValidator<ValidPassword, String> {

    private static final String PASSWORD_PATTERN = "^(?=.*[0-9])(?=.*[!@#$%^&*]).{6,}$";
    private final Pattern pattern = Pattern.compile(PASSWORD_PATTERN);

    @Override
    public void initialize(ValidPassword constraintAnnotation) {
    }

    @Override
    public boolean isValid(String password, ConstraintValidatorContext context) {
        if (password == null) {
            return false;
        }
        return pattern.matcher(password).matches();
    }}

3. 在DTO中使用自定义注解

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

public class UserRegistrationDTO {

    @NotNull(message = "Username cannot be null")
    @Size(min = 3, max = 20, message = "Username must be between 3 and 20 characters")
    private String username;

    @NotNull(message = "Password cannot be null")
    @Size(min = 6, message = "Password must be at least 6 characters")
    @ValidPassword
    private String password;

    @NotNull(message = "Email cannot be null")
    @Email(message = "Email should be valid")
    private String email;

    // Getters and Setters}

处理全局校验异常

在实际应用中，我们通常需要统一处理校验异常，并返回标准化的错误响应。我们可以通过定义全局异常处理器来实现这一点：

import org.springframework.http.HttpStatus;import org.springframework.http.ResponseEntity;import org.springframework.validation.FieldError;import org.springframework.web.bind.MethodArgumentNotValidException;import org.springframework.web.bind.annotation.ExceptionHandler;import org.springframework.web.bind.annotation.RestControllerAdvice;import java.util.HashMap;import java.util.Map;@RestControllerAdvicepublic class GlobalExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<Map<String, String>> handleValidationExceptions(MethodArgumentNotValidException ex) {
        Map<String, String> errors = new HashMap<>();
        ex.getBindingResult().getAllErrors().forEach(error -> {
            String fieldName = ((FieldError) error).getField();
            String errorMessage = error.getDefaultMessage();
            errors.put(fieldName, errorMessage);
        });
        return new ResponseEntity<>(errors, HttpStatus.BAD_REQUEST);
    }}

通过定义GlobalExceptionHandler，我们可以捕获MethodArgumentNotValidException异常，并返回包含详细错误信息的响应。

结论

JSR 303校验是Spring Boot中非常强大且灵活的数据校验工具。通过使用内置的校验注解和自定义校验注解，我们可以轻松地在应用程序中实现各种复杂的校验逻辑。此外，通过统一处理校验异常，我们可以提高代码的可维护性和用户体验。希望本文能帮助读者更好地理解和应用JSR 303校验。