SpringBoot自定义注解校验

SpringBoot的validation为我们提供了很多的校验规则注解,几乎可以满足我们日常开发中的绝大多数场景。但是,再特殊场景下,我们还是需要自定义一些校验规则注解,实现自定一校验。

一个好的框架一定是方便扩展的。SpringValidation允许用户自定义校验。

实现步骤

自定义校验注解
编写校验处理类
场景:登录用户的密码必须是4-16位,并且必须同时包含数字,大写字母,小写,特殊字符
 

1 .自定义校验注解

1.1 新建PasswordPatten注解

@Documented
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Repeatable(PasswordPatten.List.class)
@Constraint(validatedBy = {PasswordPattenValidator.class})
public @interface PasswordPatten {

    String message() default "密码格式错误,必须位4-16位,并且包含数字,大写字母,小写字母,特殊字符";

    Class[] groups() default { };

    Class[] payload() default { };

    @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
    @Retention(RUNTIME)
    @Documented
    public @interface List {
        PasswordPatten[] value();
    }

}


1.2  创建PasswordPattenValidator自定义检验处理类

public class PasswordPattenValidator implements ConstraintValidator {

    /**
     * 重写校验方法
     * @param value 值
     * @param context 上下文
     * @return 是否校验通过,true通过,false不通过
     */
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (StringUtils.isBlank(value)) {
            return false;
        }
        return validatePassword(value);
    }

    /**
     * 校验方法,校验规则
     * @param password 值
     * @return 是否符合规则,true通过,false不通过
     */
    private boolean validatePassword(String password) {
        return StringUtils.containsAny(password, "-_+=,.?~!@#$%^&*()")
                && StringUtils.containsAny(password, "abcdefghijklmnopqrstuvwxyz")
                && StringUtils.containsAny(password, "ABCDEFGHIJKLMNOPQRSTUVWXYZ")
                && StringUtils.containsAny(password, "0123456789");
    }
}
 

1.3 新建实体类LoginUserVo

@Data
@NoArgsConstructor
@AllArgsConstructor
public class LoginUserVo implements Serializable {

    private static final long serialVersionUID = -5331320733431220933L;

    @NotBlank(message = "用户名不能为空")   // 非空,message为错误的提示信息
    private String username;
    @NotBlank(message = "密码不能为空")   // 非空
    @PasswordPatten // 密码自定义校验
    private String password;

}
 

1.4 新建UserController

 @PostMapping("/login")

public Result login(@RequestBody @Validated LoginUserVo loginUserVo) {

          return success("登录成功");

}

2 .POSTMAN测试

SpringBoot自定义注解校验_第1张图片

 SpringBoot自定义注解校验_第2张图片

3.最后附上 思维导图SpringBoot自定义注解校验_第3张图片

 

你可能感兴趣的:(springboot,spring,boot,java,后端)