利用优雅格局对参数验证实行管理

咱俩在一般的接口函数开拓中,为了安全性,大家都亟需对传播的参数举办表明,确定保证参数遵照我们所梦想的界定输入,要是在限制之外,如空值,不切合的类别等等,都应当付出格外或错误提醒消息。那个参数的证实管理有各个方式,最为轻便的格局就是应用规范语句对参数进行判断,那样的判别代码就算轻便精通,但比较臃肿,如若对八个参数、多少个尺码举办拍卖,那么代码就极度臃肿难以保证了,本篇小说通过深入分析二种分裂的参数验证办法,最后使用较为优雅的秘籍开始展览管理。

日常会规定类型参数是不是允许为空,假如是字符大概有长度限制,假设是整数恐怕须求剖断范围,即便是一对独特的品类比方电话号码,邮件地址等,恐怕须求使用正则表明式实行判别。参照他事他说加以侦查随笔《C#
中参数验证措施的演化
》汉语章的牵线,我们对参数的印证措施有二种。

壹、常规办法的参数验证

相似大家正是对艺术的参数使用规则语句的不二秘诀展开判别,如下函数所示。

public bool Register(string name, int age)
{
    if (string.IsNullOrEmpty(name))
    {
        throw new ArgumentException("name should not be empty", "name");
    }
    if (age < 10 || age > 70)
    {
        throw new ArgumentException("the age must between 10 and 70","age");
    }

    //insert into db
}

或者

public void Initialize(string name, int id)
{
    if (string.IsNullOrEmpty(value))
        throw new ArgumentException("name");
    if (id < 0) 
        throw new ArgumentOutOfRangeException("id");
    // Do some work here.
}

假设复杂的参数校验,那么代码就比较臃肿

void TheOldFashionWay(int id, IEnumerable<int> col, 
    DayOfWeek day)
{
    if (id < 1)
    {
        throw new ArgumentOutOfRangeException("id", 
            String.Format("id should be greater " +
            "than 0. The actual value is {0}.", id));
    }

    if (col == null)
    {
        throw new ArgumentNullException("col",
            "collection should not be empty");
    }

    if (col.Count() == 0)
    {
        throw new ArgumentException(
            "collection should not be empty", "col");
    }

    if (day >= DayOfWeek.Monday &&
        day <= DayOfWeek.Friday)
    {
        throw new InvalidEnumArgumentException(
            String.Format("day should be between " +
            "Monday and Friday. The actual value " +
            "is {0}.", day));
    }

    // Do method work
}

神跡为了方便,会把参数校验的章程,做2个通用的支持类进行管理,如在笔者的公用类Curry面提供了三个:参数验证的通用校验帮助类
ArgumentValidation,使用如下代码所示。

     public class TranContext:IDisposable   
     {   
         private readonly TranSetting setting=null;   
         private IBuilder builder=null;   
         private ILog log=null;   
         private ManuSetting section=null;   
         public event EndReportEventHandler EndReport;   
         public TranContext()   
         {   
        }   
        public TranContext(TranSetting setting)   
        {   
            ArgumentValidation.CheckForNullReference (setting,"TranSetting");   
            this.setting =setting;   
        }   
        public TranContext(string key,string askFileName,string operation)   
        {   
            ArgumentValidation.CheckForEmptyString (key,"key");   
            ArgumentValidation.CheckForEmptyString (askFileName,"askFileName");   
            ArgumentValidation.CheckForEmptyString (operation,"operation");   
            setting=new TranSetting (this,key,askFileName,operation);   
        }  

可是那样的法子依旧相当不足周全,相当不够流畅。

2、基于第1方类库的印证措施

在GitHub上有一点点评释类库也提供了对参数验证的机能,使用起来相比较便捷,采用一种流畅的串联写法。如CuttingEdge.Conditions等。CuttingEdge.Condition
里面包车型大巴事例代码大家来看看。

public ICollection GetData(Nullable<int> id, string xml, IEnumerable<int> col)
{
    // Check all preconditions:
    Condition.Requires(id, "id")
        .IsNotNull()          // throws ArgumentNullException on failure
        .IsInRange(1, 999)    // ArgumentOutOfRangeException on failure
        .IsNotEqualTo(128);   // throws ArgumentException on failure

    Condition.Requires(xml, "xml")
        .StartsWith("<data>") // throws ArgumentException on failure
        .EndsWith("</data>") // throws ArgumentException on failure
        .Evaluate(xml.Contains("abc") || xml.Contains("cba")); // arg ex

    Condition.Requires(col, "col")
        .IsNotNull()          // throws ArgumentNullException on failure
        .IsEmpty()            // throws ArgumentException on failure
        .Evaluate(c => c.Contains(id.Value) || c.Contains(0)); // arg ex

    // Do some work

    // Example: Call a method that should not return null
    object result = BuildResults(xml, col);

    // Check all postconditions:
    Condition.Ensures(result, "result")
        .IsOfType(typeof(ICollection)); // throws PostconditionException on failure

    return (ICollection)result;
}

public static int[] Multiply(int[] left, int[] right)
{
    Condition.Requires(left, "left").IsNotNull();

    // You can add an optional description to each check
    Condition.Requires(right, "right")
        .IsNotNull()
        .HasLength(left.Length, "left and right should have the same length");

    // Do multiplication
}

这种书写方式比较流畅,而且也提供了相比较强硬的参数校验格局,除了能够接纳其IsNotNull、IsEmpty等内置函数,也能够运用Evaluate那一个扩充剖断相当好的函数来管理局地自定义的论断,应该说能够满意绝大许多的参数验证必要了,唯1不佳的就是急需动用那几个第三方类库吧,不常候如需扩张就麻烦一些。而且貌似的话我们团结有部分公用类库,倘诺对参数验证也还索要引入3个类库,还是相比费心一些的(个人见解)

 

3、Code Contract

Code
Contracts
 是微软研讨院开采的三个编制程序类库,笔者最早看到是在C#
In
Depth
 的第1版中,当时.NET
4.0还尚无出来,当时是当做八个第二方类仓库储存在的,到了.NET
4.0自此,已经插手到了.NET BCL中,该类存在于System.Diagnostics.Contracts
那么些命名空间中。

那么些是美其名曰:契约编制程序

 C#代码契约源点于微软支付的壹门研商语言Spec#(参见http://mng.bz/4147)。

    •
契约工具:包罗:ccrewrite(贰进制重写器,基于项目标安装确定保证契约得以贯彻进行)、ccrefgen(它生成契约引用集,为客户端提供契约信息)、cccheck(静态检查器,确认保证代码能在编写翻译时满足供给,而不是但是检查在实践时实际会产生哪些)、ccdocgen(它可感觉代码中钦命的契约生成xml文书档案)。

    • 契约体系:前置条件、前置条件、固定条件、断言和如果、旧式契约。

      •
代码契约工具下载及安装:下载地址Http://mng.bz/cn贰k。(代码契约工具并不带有在Visual
Studio 20第10中学,然而其基本类型位于mscorlib内。)

    • 命名空间:System.Diagnostics.Contracts.Contract

Code Contract 使得.NET
中契约式设计和编制程序变得更加的轻松,Contract中的那一个静态方法方法包含

  1. Requires:函数入口处必须满意的准绳
  2. Ensures:函数出口处必须知足的标准
  3. Invariants:全体成员函数出口处都无法不满意的尺度
  4. Assertions:在某一点必须满意的规格
  5. Assumptions:在某一点一定满意的标准,用来压缩不必要的警告音讯

Code Contract
的行使文书档案您能够从官方网站下载到。为了方便使用Visual
Studio开辟。大家得以设置二个Code Contracts for
.NET
 插件。安装完了今后,点击Visual
Studio中的项目性质,能够看到如下丰裕的选拔项:

图片 1

Contract和Debug.Assert有些地点相似:

  1. 都提供了运维时帮忙:那几个Contracts都以可以被运维的,并且只要条件不被满足,会弹出类似Assert的同等的对话框报错,如下:
  2. 都得以在随心所欲的在代码中关闭张开。

然则Contract有越来越多和更加强劲的法力:

  1. Contracts的来意特别清楚,通过分裂的Requires/Ensures等等调用,代表不相同类别的原则,比单独的Assert更便于驾驭和张开活动深入分析
  2. Contracts的职分特别统1,将三种不相同规范都献身代码的开端处,而非散见在函数的先河和最后,便于寻找和深入分析。
  3. 不相同的开采人士、分歧的小组、分歧的店堂、不一致的库只怕都会有友好的Assert,那就大大扩大了电动分析的难度,也不便宜开拓人士编写代码。而Contracts直接被.NET
    肆.0辅助,是统壹的。
  4. 它提供了静态解析协助,这几个我们可以通过配备面板看到,通过静态分析Contracts,静态深入分析工具得以比较便于调控函数的种种关于音信,以至足以看成速龙lisense

Contract中隐含了七个工具:

  • ccrewrite, 通过向程序集中些如二进制数据,来支撑运转时检测
  • cccheck, 运营时检查测试
  • ccdoc, 将Contract自动生成XML文书档案

松开条件的拍卖,如代码所示。

       /// <summary>
        /// 实现“前置条件”的代码契约
        /// </summary>
        /// <param name="text">Input</param>
        /// <returns>Output</returns>
        public static int CountWhiteSpace(string text)
        {
            // 命名空间:using System.Diagnostics.Contracts;
            Contract.Requires<ArgumentNullException>(text != null, "Paramter:text");// 使用了泛型形式的Requires
            return text.Count(char.IsWhiteSpace);
        }

前置条件(postcondition):表示对章程输出的约束:重回值、out或ref参数的值,以及其余被更动的场馆。Ensures();

        /// <summary>
        /// 实现“后置条件”的代码契约
        /// </summary>
        /// <param name="text">Input</param>
        /// <returns>Output</returns>
        public static int CountWhiteSpace(string text)
        {
            // 命名空间:using System.Diagnostics.Contracts;
            Contract.Requires<ArgumentNullException>(!string.IsNullOrEmpty(text), "text"); // 使用了泛型形式的Requires
            Contract.Ensures(Contract.Result<int>() > 0); // 1.方法在return之前,所有的契约都要在真正执行方法之前(Assert和Assume除外,下面会介绍)。
                                                          // 2.实际上Result<int>()仅仅是编译器知道的”占位符“:在使用的时候工具知道它代表了”我们将得到那个返回值“。
            return text.Count(char.IsWhiteSpace);
        }

        public static bool TryParsePreserveValue(string text, ref int value)
        {
            Contract.Ensures(Contract.Result<bool>() || Contract.OldValue(value) == Contract.ValueAtReturn(out value)); // 此结果表达式是无法证明真伪的。
            return int.TryParse(text, out value); // 所以此处在编译前就会提示错误信息:Code Contract:ensures unproven: XXXXX
        }

其一代码契约功效比较强硬,不过好像对于简易的参数校验,引进这么1个钱物感到麻烦,也丢失开拓人士用的有多大面积,而且还亟需提前设置3个工具:Code
Contracts for
.NET

故此作者也分裂情于采纳这一个插件的东西,因为代码要提交客户利用,要求客户安装叁个插件,并且展开相关的代码契约设置,依然比较麻烦,即便未有展开,也不会告知客户代码编写翻译出错,只是会在运转的时候不校验方法参数。

 

4、使用内置的公用类库管理

基于Cutting艾德ge.Conditions
的主意,其实大家也能够做一个近似这样的流畅性写法的校验管理,而且无需那么劳苦引进第二方类库。

举例大家在公用类Curry面扩大一个类库,如下代码所示。

    /// <summary>
    /// 参数验证帮助类,使用扩展函数实现
    /// </summary>
    /// <example>
    /// eg:
    /// ArgumentCheck.Begin().NotNull(sourceArray, "需要操作的数组").NotNull(addArray, "被添加的数组");
    /// </example>
    public static class ArgumentCheck
    {
        #region Methods

        /// <summary>
        /// 验证初始化
        /// <para>
        /// eg:
        /// ArgumentCheck.Begin().NotNull(sourceArray, "需要操作的数组").NotNull(addArray, "被添加的数组");
        /// </para>
        /// <para>
        /// ArgumentCheck.Begin().NotNullOrEmpty(tableName, "表名").NotNullOrEmpty(primaryKey, "主键");</para>
        /// <para>
        /// ArgumentCheck.Begin().CheckLessThan(percent, "百分比", 100, true);</para>
        /// <para>
        /// ArgumentCheck.Begin().CheckGreaterThan&lt;int&gt;(pageIndex, "页索引", 0, false).CheckGreaterThan&lt;int&gt;(pageSize, "页大小", 0, false);</para>
        /// <para>
        /// ArgumentCheck.Begin().NotNullOrEmpty(filepath, "文件路径").IsFilePath(filepath).NotNullOrEmpty(regexString, "正则表达式");</para>
        /// <para>
        /// ArgumentCheck.Begin().NotNullOrEmpty(libFilePath, "非托管DLL路径").IsFilePath(libFilePath).CheckFileExists(libFilePath);</para>
        /// <para>
        /// ArgumentCheck.Begin().InRange(brightnessValue, 0, 100, "图片亮度值");</para>
        /// <para>
        /// ArgumentCheck.Begin().Check&lt;ArgumentNullException&gt;(() => config.HasFile, "config文件不存在。");</para>
        /// <para>
        /// ArgumentCheck.Begin().NotNull(serialPort, "串口").Check&lt;ArgumentException&gt;(() => serialPort.IsOpen, "串口尚未打开!").NotNull(data, "串口发送数据");
        /// </para>
        /// </summary>
        /// <returns>Validation对象</returns>
        public static Validation Begin()
        {
            return null;
        }

        /// <summary>
        /// 需要验证的正则表达式
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="checkFactory">委托</param>
        /// <param name="argumentName">参数名称</param>
        /// <returns>Validation对象</returns>
        public static Validation Check(this Validation validation, Func<bool> checkFactory, string argumentName)
        {
            return Check<ArgumentException>(validation, checkFactory, string.Format(Resource.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>
        public static Validation Check<TException>(this Validation validation, Func<bool> checkedFactory, string message)
        where TException : Exception
        {
            if(checkedFactory())
            {
                return validation ?? new Validation()
                {
                    IsValid = true
                };
            }
            else
            {
                TException _exception = (TException)Activator.CreateInstance(typeof(TException), message);
                throw _exception;
            }
        }
......

下面提供了一个正规的检讨和泛型类型检查的通用方法,大家只要急需对参数检查,如下代码所示。

ArgumentCheck.Begin().NotNull(sourceArray, "需要操作的数组").NotNull(addArray, "被添加的数组");

而以此NotNull就是我们分局方的定义方法进行扩充的函数,如下代码所示。

        /// <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, () => (data != null), string.Format(Resource.ParameterCheck_NotNull, argumentName));
        }

一样道理大家得以扩大更加多的自定义检查措施,如引进正则表明式的拍卖。

ArgumentCheck.Begin().NotNullOrEmpty(libFilePath, "非托管DLL路径").IsFilePath(libFilePath).CheckFileExists(libFilePath);

它的扩充函数如下所示。

        /// <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, () => ValidateUtil.IsFilePath(data), string.Format(Resource.ParameterCheck_IsFilePath, data));
        }

        /// <summary>
        /// 检查指定路径的文件必须存在,否则抛出<see cref="FileNotFoundException"/>异常。
        /// </summary>
        /// <param name="validation">Validation</param>
        /// <param name="filePath">文件路径</param>
        /// <exception cref="ArgumentNullException">当文件路径为null时</exception>
        /// <exception cref="FileNotFoundException">当文件路径不存在时</exception>
        /// <returns>Validation对象</returns>
        public static Validation CheckFileExists(this Validation validation, string filePath)
        {
            return Check<FileNotFoundException>(validation, () => File.Exists(filePath), string.Format(Resource.ParameterCheck_FileNotExists, filePath));
        }

咱俩能够依据我们的正则表明式校验,封装更加的多的函数举办急速利用,若是要自定义的校验,那么就使用基础的Chek函数就可以。

图片 2

测试下代码应用,如下所示。

        /// <summary>
        /// 应用程序的主入口点。
        /// </summary>
        [STAThread]
        static void Main(string[] args)
        {
            ArgumentCheck.Begin().NotNull(args, "启动参数");
            string test = null;
            ArgumentCheck.Begin().NotNull(test, "测试参数").NotEqual(test, "abc", "test");

其1ArgumentCheck作为公用类库的二个类,由此接纳起来不需求再行引进第壹方类库,也能够落到实处常常的校验管理,以及能够扩充自定义的参数校验,同不经常候也是支撑流式的书写方式,特别方便。 

相关文章