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(),"手机号格式不正确"))
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,033评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,725评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,473评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,846评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,848评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,691评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,053评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,700评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,856评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,430评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,034评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2 343