Android Saripaar 註解詳解

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

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


寫這篇文章的原因

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

於是，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，通常容器為Activity或Fragment。但也可以用包含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

參數

  • value：double類型，最大值。

@DecimalMin

描述

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

作用範圍

  • TextView

參數

  • value：double類型，最小值。

@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.DMY：dd-MM-yyyy
    • DateFormats.YMD：yyyy-MM-dd
    • DateFormats.MDY：MM-dd-yyyy
    • DateFormats.DMY_TIME_12_HOURS：dd-MM-yyyy hh:mm aa
    • DateFormats.YMD_TIME_12_HOURS：yyyy-MM-dd hh:mm aa
    • DateFormats.MDY_TIME_12_HOURS：MM-dd-yyyy hh:mm aa
    • DateFormats.DMY_TIME_24_HOURS：dd-MM-yyyy kk:mm
    • DateFormats.YMD_TIME_24_HOURS：yyyy-MM-dd kk:mm
    • DateFormats.MDY_TIME_24_HOURS：MM-dd-yyyy kk:mm
  • dateFormatResId：時間格式的資源ID

@IpAddress

描述

判斷輸入的內容是否是一個IP，IPv4或IPv6

作用範圍

  • TextView

@Isbn

描述

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

作用範圍

  • TextView

@Length

描述

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

作用範圍

  • TextView

參數

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

@Max

描述

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

作用範圍

  • TextView

參數

  • value：int類型，最大值。

@Min

描述

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

作用範圍

  • TextView

參數

  • value：int類型，最小值。

@NotEmpty

描述

判斷輸入內容是否非空。

作用範圍

  • TextView

參數

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

@Order

描述

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

作用範圍

  • TextView
  • CheckBox
  • RadioButton
  • RadioGroup
  • Spinner

參數

  • value：int類型，用於確定順序

@Password

描述

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

作用範圍

  • TextView

參數

  • min：最小字元數，預設為6
  • scheme：Scheme類型，利用正則確定密碼的輸入格式，只能為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.DMY：dd-MM-yyyy
    • DateFormats.YMD：yyyy-MM-dd
    • DateFormats.MDY：MM-dd-yyyy
    • DateFormats.DMY_TIME_12_HOURS：dd-MM-yyyy hh:mm aa
    • DateFormats.YMD_TIME_12_HOURS：yyyy-MM-dd hh:mm aa
    • DateFormats.MDY_TIME_12_HOURS：MM-dd-yyyy hh:mm aa
    • DateFormats.DMY_TIME_24_HOURS：dd-MM-yyyy kk:mm
    • DateFormats.YMD_TIME_24_HOURS：yyyy-MM-dd kk:mm
    • DateFormats.MDY_TIME_24_HOURS：MM-dd-yyyy kk:mm
  • dateFormatResId：時間格式的資源ID

@Pattern

描述

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

作用範圍

  • TextView

參數

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

@Select

描述

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

作用範圍

  • Spinner

參數

  • defaultSelection：設置預設值

@Url

描述

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

作用範圍

  • TextView

參數

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

對於@Optional和@Or

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

總結

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

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

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


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

-Advertisement-
Play Games
更多相關文章
  • MySql 表索引設計原則
    索引的優點 1.加快數據的檢索速度，這是創建索引的最主要的原因; 2.通過創建唯一性索引，可以保證資料庫表中每一行數據的唯一性; 3.加速表和表之間的連接; 4.在使用分組和排序子句進行數據檢索時，可以顯著減少查詢中分組和排序的時間。 索引的缺點 1.創建索引和維護索引要耗費時間，這種時間隨著數據量 ...
  • docker安裝redis 5.0.7並掛載外部配置和數據
    環境 CentOS Linux release 7.7.1908 (Core) 拉取redis 5.0.7 鏡像 創建掛載目錄 下載redis.conf "redis.conf 地址" 進入目錄並下載redis.conf 修改redis.conf 創建啟動容器 參數解釋 ...
  • Mongdb可視化工具Studio 3T的使用
    一、官網地址 https://studio3t.com/ 二、下載和安裝 點擊DOWNLOAD即可下載 按照自己電腦系統進行選擇，然後填寫郵箱和選擇行業，第一次登錄如果不提交不會下載，下載完成是一個zip壓縮包（我的電腦是windows系統），解壓縮安裝即可，安裝途中可以自行選擇安裝路徑 安裝完成選 ...
  • 使用SQL語句修改Mysql資料庫字元集的方法
    使用SQL語句修改Mysql資料庫字元集的方法 修改庫： alter database [$database] character set [$character_set] collate [$collation_name] 註：[$database]為資料庫的庫名。[$character_set] ...
  • bayaim——聽課筆記_01.Docker基礎應用 10課.txt
    2019年8月5日18:39:06 10.20.100.21rootbayaim 01-Docker介紹 docker -- go 語言編寫一次運算，到處運行只能 運行在linux 64位系統 docker 組成： （後臺進程） 1.鏡像（image） 2.容器（container） 3.倉庫（re ...
  • Mysql—mysqladmin 命令詳解
    mysqladmin是一個執行管理操作的客戶端程式。它可以用來檢查伺服器的配置和當前狀態、創建和刪除資料庫等。 mysqladmin工具的使用格式：mysqladmin [option] command [command option] command ...... 1.查看mysql的安裝目錄，進 ...
  • bayaim——docker.txt
    #菜鳥教程地址https://www.runoob.com/docker/docker-tutorial.html#docker官方地址倉庫https://hub.docker.com/ docker 安裝 1.更新內核yum update2.下載安裝腳本curl -fsSL https://get ...
  • 【iOS bug記錄】UICollectionviewCell刷新變得這麼莫名其妙？
    項目是一個即時聊天的社交軟體，聊天流採用的是UICollectionView，隨著進度的完善，發現一個特別的bug,UICollectionviewCell的復用，並沒有直接insert進去，而是出現了莫名奇妙的插入方式， 這不是我的圖，這是我在網上找到的，跟我的效果一樣一樣的。link the i ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類