EasyValidate優(yōu)雅地校驗(yàn)提交數(shù)據(jù)完整性
前言
在日常的Android開發(fā)中,我們?cè)谧龅卿涀?cè)等帶有提示性輸入校驗(yàn)的時(shí)候。常常會(huì)寫樣子寫代碼:
然后你會(huì)發(fā)現(xiàn)每一次寫帶有提交信息頁面的時(shí)候都不得不去編寫這種千篇一律的代碼,那。。。。有沒有一種更加優(yōu)雅得實(shí)現(xiàn)方式呢?So,我就是在這種情況下去編寫了一個(gè)項(xiàng)目,希望自己能把更多的注意力放在其他地方。(PS:比如偷懶)
一、如何優(yōu)雅地實(shí)現(xiàn)代碼
說到用優(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
使用方法,在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種注解驗(yàn)證,注:Plan字段等下再說
① 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中注解后,我們就可以開始愉快的編程了。試著在控件上面這樣子使用,噢不,先得調(diào)用一個(gè)方法,使用與 Butternife
一致,畢竟是基于它寫出來的。以下為初始化時(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)容是吧!這樣子便于拓展。
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);
需要變化一下
釋放資源
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, plan = Plan.B) EditText et_input3;
調(diào)用驗(yàn)證的方法
if(!IVALIDATE.isValidatePass(Plan.DEFAULT)){ //Todo 驗(yàn)證不通過 return; }
以上就是綁定界面、使用注解、開始驗(yàn)證、解綁界面一整套的流程了,是不是很簡(jiǎn)單。。。哦對(duì)了,在上面調(diào)用驗(yàn)證方法是會(huì)有一個(gè) Plan.DEFAULT
這個(gè)是干嘛的呢?請(qǐng)接著看。
Plan的使用(注解中默認(rèn)的Plan為DEFAULT)
當(dāng)我們?cè)陂_發(fā)的時(shí)候。假設(shè)會(huì)有以下這么一種需求:
手機(jī)號(hào)碼
驗(yàn)證碼
用戶名
密碼
手機(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)證不通過 return; }
if(!IVALIDATE.isValidatePass(Plan.B)){ //Todo 驗(yàn)證不通過 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),這下可沒毛病了吧!
使用的注意事項(xiàng)
組件化
開發(fā)時(shí)要配合Butternife使用,我懶得去生成R2文件了,畢竟重復(fù)造輪子沒意義是吧。 結(jié)言
嗯。。。效果圖我就不發(fā)了。就這樣子吧。實(shí)現(xiàn)的原理大部分來源于Butternife,啊哈哈哈。以上,這是我的第一篇博客,算是對(duì)自己辛苦成果的獎(jiǎng)勵(lì)吧。。。。拜!
GitHub地址: https://github.com/EiuaLee/EasyValidate
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
Android 使用Vitamio打造自己的萬能播放器(3)——本地播放(主界面、播放列表)
本文主要介紹 Android Vitamio本地播放功能,這里提供實(shí)例代碼和效果圖以便大家參考,有需要的小伙伴可以參考下2016-07-07Android仿微信頁面底部導(dǎo)航效果代碼實(shí)現(xiàn)
本文給大家分享一段代碼有關(guān)android仿微信頁面底部導(dǎo)航效果代碼實(shí)現(xiàn)的思路,非常不錯(cuò),感興趣的朋友一起看看吧2016-09-09簡(jiǎn)單仿寫Android控件SlidingMenu的實(shí)例代碼
下面小編就為大家分享一篇簡(jiǎn)單仿寫Android控件SlidingMenu的實(shí)例代碼,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2018-01-01Android實(shí)現(xiàn)音頻條形圖效果(仿音頻動(dòng)畫無監(jiān)聽音頻輸入)
這篇文章主要介紹了Android實(shí)現(xiàn)音頻條形圖效果(仿音頻動(dòng)畫無監(jiān)聽音頻輸入)的相關(guān)資料,非常不錯(cuò),具有參考借鑒價(jià)值,需要的朋友可以參考下2016-09-09AndroidStudio3.6的卸載安裝,Gradle持續(xù)下載/Gradle Build失敗等問題
這篇文章主要介紹了AndroidStudio3.6的卸載安裝,Gradle持續(xù)下載/Gradle Build失敗等問題,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-03-03Android 網(wǎng)絡(luò)狀態(tài)實(shí)時(shí)監(jiān)聽代碼實(shí)例(一)
本文給大家介紹Android 網(wǎng)絡(luò)狀態(tài)實(shí)時(shí)監(jiān)聽代碼實(shí)例(一),對(duì)android網(wǎng)絡(luò)狀態(tài)監(jiān)聽相關(guān)知識(shí)感興趣的朋友一起學(xué)習(xí)吧2016-03-03淺談Android實(shí)踐之ScrollView中滑動(dòng)沖突處理解決方案
涉及到了ViewPager,MapView,ListView,就需要ScrollView來做一下支援,這篇文章主要介紹了淺談Android實(shí)踐之ScrollView中滑動(dòng)沖突處理解決方案,有需要的可以來了解一下。2016-12-12android開發(fā)之蜂鳴提示音和震動(dòng)提示的實(shí)現(xiàn)原理與參考代碼
蜂鳴提示音和震動(dòng)提示此功能在手機(jī)使用中很實(shí)用,最近在讀zxing項(xiàng)目,學(xué)到了不少東西;我們一起來看看他是怎么做的,感興趣的朋友可以了解下哦2013-01-01Android中butterknife的使用與自動(dòng)化查找組件插件詳解
這篇文章主要給大家介紹了關(guān)于Android中butterknife的使用與自動(dòng)化查找組件插件的相關(guān)資料,文中通過示例代碼介紹的非常詳細(xì),對(duì)各位Android開發(fā)者們具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面來一起學(xué)習(xí)學(xué)習(xí)吧2019-10-10