Android Saripaar 註解詳解

来源:https://www.cnblogs.com/lanxingren/archive/2019/12/02/11973882.html

寫這篇文章的原因 在移動端一般很少使用複雜的表單,一般針對於屬性的更改都會打開一個新的頁面進行更改。雖然不多,但是也會有。如果一個頁面要輸入的內容包括姓名、地址、郵箱、手機號等,對各個屬性的驗證會非常麻煩,並且非常的不優雅。 於是, 就出現了,一種基於規則的 輸入驗證庫,通過註解即可標註驗證規則。 ...


寫這篇文章的原因

在移動端一般很少使用複雜的表單,一般針對於屬性的更改都會打開一個新的頁面進行更改。雖然不多,但是也會有。如果一個頁面要輸入的內容包括姓名、地址、郵箱、手機號等,對各個屬性的驗證會非常麻煩,並且非常的不優雅。

於是,saripaar就出現了,一種基於規則的Android UI輸入驗證庫,通過註解即可標註驗證規則。

使用過程中發現只有四個字:簡單好用。但是官方對註解的使用並沒有一份完整的文檔,故參考源碼整理了現有的所有註解(基於版本2.0.3)。

如何使用

導入依賴

第一步當然是導入依賴啦,可通過implementation 'com.mobsandgeeks:android-saripaar:(latest version)'導入saripaar,將(latest version)替換為最新版本即可。

使用註解

對需要進行驗證的可輸入View加上註解來標註驗證規則,例

@Length(min = 6, max = 9)
private AppCompatEditText et1;

該註解表示et1中的輸入內容長度只能在6到9的閉區間。

實例化Validator

mValidator = new Validator(this);
mValidator.setValidationListener(this);

Validator負責驗證給定容器中的View,通常容器為ActivityFragment。但也可以用包含View的其他類作為容器。

實現ValidationListener

public class MainActivity extends AppCompatActivity implements Validator.ValidationListener {

    // Code…

    @Override
    public void onValidationSucceeded() {
        Toast.makeText(this, "成功了!", Toast.LENGTH_LONG).show();
    }

    @Override
    public void onValidationFailed(List<ValidationError> errors) {
        Toast.makeText(this, "失敗了!", Toast.LENGTH_LONG).show();
    }
}

ValidationListener用戶監聽回調結果,併進行相應的處理。

調用驗證方法

btn.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View v) {
        mValidator.validate();
    }
});

其餘的高級用法在此不做介紹,該文章主要介紹各個註解的使用。

註解

@AssertFalse

描述

用於判斷輸入內容是否為false

作用範圍

  • CheckBox
  • RadioButton
  • RadioGroup

參數

  • sequence:確定規則的判定順序,當單個View有多個規則時生效
  • messageResId:錯誤提示文字的資源文件ID
  • message:錯誤提示文字
    註:所有註解均有這三個參數,故之後註解省略不寫

@AssertTrue

描述

用於判斷輸入內容是否為true

作用範圍

  • CheckBox
  • RadioButton
  • RadioGroup

@Checked

描述

用於判斷輸入內容是否為預設值,預設預設值為true

作用範圍

  • CheckBox
  • RadioButton
  • RadioGroup

參數

  • value:用於設置預設值,預設為true

@ConfirmEmail

描述

判斷當前輸入內容與被@Email註解的View的內容是否一致。
註:當前容器所持有的被@Email註解的View必須且只允許有一個。

作用範圍

  • TextView

@ConfirmPassword

描述

判斷當前輸入內容與被@Password註解的View的內容是否一致。
註:當前容器所持有的被@Password註解的View必須且只允許有一個。

作用範圍

  • TextView

@CreditCard

描述

判斷輸入內容是否符合信用卡卡號規則。

作用範圍

  • TextView

參數

  • cardTypes:是一個數組,用於確定信用卡的類型,每種類型對應著不同的正則表達式
    • Type.AMEX,美國運通卡,對應著^(3[47]\d{13})$
    • Type.DINERS,大萊信用卡,對應著^(30[0-5]\d{11}|3095\d{10}|36\d{12}|3[8-9]\d{12})$
    • Type.DISCOVER,發現卡,對應著^(6011\d{12})$^(64[4-9]\d{13})$^(65\d{14})$
    • Type.MASTERCARD,萬事達卡,對應著^(5[1-5]\d{14})$
    • Type.VISA,簽證卡,對應著^(4)(\d{12}|\d{15})$
    • Type.NONE,不允許任何內置的信用卡,適用於自定義信用卡類型

@DecimalMax

描述

限制輸入內容的最大值,輸入內容會被強轉為Double類型,若輸入文字不符合Double類型,會報ConversionException異常。

作用範圍

  • TextView

參數

  • valuedouble類型,最大值。

@DecimalMin

描述

限制輸入內容的最小值,輸入內容會被強轉為Double類型,若輸入文字不符合Double類型,會報ConversionException異常。

作用範圍

  • TextView

參數

  • valuedouble類型,最小值。

@Digits

描述

判斷輸入內容是否為數字,可定義整數部分以及小數部分的最大位數。

作用範圍

  • TextView

參數

  • integer:整數部分最大位數
  • fraction:小數部分最大位數
    註:輸入內容需滿足正則
    String.format("(\\d{0,%d})(\\.\\d{1,%d})?", integer, fraction);

@Domain

描述

判斷輸入內容是否是一個有效的功能變數名稱。

作用範圍

  • TextView

參數

  • allowLocal:本地地址是否有效,預設為false

@Email

描述

判斷輸入內容是否是一個有效的郵箱地址。

作用範圍

  • TextView

參數

  • allowLocal:本地地址是否有效,預設為false

@Future

描述

判斷輸入的時間是否是未來時間(與當前時間相比)。輸入的時間必須滿足相應的格式。

作用範圍

  • TextView

參數

  • dateFormat:時間的格式,預設為dd-MM-yyyy,以下為saripaar提供的格式(可自定義)
    • DateFormats.DMYdd-MM-yyyy
    • DateFormats.YMDyyyy-MM-dd
    • DateFormats.MDYMM-dd-yyyy
    • DateFormats.DMY_TIME_12_HOURSdd-MM-yyyy hh:mm aa
    • DateFormats.YMD_TIME_12_HOURSyyyy-MM-dd hh:mm aa
    • DateFormats.MDY_TIME_12_HOURSMM-dd-yyyy hh:mm aa
    • DateFormats.DMY_TIME_24_HOURSdd-MM-yyyy kk:mm
    • DateFormats.YMD_TIME_24_HOURSyyyy-MM-dd kk:mm
    • DateFormats.MDY_TIME_24_HOURSMM-dd-yyyy kk:mm
  • dateFormatResId:時間格式的資源ID

@IpAddress

描述

判斷輸入的內容是否是一個IPIPv4IPv6

作用範圍

  • TextView

@Isbn

描述

判斷輸入的內容是否是一個Isbn,即國際標準書號

作用範圍

  • TextView

@Length

描述

限制輸入內容的文本長度,可自定義最大長度和最小長度。

作用範圍

  • TextView

參數

  • min:文本的最小長度,預設為Integer.MIN_VALUE
  • max:文本的最大長度,預設為Integer.MAX_VALUE
  • trim:是否需要先做trim操作,預設為false

@Max

描述

限制輸入內容的最大值,輸入內容會被強轉為Integer類型,若輸入文字不符合Integer類型,會報ConversionException異常。

作用範圍

  • TextView

參數

  • valueint類型,最大值。

@Min

描述

限制輸入內容的最小值,輸入內容會被強轉為Integer類型,若輸入文字不符合Integer類型,會報ConversionException異常。

作用範圍

  • TextView

參數

  • valueint類型,最小值。

@NotEmpty

描述

判斷輸入內容是否非空。

作用範圍

  • TextView

參數

  • trim:判斷之前是否要先trim,預設為false
  • emptyText:設置“空字元串”,可自定義一段文本,當輸入此文本是則為空
  • emptyTextResId:設置“空字元串”的資源文件

@Order

描述

確定校驗欄位的順序。當一個容器有多個View需要檢驗時,可通過該註解確定校驗順序。

作用範圍

  • TextView
  • CheckBox
  • RadioButton
  • RadioGroup
  • Spinner

參數

  • valueint類型,用於確定順序

@Password

描述

用於校驗文本是否符合密碼的規則。

作用範圍

  • TextView

參數

  • min:最小字元數,預設為6
  • schemeScheme類型,利用正則確定密碼的輸入格式,只能為Scheme類型,不可自定義,預設為Password.Scheme.ANY
    • Password.Scheme.ANY.+
    • Password.Scheme.ALPHA\w+
    • Password.Scheme.ALPHA_MIXED_CASE(?=.*[a-z])(?=.*[A-Z]).+
    • Password.Scheme.NUMERIC\d+
    • Password.Scheme.ALPHA_NUMERIC(?=.*[a-zA-Z])(?=.*[\d]).+
    • Password.Scheme.ALPHA_NUMERIC_MIXED_CASE(?=.*[a-z])(?=.*[A-Z])(?=.*[\d]).+
    • Password.Scheme.ALPHA_NUMERIC_SYMBOLS(?=.*[a-zA-Z])(?=.*[\d])(?=.*([^\w])).+
    • Password.Scheme.ALPHA_NUMERIC_MIXED_CASE_SYMBOLS(?=.*[a-z])(?=.*[A-Z])(?=.*[\d])(?=.*([^\w])).+

@Past

描述

判斷輸入的時間是否是過去時間(與當前時間相比)。輸入的時間必須滿足相應的格式。

作用範圍

  • TextView

參數

  • dateFormat:時間的格式,預設為dd-MM-yyyy,以下為saripaar提供的格式(可自定義)
    • DateFormats.DMYdd-MM-yyyy
    • DateFormats.YMDyyyy-MM-dd
    • DateFormats.MDYMM-dd-yyyy
    • DateFormats.DMY_TIME_12_HOURSdd-MM-yyyy hh:mm aa
    • DateFormats.YMD_TIME_12_HOURSyyyy-MM-dd hh:mm aa
    • DateFormats.MDY_TIME_12_HOURSMM-dd-yyyy hh:mm aa
    • DateFormats.DMY_TIME_24_HOURSdd-MM-yyyy kk:mm
    • DateFormats.YMD_TIME_24_HOURSyyyy-MM-dd kk:mm
    • DateFormats.MDY_TIME_24_HOURSMM-dd-yyyy kk:mm
  • dateFormatResId:時間格式的資源ID

@Pattern

描述

判斷輸入的內容是否滿足正則表達式。

作用範圍

  • TextView

參數

  • regex:正則表達式
  • caseSensitive:是否區分大小寫

@Select

描述

判斷選擇的索引是否等於預設值,如果不等於則通過,預設值為0。

作用範圍

  • Spinner

參數

  • defaultSelection:設置預設值

@Url

描述

判斷輸入的內容是否是一個url

作用範圍

  • TextView

參數

  • schemes:是一個數組,url的協議數組,可自定義,預設為{"http", "https", "ftp"}
  • allowFragmentsurl片段是否允許通過,預設為true

對於@Optional@Or

雖然該版本已經有了這兩個註解,但是並不能使用,參考作者在stackoverflow上的回覆,註解將會在2.1.0版本上線

總結

本篇文章簡單介紹了Android Saripaar的用法,並著重列舉了各個註解的作用以及各個參數的意思,方便以後的查詢。

通過閱讀源碼對saripaar有了更深的認識,並對基於註解的框架有了一個完備的認知。

以後如果有時間的話總結一下Android Saripaar實現的細節。


您的分享是我們最大的動力!

更多相關文章
  • 索引的優點 1.加快數據的檢索速度,這是創建索引的最主要的原因; 2.通過創建唯一性索引,可以保證資料庫表中每一行數據的唯一性; 3.加速表和表之間的連接; 4.在使用分組和排序子句進行數據檢索時,可以顯著減少查詢中分組和排序的時間。 索引的缺點 1.創建索引和維護索引要耗費時間,這種時間隨著數據量 ...
  • 環境 CentOS Linux release 7.7.1908 (Core) 拉取redis 5.0.7 鏡像 創建掛載目錄 下載redis.conf "redis.conf 地址" 進入目錄並下載redis.conf 修改redis.conf 創建啟動容器 參數解釋 ...
  • 一、官網地址 https://studio3t.com/ 二、下載和安裝 點擊DOWNLOAD即可下載 按照自己電腦系統進行選擇,然後填寫郵箱和選擇行業,第一次登錄如果不提交不會下載,下載完成是一個zip壓縮包(我的電腦是windows系統),解壓縮安裝即可,安裝途中可以自行選擇安裝路徑 安裝完成選 ...
  • 使用SQL語句修改Mysql資料庫字元集的方法 修改庫: alter database [$database] character set [$character_set] collate [$collation_name] 註:[$database]為資料庫的庫名。[$character_set] ...
  • 2019年8月5日18:39:06 10.20.100.21rootbayaim 01-Docker介紹 docker -- go 語言編寫一次運算,到處運行只能 運行在linux 64位系統 docker 組成: (後臺進程) 1.鏡像(image) 2.容器(container) 3.倉庫(re ...
  • mysqladmin是一個執行管理操作的客戶端程式。它可以用來檢查伺服器的配置和當前狀態、創建和刪除資料庫等。 mysqladmin工具的使用格式:mysqladmin [option] command [command option] command ...... 1.查看mysql的安裝目錄,進 ...
  • #菜鳥教程地址https://www.runoob.com/docker/docker-tutorial.html#docker官方地址倉庫https://hub.docker.com/ docker 安裝 1.更新內核yum update2.下載安裝腳本curl -fsSL https://get ...
  • 項目是一個即時聊天的社交軟體,聊天流採用的是UICollectionView,隨著進度的完善,發現一個特別的bug,UICollectionviewCell的復用,並沒有直接insert進去,而是出現了莫名奇妙的插入方式, 這不是我的圖,這是我在網上找到的,跟我的效果一樣一樣的。link the i ...
一周排行
  • 原來的需求是控制項可見時有動畫,不可見的時候沒有動畫,只寫了EnterAction,沒寫ExitAction,以為空間都隱藏了,總不會再有動畫了。剛好該動畫在一個攝像頭獲取的視頻上面,動畫期間視頻有點卡,動畫隱藏了,視頻還是卡,於是弄了一下測試,發現不寫ExitAction動畫還是在動的。 ...
  • 某些場景併發量太高,需要採用隊列輔助,特此備註:多線程隊列,先進先出 某些情況也會用到阻塞當前線程,等待伺服器返回或者耗時的處理,這種情況,可採用信號量輔助 1 ManualResetEvent allDone = new ManualResetEvent(false);//初始化,開啟阻塞 2 a ...
  • 1.環境 VS2019 16.5.1 .NET Core SDK 3.1.200 Blazor WebAssembly Templates 3.2.0-preview2.20160.5 2.預設綁定 2.1.使用方法 Blazor中Razor組件通過一個名為@bind的HTML元素屬性提供數據綁定功 ...
  • 很多人使用力軟敏捷框架的一個困擾就是表格控制項,力軟並沒有使用常規的jqgrid,而是用了自己的一套 jfgrid。所以今天在這做個簡單的說明,如果你有什麼疑問也可以在評論區提出來,後期的文章會做說明。 首先來講下jfgrid有哪些設置屬性: url 後臺請求地址 param 後臺請求參數 rowda ...
  • public partial class Form1 : Form { CancellationTokenSource cts = new CancellationTokenSource(); public Form1() { InitializeComponent(); } private voi ...
  • 進程守護工具 1.寫在前面 經常寫一些服務程式,有時要監測服務程式的運行狀態,所以就做了一個進程守護工具。 2.分析 通過Process.GetProcessesByName(ProcessName),獲得指定進程列表。 用Process.MainModule.FileName來判斷程式是否運行。 ...
  • 在做劍指offer的題目時,發現每次需要用到樹做為參數來測試自己寫的方法時,都很是痛苦。於是乎就萌生了寫一個利用數據生成樹的方法。簡單測試了下,沒什麼毛病。在這裡貼出來,如果以後發現有bug了會持續在後面更新,也歡迎大家指出其中的不足。 using System; using System.Coll ...
  • bootstrap paginator 分頁 效果圖 1. Demo前的準備 1.1. 編程環境 VS2019 1.2. 準備 分頁插件(bootstrap paginator)下載: https://github.com/lyonlai/bootstrap paginator 下載後找到 這個為該 ...
  • 因業務需要瞭解Modbus協議的使用,因此對Modbus的協議,以及相應的C#處理應用進行瞭解,針對協議的幾種方式(RTU、ASCII、TCPIP)進行了封裝,以及對Modbus的各種功能碼的特點進行了詳細的瞭解,本篇隨筆基於這些知識進行了一定的梳理和介紹,主要內容包括Modbus協議簡要介紹、Mo... ...
  • 出問題的代碼如下: public class DBBookChaptersService : IBookChaptersService { private readonly BooksContext _booksContext; public DBBookChaptersService(BooksC ...