前言

??在日常的Android開(kāi)發(fā)中，我們?cè)谧龅卿涀?cè)等帶有提示性輸入校驗(yàn)的時(shí)候。常常會(huì)這樣子寫代碼：

img_code_1.png

??然后你會(huì)發(fā)現(xiàn)每一次寫帶有提交信息頁(yè)面的時(shí)候都不得不去編寫這種千篇一律的代碼，那。。。。有沒(méi)有一種更加優(yōu)雅得實(shí)現(xiàn)方式呢？So,我就是在這種情況下去編寫了一個(gè)項(xiàng)目，希望自己能把更多的注意力放在其他地方。（PS:比如偷懶）

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

??說(shuō)到用優(yōu)雅得方式寫代碼，不得不提AnnotationProcessor,一個(gè)用于編譯時(shí)掃描和處理注解工具。它能很好得幫我們處理一些具有規(guī)律的，重復(fù)性的代碼勞動(dòng)。So,作為一位矮肥圓，不得不承認(rèn)，這東西很適合我。所以，我使用它結(jié)合Butternife寫了一個(gè)校驗(yàn)提交前數(shù)據(jù)合法性的一個(gè)工具，用于即將重構(gòu)的項(xiàng)目。

二、EasyValidate

• 使用方法，在module的build.gradle中添加

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

三、用法

EasyValidate提供了3種注解驗(yàn)證，注：Plan字段等下再說(shuō)

• ① ValidateNull (控件空判斷，當(dāng)控件為空時(shí)，提示toast中填寫的內(nèi)容)

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

    int id();//控件ID

    String toast();//不合法時(shí)提示的內(nèi)容

    int[] plan() default {Plan.DEFAULT};//校驗(yàn)計(jì)劃
}

• ②ValidateCheck (判斷控件是否選中狀態(tài), 當(dāng)控件選中的狀態(tài)與validateState字段的值相同時(shí)會(huì)提示toast中的內(nèi)容)

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

    int id();//控件ID

    String toast();//不合法時(shí)提示的內(nèi)容

    int[] plan() default {Plan.DEFAULT};//校驗(yàn)計(jì)劃

    boolean validateState() default false;//勾選的值不能與此相同,相同的話提示錯(cuò)誤
}

• ③ValidateRegular(判斷控件內(nèi)容是否符合正則表達(dá)式)

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

    int id();//控件ID

    String toast();//不合法時(shí)提示的內(nèi)容

    int[] plan() default {Plan.DEFAULT};//校驗(yàn)計(jì)劃

    String regular();

}

當(dāng)了解完上面3中注解后，我們就可以開(kāi)始愉快的編程了。試著在控件上面這樣子使用，噢不，先得調(diào)用一個(gè)方法，使用與Butternife一致，畢竟是基于它寫出來(lái)的。以下為初始化時(shí)調(diào)用的代碼：

• Activity：

 IValidate IVALIDATE = EasyValidate.bind(this);
 IVALIDATE.setUnValidateListener(new IValidate.OnViewUnValidateListener() {
        //失敗時(shí)的回調(diào)（viewid：驗(yàn)證失敗View的id,toast：注解上的內(nèi)容）
        @Override
        public void unValidate(int viewId, String toast) {        
             ToastUtils.showLongToast(toast);
        }
 });

??調(diào)用EasyVlidate.bind();方法并返回一個(gè)IValidate,用IValidate實(shí)現(xiàn)
一個(gè)接口。這個(gè)接口主用于校驗(yàn)失敗時(shí)回調(diào)，畢竟失敗時(shí)不一定都是Toast內(nèi)容是吧！這樣子便于拓展,嗯，這樣子說(shuō)可能不太直觀，我們來(lái)看一下這個(gè)接口的調(diào)用時(shí)機(jī)
??以下為自動(dòng)化生成的代碼：

  /**
   * @ 驗(yàn)證方法
   */
  @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() {
       //失敗時(shí)的回調(diào)（viewid：驗(yàn)證失敗View的id,toast：注解上的內(nèi)容）
       @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)在為注解使用事項(xiàng)

• 注解的使用

@ValidateNull(id = R.id.et_input1, toast = "輸入框1為空")
EditText et_input1;
@ValidateCheck(id = R.id.cb_check. toast = "請(qǐng)勾選xxxx注意事項(xiàng)后重新提交")
CheckBox cb_check;
//18位身份證號(hào)碼
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內(nèi)容不符合18位身份證", regular = REGEX_ID_CARD)
EditText et_input3;

• 調(diào)用驗(yàn)證的方法

if(!IVALIDATE.isValidatePass(Plan.DEFAULT)){
     //Todo 驗(yàn)證不通過(guò)
     return;
}

以上就是綁定界面、使用注解、開(kāi)始驗(yàn)證、解綁界面一整套的流程了，是不是很簡(jiǎn)單。。。哦對(duì)了，在上面調(diào)用驗(yàn)證方法是會(huì)有一個(gè)Plan.DEFAULT這個(gè)是干嘛的呢？請(qǐng)接著看。

Plan的使用（注解中默認(rèn)的Plan為DEFAULT）

• 當(dāng)我們?cè)陂_(kāi)發(fā)的時(shí)候。假設(shè)會(huì)有以下這么一種需求：
  界面有4個(gè)輸入框，分別為 手機(jī)號(hào)碼 驗(yàn)證碼 用戶名 密碼
  ①當(dāng)用戶輸入手機(jī)號(hào)碼時(shí)，只要驗(yàn)證碼不為空就可以請(qǐng)求登錄接口了。
  ②當(dāng)用戶輸入用戶名時(shí),只要密碼不為空就可以請(qǐng)求登錄接口了。
  那我們要怎么做呢？這下子就會(huì)用到Plan這個(gè)字段了，請(qǐng)看代碼

@ValidateNull(id = R.id.et_phoneNo,toast = "手機(jī)號(hào)碼不能為空",plan = Plan.A)
EditText et_phoneNo;
@ValidateNull(id = R.id.et_checkNo,toast = "手機(jī)驗(yàn)證碼不能為空",plan = Plan.A)
EditText et_checkNo;
@ValidateNull(id = R.id.et_userName,toast = "手機(jī)用戶名不能為空",plan = Plan.B)
EditText et_userName;
@ValidateNull(id = R.id.et_pw,toast = "手機(jī)密碼不能為空",plan = Plan.B)
EditText et_pw;

在調(diào)用時(shí)分別傳入Plan即可

if(!IVALIDATE.isValidatePass(Plan.A)){
     //Todo 驗(yàn)證不通過(guò)
     return;
}

if(!IVALIDATE.isValidatePass(Plan.B)){
     //Todo 驗(yàn)證不通過(guò)
     return;
}

• 那當(dāng)我需求中的判斷都需要用到這個(gè)控件去判斷可咋辦呢？

@ValidateNull(id = R.id.et_pw,toast = "手機(jī)密碼不能為空",plan = {Plan.A, Plan.B})
EditText et_pw;

plan = {Plan.A, Plan.B}就這么簡(jiǎn)單，我既參加計(jì)劃A的校驗(yàn)，也參加計(jì)劃B的校驗(yàn)，這下可沒(méi)毛病了吧！

對(duì)于自定義的View

  //使用@ValidateNull  @ValidateRegular 時(shí)，請(qǐng)務(wù)必手動(dòng)實(shí)現(xiàn)這個(gè)方法
  public CharSequence getText(){
    //這里面的內(nèi)容根據(jù)自身情況定
     return editText.getText();
  }

  //使用@ValidateCheck時(shí)，請(qǐng)務(wù)必手動(dòng)實(shí)現(xiàn)這個(gè)方法
  public boolean isCheck(){
    //這里面的內(nèi)容根據(jù)自身情況定
     return checkBox.isCheck();
  }

使用的注意事項(xiàng)

• 組件化開(kāi)發(fā)時(shí)要配合Butternife使用，我懶得去生成R2文件了，畢竟重復(fù)造輪子沒(méi)意義是吧。

結(jié)言

嗯。。。效果圖我就不發(fā)了。就這樣子吧。實(shí)現(xiàn)的原理大部分來(lái)源于Butternife。

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