Capybara-Validator 一个校验库

老规矩先上链接

https://github.com/Ubitar/Capybara-Validator

引言

日常开发中，我们通常会把较多的参数包装在一个类里，例如：要提交的表单Bean类。那么肯定少不了对该Bean类内变量数据的正确性校验，对于校验方法你可以选择简单的if-else或者使用校验器。

创建库的原由

比如 Hibernate Validator 的校验器，如果你写过java后端肯定知道,该校验器使用的是注解的方式进行校验规则标注，同时也具有分组校验、指定校验顺序的功能，其提供的校验功能还是很强大的。 放张图，体会下

这个东西是后端专属的，如果不移植而直接应用到Android上会有些不尽人意的地方：

1、无法直接应用到安卓国际化应用的校验情况中去 其注解中的message（校验失败返回消息）只能使用固定的，是编译时写入的字符内容，无法使用R.string这样的资源（这个已经有人进行安卓版本的移植了，可以去查找下）
2、分组校验不易维护 Bean的分组校验是通过指定Groups类实现的，随着变量和分组增多，阅读的难度很可能会大大增加
3、自定义校验器仅能判断目标字段 在校验判断时无法结合其他字段一起做出判断。
4、没有提供校验结果Tag标识 校验结果标识只有message信息，没有额外的标识

这一切的矛头都指向了注解校验的运行方式。

换种实现方式

使用非注解的方式来实现检验过程。校验的顺序、校验规则都按照所添加的校验规则rule来线性运行。

comparator
      //添加一个或多个校验规则
      .addItem(new NotNullRule(rawBean1.getStr(), "str can't not be null","tag1"))
      .validate();//确认校验规则

校验后获取校验结果、校验标识、校验的目标字段。

IResult result = CValidator.valid(new RawValidation1(bean));//执行校验，获取结果
boolean hasError=result.hasError();
IReason reason = result.getReasonAtFirst();
String message = reason.getMessage();
IFieldRule<Object> rule = (IFieldRule<Object>) reason.getRule();
String tag = rule.getTag();
Object field = rule.getField();

导入

implementation 'com.ubitar.capybara:validator:1.0.4'

开始

1、创建目标Bean类

public class RawBean1 {
    private String str;
    //some setter and getter
}

2、创建校验流程类

public class RawValidation1 extends BaseValidation<RawBean1> {
    public RawValidation1(RawBean1 rawBean1) {
        super(rawBean1);
    }

    @Override
    public IResult<RawBean1> onValid(IComparator<RawBean1> comparator) {
        RawBean1 rawBean1 = getRaw();
        //Context context=getContext();
        return comparator
                 //添加一个或多个校验规则
                .addItem(new NotNullRule(rawBean1.getStr(), "str can't not be null","tag1"))
                .validate();//确认校验规则
    }
}

3、执行校验，获取结果

IResult result = CValidator.valid(new RawValidation1(bean));
//获取第一个校验错误原因
IReason reason = result.getReasonAtFirst();
//获取原因信息
String message = reason.getMessage();
//获取目标规则、标识、目标字段
IFieldRule<Object> rule = (IFieldRule<Object>) reason.getRule();
String tag = rule.getTag();
Object field = rule.getField();

//是否开启快速校验
CValidator.valid(Raw bean,Boolean quickMode)
//非快速校验时获取所有错误原因
List<IReason> reasons = result.getAllReason();

更多校验规则

EmailRule、EqualsRule、LengthRule、MaxLengthRule、MinLengthRule、MaxRule、MinRule、NotEmptyRule、NotNullRule、NotSpaceRule、UrlRule

自定义校验

添加一个校验手机号的检验规则

public class PhoneRule extends BaseRule<String> {

    private String message;

    public PhoneRule(@Nullable String field, String message) {
        super(field);
        this.message = message;
    }

    /**
     * 校验的具体实现
     *
     * @return true :校验通过   false:校验不通过
     */
    @Override
    public boolean onMatchField(String field) {
        if (field == null||field.length()<=0) return false;
        return Pattern.matches( "^[1]\\d{10}$", field);
    }

    // 返回的错误信息
    @Override
    public String getMessage() {
        return message;
    }

    @Override
    public String getTag() {
        return tag;
    }
}

使用

comparator.addItem(new PhoneRule(rawBean.getPhone(),"手机号格式不正确"))