前言
在日常的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
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持VEVB武林網。
新聞熱點
疑難解答