一篇文章教你如何用Java自定义一个参数校验器

目录

• 注解
• 校验器
• 异常处理
• 测试
• 总结

自定义一个唯一字段校验器

注解

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = {IsUniqueValidator.class}) // 指定自定义的校验器
public @interface IsUnique {
    // 提示信息
    String message() default "";
    // 不加这俩参数 error msg: contains Constraint annotation, but does not contain a groups parameter.
    // 必须包含这两个参数
    Class[] groups() default {};
    Class[] payload() default {};
    // -----
}

校验器

public class IsUniqueValidator implements ConstraintValidator {
    @Override
    public void initialize(IsUnique constraintAnnotation) {
    }
    /**
     * 通过该方法，对参数进行验证，看是否通过。
     * @param value   修饰字段的值。
     * @param context 上下文
     * @return true：验证通过。 false：验证不通过。
     */
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 模拟数据库判断是否存在改用户名
        return !"aaaa".equals(value);
    }
} 

异常处理

@ControllerAdvice
@ResponseBody
public class ValidatorExceptionHandler {
    @ExceptionHandler(value = BindException.class)
    public Map exceptionHandler(BindException e) {
        List allErrors = e.getAllErrors();
        StringBuilder sb = new StringBuilder();
        for (ObjectError error : allErrors) {
            sb.append(error.getDefaultMessage());
            sb.append(", ");
        }
        String error = sb.toString();
        HashMap resp = new HashMap<>();
        resp.put("1004", error.substring(0, error.lastIndexOf(",")));
        return resp;
    }
}

使用, 跟spring提供的用法完全一致

@Data
public class User {
    @NotNull(message = "name不为null")
    @IsUnique(message = "用户名是唯一的")
    private String name;
    @NotNull
    private String password;
}

    @PostMapping
    public String hello(@RequestBody @Valid User user) {
        return "hello" + user.getName();
    }

测试

总结

本篇文章就到这里了，希望能够给你带来帮助，也希望您能够多多关注脚本之家的更多内容！