JSR303 数据校验 和 顺序校验

JSR303 数据校验 和 顺序校验
涉及到两种注解：

1. JSR303 中的注解如@NotEmpty/@Pattern/ @Length等
2. 声明使用校验的注解。 @Validated 和 @Valid，一个在顺序校验的时候用，一个在普通校验的时候用。

除了SpringMvc还需要引入jar

        <dependency>
            <groupId>org.hibernate.validator</groupId>
            <artifactId>hibernate-validator</artifactId>
        </dependency>

数据校验

使用：

1. 在实体类的字段上添加相应的校验注解
   如：

    /**
     * 用户名
     */
    @NotEmpty(message = "用户名不可为空！")
    @Pattern(regexp = "^[A-Za-z][A-Za-z0-9]{5,17}$" , message = "用户名由字母开头的6-18位数字和字母组成！")
    private String username;
    /**
     * 手机号
     */
    @NotEmpty(message = "手机号不可为空！")
    @Pattern(regexp = "^1[3|4|5|6|8|7|9]\\d{9}$", message = "手机号格式不正确！")
    private String phone;

上面简单定义了用户名和手机号的非空判断和格式判断。

2. 使用SpringMvc接收参数的时候，使用@Valid注解，并且后面紧跟一个BindingResult类型的参数，用于获取数据校验的结果。
   如：

    /**
     * 注册接口
     * @return
     */
    @PostMapping("register")
    public HttpResult register(@Valid @RequestBody RegisterForm registerForm, BindingResult result){

        if(result.hasErrors())
            return HttpResult.error500(result.getAllErrors().iterator().next().getDefaultMessage());

        return registerService.register(registerForm);
    }

BingResult的hasErrors方法会返回一个boolean判断数据校验是否出了问题，如果出了问题，则自定义通过getAllErrors方法判断具体的错误是什么。

如果在参数中不写BindingResult，在数据校验出了问题时候，异常会直接被抛出无法进入方法，而不是说被接受到。

如果同时出现多种参数不一致，如果用户名不符合，手机号也不符合，则获得到的校验返回结果并不会固定。有可能这次提示用户名不符合规范，下次就提示手机号不符合规范。因为默认下这个校验是无任何顺序的。

顺序校验

这边涉及到分组校验的概念，先定义组的顺序，然后将校验逻辑进行分组。

1. 定义分组类
   如：

@GroupSequence(value={
		ValidateSequence.Validate1.class,
        ValidateSequence.Validate2.class,
        ValidateSequence.Validate3.class,
        ValidateSequence.Validate4.class,
        ValidateSequence.Default.class,
})
/**
 * 校验顺序
 */
 public interface ValidateSequence {
     interface Validate1{}
     interface Validate2{}
     interface Validate3{}
     interface Validate4{}
     interface Default{}
}

我这里只定义了4个组和一个最后校验的默认组。按照注解中的声明顺序，被分到Validate1组中的校验将被最先执行，而相应的Validate2和Validate3组中的校验会依次后面执行。

2. 将检验逻辑进行分组
   继续以上面的为例

    /**
     * 用户名
     */
    @NotEmpty(message = "用户名不可为空！", groups = {ValidateSequence.Validate1.class})
    @Pattern(regexp = "^[A-Za-z][A-Za-z0-9]{5,17}$", message = "用户名由字母开头的6-18位数字和字母组成！", groups = {ValidateSequence.Validate3.class})
    private String username;
    /**
     * 手机号
     */
    @NotEmpty(message = "手机号不可为空！", groups = {ValidateSequence.Validate3.class})
    @Pattern(regexp = "^1[3|4|5|6|8|7|9]\\d{9}$", message = "手机号格式不正确！", groups = {ValidateSequence.Validate7.class})
    private String phone;

这里用上了上面定义的Validate1 - 4。最终会按照定义的顺序一个一个执行过去。

3. 接口那咋写呢

    /**
     * 注册接口
     * @return
     */
    @PostMapping("register")
    public HttpResult register(@Validated(ValidateSequence.class) @RequestBody RegisterForm registerForm, BindingResult result){

        if(result.hasErrors())
            return HttpResult.error500(result.getAllErrors().iterator().next().getDefaultMessage());

        return registerService.register(registerForm);
    }

有一点不同，现在这样写~

自定义校验注解

如：
定义一个注解用于判断数据是不是清单

@Documented
//作用于字段和方法
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
//必须声明校验的实现类
@Constraint(validatedBy = IsAccountValidator.class)
public @interface IsAccount {

    boolean required() default true;

    String message() default "error with IsAccount";

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

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

定义校验类，需要实现ConstraintValidator<A extends Annotation, T>接口，A表示注解类型，T表示修饰的字段类型。

public class IsAccountValidator implements ConstraintValidator<IsAccount, String> {

    private boolean required;

    @Override
    public void initialize(IsAccount isAccount) {
        required = isAccount.required();
    }

    /**
     * 判断是否通过校验
     * @param value
     * @param context
     * @return
     */
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if(StringUtils.isEmpty(value))
            return true;

        return value.contains("_APS_C");
    }
}