小编们在一般的接口函数开荒中,为了安全性,大家都亟待对传播的参数实行验证,确定保障参数依据大家所企望的界定输入,要是在界定之外,如空值,不符合的品种等等,都应当付出万分或不当提醒音信。那些参数的印证管理有各个主意,最为简单的法子正是行使条件语句对参数进行剖断,那样的判断代码即使轻巧理解,但正如臃肿,若是对几个参数、多少个标准实行拍卖,那么代码就那二个臃肿难以维护了,本篇小说通过剖析两种不一样的参数验证格局,最终使用较为优雅的措施进行拍卖。

一般会规定类型参数是或不是同意为空,尽管是字符大概有长度限制,如若是整数只怕供给判断范围,若是是某些极度的花色举个例子电话号码,邮件地址等,大概须要选用正则表明式举行判别。参考随笔《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
}

偶尔候为了有利于,会把参数校验的章程,做叁个通用的帮助类进行拍卖,如在自个儿的公用类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、基于第二方类库的表明情势

在GitHub上有一点点表明类库也提供了对参数验证的作用,使用起来相比便利,选用1种流畅的串联写法。如CuttingEdge.Conditions等。Cutting艾德ge.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等内置函数,也得以行使伊娃luate这几个扩充推断相当好的函数来拍卖部分自定义的推断,应该说能够满足绝大多数的参数验证须要了,唯壹倒霉的正是索要选取这些第1方类库吧,一时候如需扩张就劳动一些。而且貌似的话大家温馨有一对公用类库,假诺对参数验证也还亟需引进一个类库,照旧相比麻烦一些的(个人见解)

 

3、Code Contract

Code
Contracts 是微软切磋院开荒的一个编制程序类库,小编最早看到是在C#
In
Depth 的第二版中,当时.NET
四.0还尚无出去,当时是作为二个第三方类仓库储存在的,到了.NET
四.0以往,已经加入到了.NET BCL中,该类存在于System.Diagnostics.Contracts
那么些命名空间中。

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

 C#代码契约起点于微软支付的一门研商语言Spec#(参见

    •
契约工具:包含:ccrewrite(2进制重写器,基于项目标安装确定保证契约得以贯彻实行)、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的1致的对话框报错,如下:
  2. 都足以在随意的在代码中关闭张开。

但是Contract有更加多和越来越强硬的效益:

  1. Contracts的意向特别分明,通过分歧的Requires/Ensures等等调用,代表差异类其他尺度,比单独的Assert更便于精晓和开始展览活动解析
  2. Contracts的地点尤其统壹,将3种不相同口径都投身代码的发端处,而非散见在函数的开端和末段,便于寻觅和分析。
  3. 不等的开拓职员、不一致的小组、区别的公司、不相同的库也许都会有谈得来的Assert,那就大大扩大了自动剖判的难度,也不便于开垦人士编写代码。而Contracts间接被.NET
    肆.0援助,是统一的。
  4. 它提供了静态深入分析帮衬,这么些大家得以经过配备面板看到,通过静态深入分析Contracts,静态分析工具得以比较易于驾驭函数的种种有关新闻,以致能够当做速龙lisense

Contract中蕴藏了八个工具:

  • ccrewrite, 通过向程序聚焦些如2进制数据,来协助运营时检查评定
  • 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
        }

其一代码契约功用比较强硬,但是好像对于简易的参数校验,引进这么一个钱物认为麻烦,也是有失开采职员用的有多大面积,而且还索要超前设置3个工具:Code
Contracts for
.NET。

为此小编也差别情于采取那个插件的东西,因为代码要付出客户使用,必要客户安装一个插件,并且张开相关的代码契约设置,依旧相比费心,要是未有展开,也不会告诉客户代码编译出错,只是会在运转的时候不校验方法参数。

 

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

基于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;
            }
        }
......

地点提供了3个平常化的自己冲突和泛型类型检查的通用方法,大家假若急需对参数检查,如下代码所示。

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");

那个ArgumentCheck作为公用类库的二个类,因而接纳起来无需再度引进第一方类库,也能够完毕健康的校验管理,以及能够增加自定义的参数校验,同时也是永葆流式的书写格局,非常有利于。 

相关文章