EasyValidate优雅地校验提交数据完整性

前言

在日常的Android开发中,我们在做登录注册等带有提示性输入校验的时候。常常会写样子写代码:

然后你会发现每一次写带有提交信息页面的时候都不得不去编写这种千篇一律的代码,那。。。。有没有一种更加优雅得实现方式呢?So,我就是在这种情况下去编写了一个项目,希望自己能把更多的注意力放在其他地方。(PS:比如偷懒)

一、如何优雅地实现代码

说到用优雅得方式写代码,不得不提AnnotationProcessor,一个用于编译时扫描和处理注解工具。它能很好得帮我们处理一些具有规律的,重复性的代码劳动。So,作为一位矮肥圆,不得不承认,这东西很适合我。所以,我使用它结合Butternife写了一个校验提交前数据合法性的一个工具,用于即将重构的项目。

二、EasyValidate

使用方法,在Project下的build.gradle文件下面的allprojects中添加以下代码片段

allprojects {
  repositories {
    google()
    jcenter()
    maven {url "https://dl.bintray.com/liweihua/maven/"}
  }
}

然后,在module的build.gradle中添加

implementation 'com.eiualee:easyvalidate:1.0.0'
  annotationProcessor 'com.eiualee:easyvalidate-compiler:1.0.0'

三、用法

EasyValidate 提供了3种注解验证,注:Plan字段等下再说

ValidateNull (控件空判断,当控件为空时,提示toast中填写的内容)

@Retention(RetentionPolicy.CLASS)
@Target(ElementType.FIELD)
public @interface ValidateNull {

  int id();//控件ID

  String toast();//不合法时提示的内容

  int[] plan() default {Plan.DEFAULT};//校验计划
}

ValidateCheck (判断控件是否选中状态, 当控件选中的状态与validateState字段的值相同时会提示toast中的内容)

@Retention(RetentionPolicy.CLASS)
@Target(ElementType.FIELD)
public @interface ValidateCheck {

  int id();//控件ID

  String toast();//不合法时提示的内容

  int[] plan() default {Plan.DEFAULT};//校验计划

  boolean validateState() default false;//勾选的值不能与此相同,相同的话提示错误
}

ValidateRegular(判断控件内容是否符合正则表达式)

@Retention(RetentionPolicy.CLASS)
@Target(ElementType.FIELD)
public @interface ValidateRegular {

  int id();//控件ID

  String toast();//不合法时提示的内容

  int[] plan() default {Plan.DEFAULT};//校验计划

  String regular();

}

当了解完上面3中注解后,我们就可以开始愉快的编程了。试着在控件上面这样子使用,噢不,先得调用一个方法,使用与 Butternife 一致,毕竟是基于它写出来的。以下为初始化时调用的代码:

Activity:

IValidate IVALIDATE = EasyValidate.bind(this);
 IVALIDATE.setUnValidateListener(new IValidate.OnViewUnValidateListener() {
    //失败时的回调(viewid:验证失败View的id,toast:注解上的内容)
    @Override
    public void unValidate(int viewId, String toast) {
       ToastUtils.showLongToast(toast);
    }
 });

调用 EasyVlidate.bind(); 方法并返回一个 IValidate ,用 IValidate 实现

一个接口。这个接口主用于校验失败时回调,毕竟失败时不一定都是 Toast 内容是吧!这样子便于拓展。

Fragment

IValidate IVALIDATE = EasyValidate.bind(this, fragmentView);
IVALIDATE.setUnValidateListener(new IValidate.OnViewUnValidateListener() {
    //失败时的回调(viewid:验证失败View的id,toast:注解上的内容)
    @Override
    public void unValidate(int viewId, String toast) {
      ToastUtils.showLongToast(toast);
    }
});

与Activity的使用方法差不多,只是 EasyValidate.bind(this, fragmentView); 需要变化一下

释放资源

IVALIDATE.unBind();

现在为注解使用事项

注解的使用

@ValidateNull(id = R.id.et_input1, toast = "输入框1为空")
EditText et_input1;
@ValidateCheck(id = R.id.cb_check. toast = "请勾选xxxx注意事项后重新提交")
CheckBox cb_check;
//18位身份证号码
public static final String REGEX_ID_CARD = "^[1-9]\\d{5}[1-9]\\d{3}((0\\d)|(1[0-2]))(([0|1|2]\\d)|3[0-1])\\d{3}([0-9Xx])$";
@ValidateRegular(id = R.id.et_input3, toast = "输入框3内容不符合18位身份证", regular = REGEX_ID_CARD, plan = Plan.B)
EditText et_input3;

调用验证的方法

if(!IVALIDATE.isValidatePass(Plan.DEFAULT)){
   //Todo 验证不通过
   return;
}

以上就是绑定界面、使用注解、开始验证、解绑界面一整套的流程了,是不是很简单。。。哦对了,在上面调用验证方法是会有一个 Plan.DEFAULT 这个是干嘛的呢?请接着看。

Plan的使用(注解中默认的Plan为DEFAULT)

当我们在开发的时候。假设会有以下这么一种需求:

手机号码 验证码 用户名 密码
手机号码 验证码

①当用户输入 手机号码 时,只要 验证码 不为空就可以请求登录接口了。

用户名 密码

②当用户输入 用户名 时,只要 密码 不为空就可以请求登录接口了。

那我们要怎么做呢?这下子就会用到Plan这个字段了,请看代码

@ValidateNull(id = R.id.et_phoneNo,toast = "手机号码不能为空",plan = Plan.A)
EditText et_phoneNo;
@ValidateNull(id = R.id.et_checkNo,toast = "手机验证码不能为空",plan = Plan.A)
EditText et_checkNo;
@ValidateNull(id = R.id.et_userName,toast = "手机用户名不能为空",plan = Plan.B)
EditText et_userName;
@ValidateNull(id = R.id.et_pw,toast = "手机密码不能为空",plan = Plan.B)
EditText et_pw;

在调用时分别传入Plan即可

if(!IVALIDATE.isValidatePass(Plan.A)){
   //Todo 验证不通过
   return;
}
if(!IVALIDATE.isValidatePass(Plan.B)){
   //Todo 验证不通过
   return;
}

那当我需求中的判断都需要用到这个控件去判断可咋办呢?

@ValidateNull(id = R.id.et_pw,toast = "手机密码不能为空",plan = {Plan.A, Plan.B})
EditText et_pw;

plan = {Plan.A, Plan.B} 就这么简单,我既参加计划A的校验,也参加计划B的校验,这下可没毛病了吧!

使用的注意事项

组件化 开发时要配合Butternife使用,我懒得去生成R2文件了,毕竟重复造轮子没意义是吧。 结言

嗯。。。效果图我就不发了。就这样子吧。实现的原理大部分来源于Butternife,啊哈哈哈。以上,这是我的第一篇博客,算是对自己辛苦成果的奖励吧。。。。拜!

GitHub地址: https://github.com/EiuaLee/EasyValidate

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持我们。

(0)

相关推荐

  • jQuery Validate表单验证插件 添加class属性形式的校验

    本文实例介绍了jQuery Validate 表单验证插件,添加class属性形式的校验,分享给大家供大家参考,具体内容如下 效果如下: 一.jQuery表单验证插件,添加class属性形式的校验 <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>jQuery表单验证插件----添加cla

  • VeeValidate在vue项目里表单校验应用案例

    VeeValidate是什么: VeeValidate是Vue.js的验证库,它有很多验证规则,并支持自定义规则.它基于模板,因此它与HTML5验证API相似并且很熟悉.您可以验证HTML5输入以及自定义Vue组件.它也是以本地化为基础构建的,实际上我们有大约44种语言由精彩的社区成员支持和维护. 本文包含VeeValidate包含以下几点应用: 1.基本安装使用 2.本地化支持 3.自定义规则和错误消息 4.验证HTML5输入和自定义Vue组件 5.统一提交按钮处理 先看看页面效果: 如果要看

  • Java struts2 validate用户登录校验功能实现

    首先贴一下搭配的环境: 配置: Eclipse4.3.2 jdk1.7_45 Mysql 5.0+ 然后切入正题: 1.login.jsp 主要是使用OGNL 标签 也可使用html form表单,调用LoginAction.action,以post 方式传输. 在LoginaAction 经过判断,然后会有提示信息,需要用到 <s:fielderror/>来显示. <%@ taglib uri="/struts-tags" prefix="s"%

  • jQuery插件Validate实现自定义校验结果样式

    本文实例介绍了jQuery插件Validate实现自定义校验结果样式的详细代码,分享给大家供大家参考,具体内容如下 效果如下: 具体步骤: 1.引入依赖包 <script src="../../scripts/jquery-1.3.1.js" type="text/javascript"></script> <script src="lib/jquery.validate.js" type="text/ja

  • vue中vee validate表单校验的几种基本使用

    今天主要记录一下用vee-validate来进行表单校验的几个基本使用.包括最基础的必填和长度校验:异步请求服务的校验(重名校验),还有延迟校验.如何引入等就不在这里赘述了,直接进入主题. 1.必填和长度校验 直接采用v-validate属性进行配置,不同的校验采用 '|' 隔开.是否有报错根据 errors.has('userName') 进行判断,'userName'对应的是表单的name属性的值. errors.first('userName)会展示表单校验中第一个错误信息. <el-co

  • Vue2.0表单校验组件vee-validate的使用详解

    vee-validate使用教程 本文适合有一定Vue2.0基础的同学参考,根据项目的实际情况来使用,关于Vue的使用不做多余解释.本人也是一边学习一边使用,如果错误之处敬请批评指出* 一.安装 npm install vee-validate@next --save 注意:@next,不然是Vue1.0版本 bower install vee-validate#2.0.0-beta.13 --save 二.引用 import Vue from 'vue'; import VeeValidate

  • bootstrap使用validate实现简单校验功能

    本文实例为大家分享了bootstrap validate校验功能,供大家参考,具体内容如下 <!DOCTYPE html> <html lang="zh-CN"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="

  • jQuery插件EasyUI校验规则 validatebox验证框

    Web前端数据校验组件 Web项目中客户端与服务端的交互离不开Form表单,Form表单中最常用的元素莫过于input标签,input标签首先要用的肯定是text文本框啦! input文本框允许用户任意输入,难免会会有用户输入一些不符合规定的数据,此时,在提交之前对数据校验是很有必要的,如果等到提交到服务端再校验就会大大降低用户体验啦. 前端校验有很多现成的组件,比较好用的有 EasyUI 的 validatebox 插件,提示界面做的相当友好,只是validatebox 默认提供的校验规则比较

  • Struts2中validate数据校验的两种方法详解附Struts2常用校验器

     1.Action中的validate()方法 Struts2提供了一个Validateable接口,这个接口中只存在validate()方法,实现这个接口的类可直接被Struts2调用,ActionSupport类就实现了Vadidateable接口,但他的validate()方法是一个空方法,需要我们来重写. validate()方法会在execute()方法执行前执行,仅当数据校验正确,才执行execute()方法, 如错误则将错误添加到fieldErrors域中,如果定义的Action中

  • vue+VeeValidate 校验范围实例详解(部分校验,全部校验)

    搜索很久,没有发现有关于vue+VeeValidate部分校验的.自己写一个. 主要是两个场景: 1. 校验范围内,所有的字段. 2. 校验全局所有字段. 主要方法: 1.validate(fields, scope) 2. validateAll(fields) 场景: 遍历得到多个列表,每一个列表都可以独立保存当前列表.在保存当前列表的时候,需要校验当前列表输入框的合法性. 代码: <div class=" col-xs-12 col-md-6 col-lg-4" v-for

随机推荐