spring项目数据校验

刺仙

于 2024-08-31 16:30:00 发布

阅读量352

点赞数 3

文章标签： mysql 数据库

本文链接：https://blog.csdn.net/m0_57083961/article/details/141727731

版权

在 Spring 项目中，数据校验是确保输入数据的完整性、有效性和一致性的重要环节。Spring 提供了多种方式来进行数据校验，包括使用注解、定义自定义校验器以及结合异常处理来统一管理校验错误。以下是如何在 Spring 项目中进行数据校验的详细介绍：

1. 使用 JSR 303/JSR 380 标准注解进行数据校验

Spring 通过集成 Bean Validation（JSR 303/JSR 380）提供了一系列标准注解用于数据校验。这些注解可以直接应用于实体类的字段上。

1.1. 常用注解

@NotNull：字段不能为空。
@Size：字符串或集合的长度必须在指定范围内。
@Min 和 @Max：数值字段的最小值和最大值。
@Pattern：字段的值必须符合指定的正则表达式。

1.2. 示例

假设有一个用户注册的表单数据类 UserDTO，你可以在字段上使用这些注解进行校验。

import javax.validation.constraints.Email;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

public class UserDTO {

    @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 long")
    private String password;

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

    // Getters and Setters
}

2. 在 Controller 中触发校验

当使用 Spring MVC 时，可以在控制器方法中通过 @Valid 注解来触发校验。如果数据不符合要求，Spring 会自动抛出 MethodArgumentNotValidException 异常。

import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/users")
public class UserController {

    @PostMapping("/register")
    public String registerUser(@Valid @RequestBody UserDTO user) {
        // 如果数据校验通过，继续处理逻辑
        return "User registered successfully!";
    }
}

3. 自定义校验器

对于复杂的校验逻辑，标准注解可能不够用。此时，你可以创建自定义校验器。

3.1. 创建自定义校验注解

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

@Documented
@Constraint(validatedBy = { PasswordStrengthValidator.class })
@Target({ ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
public @interface ValidPassword {
    String message() default "Password is too weak";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

3.2. 实现校验逻辑

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

public class PasswordStrengthValidator implements ConstraintValidator<ValidPassword, String> {

    @Override
    public void initialize(ValidPassword constraintAnnotation) {
    }

    @Override
    public boolean isValid(String password, ConstraintValidatorContext context) {
        if (password == null) {
            return false;
        }
        // 简单的例子：要求密码至少包含一个大写字母和一个数字
        return password.matches("^(?=.*[A-Z])(?=.*\\d).+$");
    }
}

3.3. 使用自定义校验注解

public class UserDTO {

    @ValidPassword
    private String password;

    // Other fields and getters/setters
}

4. 全局异常处理

为了统一处理校验失败的错误信息，可以创建一个全局异常处理器。这样当数据校验失败时，应用程序可以返回一致的错误响应。

import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public String handleValidationExceptions(MethodArgumentNotValidException ex) {
        return ex.getBindingResult().getAllErrors().stream()
                 .map(ObjectError::getDefaultMessage)
                 .collect(Collectors.joining(", "));
    }
}