EasyValidate,優(yōu)雅地校驗提交數據完整性

前言

??在日常的Android開發(fā)中们颜,我們在做登錄注冊等帶有提示性輸入校驗的時候。常常會這樣子寫代碼:


img_code_1.png

??然后你會發(fā)現(xiàn)每一次寫帶有提交信息頁面的時候都不得不去編寫這種千篇一律的代碼屿附,那彰亥。。递宅。。有沒有一種更加優(yōu)雅得實現(xiàn)方式呢苍狰?So,我就是在這種情況下去編寫了一個項目办龄,希望自己能把更多的注意力放在其他地方。(PS:比如偷懶)

一淋昭、如何優(yōu)雅地實現(xiàn)代碼


??說到用優(yōu)雅得方式寫代碼俐填,不得不提AnnotationProcessor,一個用于編譯時掃描和處理注解工具。它能很好得幫我們處理一些具有規(guī)律的翔忽,重復性的代碼勞動英融。So,作為一位矮肥圓盏檐,不得不承認,這東西很適合我驶悟。所以胡野,我使用它結合Butternife寫了一個校驗提交前數據合法性的一個工具,用于即將重構的項目撩银。

二给涕、EasyValidate


  • 使用方法,在module的build.gradle中添加
    implementation 'com.eiualee:easyvalidate:1.0.3'
    annotationProcessor 'com.eiualee:easyvalidate-compiler:1.0.3'

三额获、用法


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 (判斷控件是否選中狀態(tài), 當控件選中的狀態(tài)與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實現(xiàn)
一個接口。這個接口主用于校驗失敗時回調环鲤,畢竟失敗時不一定都是Toast內容是吧纯趋!這樣子便于拓展,嗯,這樣子說可能不太直觀冷离,我們來看一下這個接口的調用時機
??以下為自動化生成的代碼:

  /**
   * @ 驗證方法
   */
  @UiThread
  public final boolean isEmptyValidate(int plan) {

    if(plan == 0){
         if (TextUtils.isEmpty(EasyValidate.getText(target.tv_test != null?target.tv_test:((TextView)sourse.findViewById(2131165318))))){
           if(listener == null)return false;
           listener.unValidate(2131165318,"文本框不能為空");
           return false;
         }
         if (TextUtils.isEmpty(EasyValidate.getText(target.et_test != null?target.et_test:((EditText)sourse.findViewById(2131165236))))){
           if(listener == null)return false;
           listener.unValidate(2131165236,"輸入框不能為空");
           return false;
         }
         return true;
    }
    return true;
  }

  • 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);需要變化一下

  • 釋放資源
@Override
protected void onDestroy() {
    super.onDestroy();
    IVALIDATE.unBind();
}

現(xiàn)在為注解使用事項

  • 注解的使用
@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)
EditText et_input3;
  • 調用驗證的方法
if(!IVALIDATE.isValidatePass(Plan.DEFAULT)){
     //Todo 驗證不通過
     return;
}

以上就是綁定界面、使用注解西剥、開始驗證痹栖、解綁界面一整套的流程了,是不是很簡單瞭空。揪阿。。哦對了咆畏,在上面調用驗證方法是會有一個Plan.DEFAULT這個是干嘛的呢图甜?請接著看。

Plan的使用(注解中默認的Plan為DEFAULT)

  • 當我們在開發(fā)的時候鳖眼。假設會有以下這么一種需求:
    界面有4個輸入框,分別為 手機號碼 驗證碼 用戶名 密碼
    ①當用戶輸入手機號碼時嚼摩,只要驗證碼不為空就可以請求登錄接口了钦讳。
    ②當用戶輸入用戶名時,只要密碼不為空就可以請求登錄接口了矿瘦。
    那我們要怎么做呢?這下子就會用到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的校驗易结,這下可沒毛病了吧!

對于自定義的View

  //使用@ValidateNull  @ValidateRegular 時柜候,請務必手動實現(xiàn)這個方法
  public CharSequence getText(){
    //這里面的內容根據自身情況定
     return editText.getText();
  }

  //使用@ValidateCheck時搞动,請務必手動實現(xiàn)這個方法
  public boolean isCheck(){
    //這里面的內容根據自身情況定
     return checkBox.isCheck();
  }

使用的注意事項

  • 組件化開發(fā)時要配合Butternife使用,我懶得去生成R2文件了渣刷,畢竟重復造輪子沒意義是吧鹦肿。

結言

嗯。辅柴。箩溃。效果圖我就不發(fā)了。就這樣子吧碌嘀。實現(xiàn)的原理大部分來源于Butternife涣旨。

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

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市股冗,隨后出現(xiàn)的幾起案子霹陡,更是在濱河造成了極大的恐慌,老刑警劉巖魁瞪,帶你破解...
    沈念sama閱讀 217,084評論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件穆律,死亡現(xiàn)場離奇詭異,居然都是意外死亡导俘,警方通過查閱死者的電腦和手機峦耘,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,623評論 3 392
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來旅薄,“玉大人辅髓,你說我怎么就攤上這事∩倭海” “怎么了洛口?”我有些...
    開封第一講書人閱讀 163,450評論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長凯沪。 經常有香客問我第焰,道長,這世上最難降的妖魔是什么妨马? 我笑而不...
    開封第一講書人閱讀 58,322評論 1 293
  • 正文 為了忘掉前任挺举,我火速辦了婚禮杀赢,結果婚禮上,老公的妹妹穿的比我還像新娘湘纵。我一直安慰自己脂崔,他們只是感情好,可當我...
    茶點故事閱讀 67,370評論 6 390
  • 文/花漫 我一把揭開白布梧喷。 她就那樣靜靜地躺著砌左,像睡著了一般。 火紅的嫁衣襯著肌膚如雪铺敌。 梳的紋絲不亂的頭發(fā)上汇歹,一...
    開封第一講書人閱讀 51,274評論 1 300
  • 那天,我揣著相機與錄音适刀,去河邊找鬼秤朗。 笑死,一個胖子當著我的面吹牛笔喉,可吹牛的內容都是我干的取视。 我是一名探鬼主播,決...
    沈念sama閱讀 40,126評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼常挚,長吁一口氣:“原來是場噩夢啊……” “哼作谭!你這毒婦竟也來了?” 一聲冷哼從身側響起奄毡,我...
    開封第一講書人閱讀 38,980評論 0 275
  • 序言:老撾萬榮一對情侶失蹤折欠,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后吼过,有當地人在樹林里發(fā)現(xiàn)了一具尸體锐秦,經...
    沈念sama閱讀 45,414評論 1 313
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,599評論 3 334
  • 正文 我和宋清朗相戀三年盗忱,在試婚紗的時候發(fā)現(xiàn)自己被綠了酱床。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,773評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡趟佃,死狀恐怖扇谣,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情闲昭,我是刑警寧澤罐寨,帶...
    沈念sama閱讀 35,470評論 5 344
  • 正文 年R本政府宣布,位于F島的核電站序矩,受9級特大地震影響鸯绿,放射性物質發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,080評論 3 327
  • 文/蒙蒙 一楞慈、第九天 我趴在偏房一處隱蔽的房頂上張望幔烛。 院中可真熱鬧,春花似錦囊蓝、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,713評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至珠叔,卻和暖如春蝎宇,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背祷安。 一陣腳步聲響...
    開封第一講書人閱讀 32,852評論 1 269
  • 我被黑心中介騙來泰國打工姥芥, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人汇鞭。 一個月前我還...
    沈念sama閱讀 47,865評論 2 370
  • 正文 我出身青樓凉唐,卻偏偏與公主長得像,于是被迫代替她去往敵國和親霍骄。 傳聞我的和親對象是個殘疾皇子台囱,可洞房花燭夜當晚...
    茶點故事閱讀 44,689評論 2 354

推薦閱讀更多精彩內容