參數驗證一種方式

来源:https://www.cnblogs.com/MeetYan/archive/2019/04/08/10674204.html
-Advertisement-
Play Games

1. 在調用方法的時候我們需要對輸入參數進行驗證，譬如非空，只能數字類型等； 2. 一些參數驗證都是非常通用的，所以可以累積後續不斷完善； 3. 這種寫法源於之前很早看到一篇博客後續完善，具體地址忘記了，所以現在Github項目採用協議:MIT，非常抱歉； 4. GitHub地址： "MasterC ...


  1. 在調用方法的時候我們需要對輸入參數進行驗證，譬如非空，只能數字類型等；

  2. 一些參數驗證都是非常通用的，所以可以累積後續不斷完善；

  3. 這種寫法源於之前很早看到一篇博客後續完善，具體地址忘記了，所以現在Github項目採用協議:MIT，非常抱歉；

  4. GitHub地址：MasterChief 參數驗證代碼

  5. 歡迎Star，歡迎PR；

1. 代碼實現

using System;
using System.IO;
using System.Text.RegularExpressions;
using MasterChief.DotNet4.Utilities.Common;
using MasterChief.DotNet4.Utilities.Model;
 
namespace MasterChief.DotNet4.Utilities.Operator
{
    /// <summary>
    ///     參數驗證幫助類
    /// </summary>
    public static class ValidateOperator
    {
        #region Methods
 
        /// <summary>
        ///     驗證初始化
        /// </summary>
        /// <returns>Validation</returns>
        public static Validation Begin()
        {
            return null;
        }
 
        /// <summary>
        ///     需要驗證的正則表達式
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="checkFactory">委托</param>
        /// <param name="pattern">正則表達式</param>
        /// <param name="argumentName">參數名稱</param>
        /// <returns>Validation</returns>
        public static Validation Check(this Validation validation, Func<bool> checkFactory, string pattern,
            string argumentName)
        {
            return Check<ArgumentException>(validation, checkFactory,
                string.Format(ValidateResource.ParameterCheck_Match2, argumentName));
        }
 
        /// <summary>
        ///     自定義參數檢查
        /// </summary>
        /// <typeparam name="TException">泛型</typeparam>
        /// <param name="validation">Validation</param>
        /// <param name="checkedFactory">委托</param>
        /// <param name="message">自定義錯誤消息</param>
        /// <returns>Validation</returns>
        /// 時間：2016/7/19 11:37
        /// 備註：
        public static Validation Check<TException>(this Validation validation, Func<bool> checkedFactory,
            string message)
            where TException : Exception
        {
            if (checkedFactory())
                return validation ?? new Validation
                {
                    IsValid = true
                };
 
            var exception = (TException) Activator.CreateInstance(typeof(TException), message);
            throw exception;
        }
 
        /// <summary>
        ///     檢查指定路徑的文件夾必須存在，否則拋出<see cref="DirectoryNotFoundException" />異常。
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="data">判斷數據</param>
        /// <exception cref="ArgumentNullException">ArgumentNullException</exception>
        /// <exception cref="DirectoryNotFoundException">DirectoryNotFoundException</exception>
        /// <returns>Validation</returns>
        public static Validation CheckDirectoryExist(this Validation validation, string data)
        {
            return Check<DirectoryNotFoundException>(validation, () => Directory.Exists(data),
                string.Format(ValidateResource.ParameterCheck_DirectoryNotExists, data));
        }
 
        /// <summary>
        ///     檢查文件類型
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="actualFileExt">實際文件類型；eg: .xls</param>
        /// <param name="expectFileExt">期待文件類型</param>
        /// <returns></returns>
        public static Validation CheckedFileExt(this Validation validation, string actualFileExt,
            string[] expectFileExt)
        {
            var allowFileExts = expectFileExt.ToString(",");
            return Check<FileNotFoundException>(validation, () => expectFileExt.ContainIgnoreCase(actualFileExt),
                string.Format(ValidateResource.ParameterCheck_FileExtCompare, allowFileExts));
        }
 
        /// <summary>
        ///     檢查文件類型
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="actualFileExt">實際文件類型；eg: .xls</param>
        /// <param name="expectFileExt">期待文件類型</param>
        /// <returns></returns>
        public static Validation CheckedFileExt(this Validation validation, string actualFileExt, string expectFileExt)
        {
            return Check<FileNotFoundException>(validation, () => actualFileExt.CompareIgnoreCase(expectFileExt),
                string.Format(ValidateResource.ParameterCheck_FileExtCompare, expectFileExt));
        }
 
        /// <summary>
        ///     檢查指定路徑的文件必須存在，否則拋出<see cref="FileNotFoundException" />異常。
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="data">參數</param>
        /// <exception cref="ArgumentNullException">當文件路徑為null時</exception>
        /// <exception cref="FileNotFoundException">當文件路徑不存在時</exception>
        /// <returns>Validation</returns>
        public static Validation CheckFileExists(this Validation validation, string data)
        {
            return Check<FileNotFoundException>(validation, () => File.Exists(data),
                string.Format(ValidateResource.ParameterCheck_FileNotExists, data));
        }
 
        /// <summary>
        ///     檢查參數必須大於[或可等於，參數canEqual]指定值，否則拋出<see cref="ArgumentOutOfRangeException" />異常。
        /// </summary>
        /// <typeparam name="T">參數類型。</typeparam>
        /// <param name="validation">Validation</param>
        /// <param name="value">判斷數據</param>
        /// <param name="paramName">參數名稱。</param>
        /// <param name="target">要比較的值。</param>
        /// <param name="canEqual">是否可等於。</param>
        /// <exception cref="ArgumentOutOfRangeException">ArgumentOutOfRangeException</exception>
        /// <returns>Validation</returns>
        public static Validation CheckGreaterThan<T>(this Validation validation, T value, string paramName, T target,
            bool canEqual)
            where T : IComparable<T>
        {
            // bool flag = canEqual ? value.CompareTo(target) >= 0 : value.CompareTo(target) > 0;
            var format = canEqual
                ? ValidateResource.ParameterCheck_NotGreaterThanOrEqual
                : ValidateResource.ParameterCheck_NotGreaterThan;
            return Check<ArgumentOutOfRangeException>(validation,
                () => canEqual ? value.CompareTo(target) >= 0 : value.CompareTo(target) > 0,
                string.Format(format, paramName, target));
        }
 
        /// <summary>
        ///     檢查參數必須小於[或可等於，參數canEqual]指定值，否則拋出<see cref="ArgumentOutOfRangeException" />異常。
        /// </summary>
        /// <typeparam name="T">參數類型。</typeparam>
        /// <param name="validation">Validation</param>
        /// <param name="value">判斷數據</param>
        /// <param name="paramName">參數名稱。</param>
        /// <param name="target">要比較的值。</param>
        /// <param name="canEqual">是否可等於。</param>
        /// <exception cref="ArgumentOutOfRangeException">ArgumentOutOfRangeException</exception>
        /// <returns>Validation</returns>
        public static Validation CheckLessThan<T>(this Validation validation, T value, string paramName, T target,
            bool canEqual)
            where T : IComparable<T>
        {
            var format = canEqual
                ? ValidateResource.ParameterCheck_NotLessThanOrEqual
                : ValidateResource.ParameterCheck_NotLessThan;
            return Check<ArgumentOutOfRangeException>(validation,
                () => canEqual ? value.CompareTo(target) <= 0 : value.CompareTo(target) < 0,
                string.Format(format, paramName, target));
        }
 
        /// <summary>
        ///     驗證是否在範圍內
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="data">輸入項</param>
        /// <param name="min">最小值</param>
        /// <param name="max">最大值</param>
        /// <param name="argumentName">參數名稱</param>
        /// <returns>Validation</returns>
        public static Validation InRange(this Validation validation, int data, int min, int max, string argumentName)
        {
            return Check<ArgumentOutOfRangeException>(validation, () => data >= min && data <= max,
                string.Format(ValidateResource.ParameterCheck_Between, argumentName, min, max));
        }
 
        /// <summary>
        ///     是否是中文
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="data">中文</param>
        /// <param name="argumentName">參數名稱</param>
        /// <returns>Validation</returns>
        public static Validation IsChinses(this Validation validation, string data, string argumentName)
        {
            return Check(validation, () => CheckHelper.IsChinses(data), RegexPattern.ChineseCheck, argumentName);
        }
 
        /// <summary>
        ///     是否是電子郵箱
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="email">需要驗證的郵箱</param>
        /// <param name="argumentName">參數名稱</param>
        /// <returns>Validation</returns>
        public static Validation IsEmail(this Validation validation, string email, string argumentName)
        {
            return Check(validation, () => CheckHelper.IsEmail(email), RegexPattern.EmailCheck, argumentName);
        }
 
        /// <summary>
        ///     是否是文件路徑
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="data">路徑</param>
        /// <returns>Validation</returns>
        public static Validation IsFilePath(this Validation validation, string data)
        {
            return Check<ArgumentException>(validation, () => CheckHelper.IsFilePath(data),
                string.Format(ValidateResource.ParameterCheck_IsFilePath, data));
        }
 
        /// <summary>
        ///     是否是十六進位字元串
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="data">驗證數據</param>
        /// <param name="argumentName">參數名稱</param>
        /// <returns>Validation</returns>
        public static Validation IsHexString(this Validation validation, string data, string argumentName)
        {
            return Check(validation, () => CheckHelper.IsHexString(data), RegexPattern.HexStringCheck, argumentName);
        }
 
        /// <summary>
        ///     是否是身份證號碼
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="data">驗證數據</param>
        /// <param name="argumentName">參數名稱</param>
        /// <returns>Validation</returns>
        public static Validation IsIdCard(this Validation validation, string data, string argumentName)
        {
            return Check(validation, () => CheckHelper.IsIdCard(data), RegexPattern.IdCardCheck, argumentName);
        }
 
        /// <summary>
        ///     是否是整數
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="data">需要檢測的字元串</param>
        /// <param name="argumentName">參數名稱</param>
        /// <returns>Validation</returns>
        public static Validation IsInt(this Validation validation, string data, string argumentName)
        {
            return Check(validation, () => CheckHelper.IsInt(data), RegexPattern.IntCheck, argumentName);
        }
 
        /// <summary>
        ///     是否是IP
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="data">需要檢測到IP</param>
        /// <param name="argumentName">參數名稱</param>
        /// <returns>Validation</returns>
        public static Validation IsIp(this Validation validation, string data, string argumentName)
        {
            return Check(validation, () => CheckHelper.IsIp4Address(data), RegexPattern.IpCheck, argumentName);
        }
 
        /// <summary>
        ///     是否是數字
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="data">需要檢測的字元串</param>
        /// <param name="argumentName">參數名稱</param>
        /// <returns>Validation</returns>
        public static Validation IsNumber(this Validation validation, string data, string argumentName)
        {
            return Check(validation, () => CheckHelper.IsNumber(data), RegexPattern.NumberCheck, argumentName);
        }
 
        /// <summary>
        ///     是否是合法埠
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="data">參數值</param>
        /// <param name="paramName">參數名稱</param>
        /// <returns>Validation</returns>
        public static Validation IsPort(this Validation validation, string data, string paramName)
        {
            return Check<ArgumentException>(validation, () => CheckHelper.IsValidPort(data),
                string.Format(ValidateResource.ParameterCheck_Port, paramName));
        }
 
        /// <summary>
        ///     是否是郵政編碼
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="data">郵政編碼</param>
        /// <param name="argumentName">參數名稱</param>
        /// <returns>Validation</returns>
        public static Validation IsPoseCode(this Validation validation, string data, string argumentName)
        {
            return Check(validation, () => CheckHelper.IsPoseCode(data), RegexPattern.PostCodeCheck, argumentName);
        }
 
        /// <summary>
        ///     判斷字元串是否是要求的長度
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="input">驗證的字元串</param>
        /// <param name="requireLength">要求的長度</param>
        /// <param name="argumentName">參數名稱</param>
        /// <returns>Validation</returns>
        public static Validation IsRequireLen(this Validation validation, string input, int requireLength,
            string argumentName)
        {
            return Check<ArgumentException>(
                validation,
                () => input.Length == requireLength,
                string.Format(ValidateResource.ParameterCheck_StringLength, argumentName, requireLength));
        }
 
        /// <summary>
        ///     判斷類型是否能序列化
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="data">輸入項</param>
        /// <returns>Validation</returns>
        /// 時間：2016-01-14 9:57
        /// 備註：
        public static Validation IsSerializable(this Validation validation, object data)
        {
            return Check<ArgumentException>(validation, () => data.GetType().IsSerializable,
                $"該參數類型{data.GetType().FullName}不能序列化！");
        }
 
        /// <summary>
        ///     是否是URL
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="data">url</param>
        /// <param name="argumentName">參數名稱</param>
        /// <returns>Validation</returns>
        public static Validation IsUrl(this Validation validation, string data, string argumentName)
        {
            return Check(validation, () => CheckHelper.IsURL(data), RegexPattern.UrlCheck, argumentName);
        }
 
        /// <summary>
        ///     驗證參數不能等於某個值
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="data">輸入項</param>
        /// <param name="equalObj">比較項</param>
        /// <param name="argumentName">參數名稱</param>
        /// <returns>Validation</returns>
        public static Validation NotEqual(this Validation validation, object data, object equalObj, string argumentName)
        {
            return Check<ArgumentException>(validation, () => data != equalObj,
                string.Format(ValidateResource.ParameterCheck_NotEqual, argumentName, data));
        }
 
        /// <summary>
        ///     驗證非空
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="data">輸入項</param>
        /// <param name="argumentName">參數名稱</param>
        /// <returns>Validation</returns>
        public static Validation NotNull(this Validation validation, object data, string argumentName)
        {
            return Check<ArgumentNullException>(validation, () => CheckHelper.NotNull(data),
                string.Format(ValidateResource.ParameterCheck_NotNull, argumentName));
        }
 
        /// <summary>
        ///     不能為空或者NULL驗證
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="input">輸入項</param>
        /// <param name="argumentName">參數名稱</param>
        /// <returns>Validation</returns>
        public static Validation NotNullOrEmpty(this Validation validation, string input, string argumentName)
        {
            return Check<ArgumentNullException>(validation, () => !string.IsNullOrEmpty(input),
                string.Format(ValidateResource.ParameterCheck_NotNullOrEmpty_String, argumentName));
        }
 
        /// <summary>
        ///     需要驗證的正則表達式
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="input">需要匹配的輸入項</param>
        /// <param name="pattern">正則表達式</param>
        /// <param name="argumentName">參數名稱</param>
        /// <returns>Validation</returns>
        public static Validation RegexMatch(this Validation validation, string input, string pattern,
            string argumentName)
        {
            return Check<ArgumentException>(validation, () => Regex.IsMatch(input, pattern),
                string.Format(ValidateResource.ParameterCheck_Match, input, argumentName));
        }
 
        #endregion Methods
    }
}

2. 使用方法

        public IEnumerable<T> SqlQuery<T>(string sql, IDbDataParameter[] parameters)
        {
            ValidateOperator.Begin()
                .NotNullOrEmpty(sql, "Sql語句")
                .NotNull(parameters, "sql對應參數");
            var dataParameters = CreateParameter(parameters);
            return CurrentConnection.Query<T>(sql, dataParameters, CurrentTransaction);
        }

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

-Advertisement-
Play Games
更多相關文章
  • Python學習 ：多線程 --- 鎖
    多線程 什麼是鎖？ - 鎖通常被用來實現對共用資源的同步訪問。 - 為每一個共用資源創建一個Lock對象，當你需要訪問該資源時，調用acquire方法來獲取鎖對象（如果其它線程已經獲得了該鎖，則當前線程需等待其被釋放），待資源訪問完後，再調用release方法釋放鎖： GIL（Global Inte ...
  • C語言編程筆記丨C 有哪些鮮為人知的特性？
    註：請在linux系統下測試本文中出現的代碼。以下是一些優秀程式員的回答，特此譯註。 Andrew Weimholt 的回覆: switch語句中的case 關鍵詞可以放在if-else或者是迴圈當中 Brian Bi 的回覆： 1. 聲明緊隨用途之後 理解聲明有一條很簡單的法則，不過不是什麼“從左 ...
  • Java開發筆記（八十二）註解的基本單元——元註解
    Java的註解非但是一種標記，還是一種特殊的類型，並且擁有專門的類型定義。前面介紹的五種內置註解，都可以找到對應的類型定義代碼，例如查看註解@Override的源碼，發現它的代碼定義是下麵這樣的： 又如註解@FunctionalInterface，它的源碼定義與之類似： 乍看過去，註解的定義竟與介面 ...
  • 樂位元組-Java8新特性之方法引用
    上一篇小樂介紹了《Java8新特性-函數式介面》，大家可以點擊回顧。這篇文章將接著介紹Java8新特性之方法引用。 上一篇小樂介紹了《Java8新特性-函數式介面》，大家可以點擊回顧。這篇文章將接著介紹Java8新特性之方法引用。 Java8 中引入方法引用新特性,用於簡化應用對象方法的調用， 方法 ...
  • SpringBoot跨域問題
    1.先來說說跨域原理: 跨域原理簡單來說就是發起跨域請求的時候,瀏覽器會對請求域返回的響應信息檢查HTTP頭,如果Access-Control-Allow-Origin包含了自身域,則允許訪問,否則報錯. 2.如何解決跨域問題 2.1 使用@CrossOrigin註解 ①該註解可以使用在方法和類上, ...
  • 接觸Java的15天，初步瞭解面向對象
    面向對象的三打特征：封裝 ，繼承 ，多態 。 圖老師給的，叫我們好好看一看 對象（object）：一個杯子，一臺電腦，一個人，一件衣服 等，都可以稱為對象。 類：類是對象的抽象的分類；比如，人類進行分類可以按性別分類，可以按年齡分類，可以按工作方式分類 等。 類與對象的關係：類是對象的類型，對象是類 ...
  • C#ComboBox控制項“設置 DataSource 屬性後無法修改項集合”的解決方法
    在使用ComboBox控制項時，遇到了重新綁定賦值出問題的情況。正常情況下，對於數據重新賦值的或者綁定數據源的時候，為了防止數據出現問題，都會先清空原來數據，所以就這樣寫了，但是沒有相當恰恰這樣寫就出現問題了。 於是在網上找了一下。發現有人是這樣操作的。靈感突現，再清除下拉列表項的時候首先將Combo ...
  • C#中的session用法
    Session具有以下特點： （1）Session中的數據保存在伺服器端； （2）Session中可以保存任意類型的數據； （2）Session預設的生命周期是20分鐘，可以手動設置更長或更短的時間。 需要註意的是在Session變數存儲過多的數據會消耗比較多的伺服器資源，在使用session時應該 ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類