轻松掌握Java Spring Boot参数校验黑科技助你免 bug

后端

2023-03-24 20:37:11

Spring Boot 参数校验：为你的应用程序穿上一层保护甲

参数校验：防止无效输入的卫士

在现代软件开发的快节奏世界中，数据在应用程序之间无缝传递。然而，确保这些数据的准确性和完整性至关重要，因为无效或不正确的输入会导致一系列问题，从细微的性能故障到严重的安全性漏洞。

Spring Boot 参数校验闪亮登场

Spring Boot 是一个流行的 Java 框架，它提供了一个强大的参数校验功能，可以轻松地识别和处理无效输入。该功能通过在应用程序的控制器方法中使用注释和注解来实现，从而实现优雅、非侵入式的数据验证。

参数校验的简单步骤

1. 使用 @Valid 注释标记需要校验的参数

@PostMapping("/user")
public User createUser(@Valid @RequestBody User user) {
    return userService.createUser(user);
}

2. 在实体类中定义校验规则

public class User {
    @NotBlank
    private String name;

    @Email
    private String email;

    @Min(18)
    private int age;
}

自定义校验：应对独特需求

有时，内置的校验注解不足以满足特定需求。在这种情况下，我们可以创建自定义校验注解和校验器来处理独特的业务规则。

1. 创建自定义校验注解

@Documented
@Constraint(validatedBy = PasswordValidator.class)
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface Password {
    String message() default "密码必须包含数字、字母和大写字母";

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

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

2. 创建自定义校验器

public class PasswordValidator implements ConstraintValidator<Password, String> {

    @Override
    public void initialize(Password constraintAnnotation) {

    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 校验密码是否包含数字、字母和大写字母
        return passwordContainsDigitLetterAndUpperCase(value);
    }

    private boolean passwordContainsDigitLetterAndUpperCase(String password) {
        return password.matches("^(?=.*[0-9])(?=.*[a-z])(?=.*[A-Z]).{8,}public class PasswordValidator implements ConstraintValidator<Password, String> {

    @Override
    public void initialize(Password constraintAnnotation) {

    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 校验密码是否包含数字、字母和大写字母
        return passwordContainsDigitLetterAndUpperCase(value);
    }

    private boolean passwordContainsDigitLetterAndUpperCase(String password) {
        return password.matches("^(?=.*[0-9])(?=.*[a-z])(?=.*[A-Z]).{8,}$");
    }
}
quot;);
    }
}

3. 使用自定义校验注解

public class User {
    @NotBlank
    private String name;

    @Email
    private String email;

    @Min(18)
    private int age;

    @Password
    private String password;
}