在调用方法的时候我们需要对输入参数进行验证，譬如非空，只能数字类型等；
一些参数验证都是非常通用的，所以可以累积后续不断完善；
这种写法源于之前很早看到一篇博客后续完善，具体地址忘记了，所以现在Github项目采用协议:MIT，非常抱歉；
GitHub地址：MasterChief 参数验证代码
欢迎Star，欢迎Issues；
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);
}