应用优雅模式对参数验证举行拍卖,使用优雅形式对参数验证举办处理

咱俩在形似的接口函数开发中,为了安全性,我们都需要对传播的参数举办表达,确保参数遵照大家所期望的限制输入,要是在限定之外,如空值,不相符的档次等等,都应有提交相当或错误指示消息。那么些参数的辨证处理有多种办法,最为简练的措施就是接纳规范语句对参数举行判定,这样的判断代码即使容易领会,但比较臃肿,假使对五个参数、三个条件举行处理,那么代码就不行臃肿难以保障了,本篇小说通过分析三种不同的参数验证措施,最后选择较为优雅的办法展开处理。

我们在形似的接口函数开发中,为了安全性,我们都亟需对传播的参数举行求证,确保参数遵照我们所期望的限量输入,如若在限定之外,如空值,不适合的品类等等,都应有提交卓殊或不当指示音信。这一个参数的证实处理有多种艺术,最为简单的法门就是采用口径语句对参数举办判定,这样的判断代码即便容易了解,但正如臃肿,如若对五个参数、四个条件举行拍卖,那么代码就可怜臃肿难以维护了,本篇随笔通过分析两种不同的参数验证措施,最后采用较为优雅的法子展开处理。

普通会规定类型参数是否允许为空,假如是字符可能有长度限制,假如是整数可能需要判定范围,要是是部分异样的连串比如电话号码,邮件地址等,可能需要采纳正则表明式举行判断。参考小说《C#
中参数验证措施的嬗变
》粤语章的介绍,大家对参数的认证措施有二种。

一般说来会规定类型参数是否同意为空,假使是字符可能有长度限制,倘使是整数可能需要判定范围,假如是有些例外的门类比如电话号码,邮件地址等,可能需要采取正则表明式举办判断。参考小说《C#
中参数验证措施的嬗变
》中文章的介绍,大家对参数的印证措施有二种。

1、常规形式的参数验证

一般大家就是对艺术的参数使用口径语句的情势举行判断,如下函数所示。

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
}

突发性为了方便,会把参数校验的法门,做一个通用的扶助类举办处理,如在自家的公用类库里面提供了一个:参数验证的通用校验帮忙类
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);   
        }  

然则如此的情势如故不够完美,不够流畅。

1、常规办法的参数验证

诚如我们就是对艺术的参数使用原则语句的法门展开判定,如下函数所示。

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
}

突发性为了有利于,会把参数校验的法子,做一个通用的扶助类举办拍卖,如在自家的公用类库里面提供了一个:参数验证的通用校验协理类
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、基于第三方类库的认证措施

在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等内置函数,也得以动用伊娃(Eva)luate这些扩充判断非凡好的函数来处理局部自定义的判断,应该说可以满意绝大多数的参数验证要求了,唯一糟糕的就是亟需采纳那一个第三方类库吧,有时候如需扩张就麻烦一些。而且一般的话我们自己有一些公用类库,假使对参数验证也还亟需引入一个类库,仍旧相比较麻烦一些的(个人见解)

 

2、基于第三方类库的证实办法

在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等内置函数,也可以使用伊娃(Eva)luate这一个扩充判断非常好的函数来处理局部自定义的判定,应该说可以满意绝大多数的参数验证要求了,唯一不佳的就是亟需动用这一个第三方类库吧,有时候如需扩张就麻烦一些。而且一般的话大家和好有部分公用类库,假设对参数验证也还索要引入一个类库,仍旧相比费心一些的(个人见解)

 

3、Code Contract

Code
Contracts
 是微软研究院开发的一个编程类库,我最早看到是在C#
In
Depth
 的第二版中,当时.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/cn2k。(代码契约工具并不分包在Visual
Studio 2010中,可是其主干类型位于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中的项目性质,能够看看如下丰裕的接纳项:

lovebet爱博体育官网 1

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

  1. 都提供了运转时匡助:这一个Contracts都是足以被周转的,并且只要条件不被满意,会弹出类似Assert的等同的对话框报错,如下:
  2. 都可以在自由的在代码中关闭打开。

不过Contract有更多和更强劲的功用:

  1. Contracts的打算更加分明,通过不同的Requires/Ensures等等调用,代表不同档次的原则,比单独的Assert更易于明白和开展机动分析
  2. Contracts的职务更加统一,将3种不同尺度都坐落代码的启幕处,而非散见在函数的启幕和最终,便于寻找和分析。
  3. 不等的开发人士、不同的小组、不同的公司、不同的库或者都会有自己的Assert,这就大大扩张了自行分析的难度,也不便利开发人士编写代码。而Contracts直接被.NET
    4.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
        }

其一代码契约效率相比强硬,不过好像对于简易的参数校验,引入这么一个钱物感觉麻烦,也不翼而飞开发人士用的有多大面积,而且还亟需超前设置一个工具:Code
Contracts for
.NET

从而我也不赞同于采用那个插件的事物,因为代码要付出客户拔取,要求客户安装一个插件,并且打开相关的代码契约设置,仍旧相比较艰难,倘使没有打开,也不会报告客户代码编译出错,只是会在运转的时候不校验方法参数。

 

3、Code Contract

Code
Contracts
 是微软研讨院开发的一个编程类库,我最早看到是在C#
In
Depth
 的第二版中,当时.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/cn2k。(代码契约工具并不含有在Visual
Studio 2010中,可是其中央类型位于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中的项目性质,可以看出如下充分的接纳项:

lovebet爱博体育官网 2

Contract和Debug.Assert有些地点一般:

  1. 都提供了运行时协助:那多少个Contracts都是可以被运行的,并且只要条件不被满意,会弹出类似Assert的一模一样的对话框报错,如下:
  2. lovebet爱博体育官网,都可以在任意的在代码中关闭打开。

而是Contract有更多和更强大的法力:

  1. Contracts的来意更加清楚,通过不同的Requires/Ensures等等调用,代表不同类型的尺度,比仅仅的Assert更便于精通和举行活动分析
  2. Contracts的岗位更加统一,将3种不同尺度都位居代码的开头处,而非散见在函数的起先和结尾,便于寻找和剖析。
  3. 不等的开发人士、不同的小组、不同的合作社、不同的库或者都会有友好的Assert,这就大大扩展了机动分析的难度,也不便于开发人士编写代码。而Contracts直接被.NET
    4.0补助,是联合的。
  4. 它提供了静态分析协理,那个我们得以经过配备面板看到,通过静态分析Contracts,静态分析工具得以相比较易于精通函数的各个有关音讯,甚至可以当做AMDlisense

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
        }

这一个代码契约效用相比较强硬,但是好像对于简易的参数校验,引入这么一个家伙感觉麻烦,也丢失开发人士用的有多大面积,而且还亟需提前安装一个工具:Code
Contracts for
.NET

之所以我也不赞成于接纳这多少个插件的东西,因为代码要付出客户使用,要求客户安装一个插件,并且打开相关的代码契约设置,还是相比费心,倘诺没有打开,也不会告诉客户代码编译出错,只是会在运转的时候不校验方法参数。

 

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

基于CuttingEdge.Conditions
的措施,其实我们也可以做一个好像这样的流畅性写法的校验处理,而且不需要那么辛勤引入第三方类库。

比如大家在公用类库里面扩展一个类库,如下代码所示。

    /// <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函数即可。

lovebet爱博体育官网 3

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

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

以此ArgumentCheck作为公用类库的一个类,因此利用起来不需要重新引入第三方类库,也可以实现正常化的校验处理,以及可以扩大自定义的参数校验,同时也是支撑流式的书写模式,至极有益。 

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

基于CuttingEdge.Conditions
的方法,其实大家也得以做一个像样这样的流畅性写法的校验处理,而且不需要那么劳累引入第三方类库。

比如大家在公用类库里面扩充一个类库,如下代码所示。

    /// <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函数即可。

lovebet爱博体育官网 4

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

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

本条ArgumentCheck作为公用类库的一个类,因而选取起来不需要再行引入第三方类库,也可以落实正常的校验处理,以及可以扩张自定义的参数校验,同时也是永葆流式的书写情势,相当便利。 

相关文章