编写前置和后置条件的连贯接口库:CuttingEdge.Conditions

张善友

发布于 2018-01-19 08:08:36

5880

当调用一个方法时，在其执行之前期望其处于特定状态；也需要完成一些工作之后验证结果的状态。这些假设被称为前置条件（pre-conditions ）和后置条件（post-conditions）。开源项目CuttingEdge.Conditions 是一个提供一个 fluent 接口用于指定预生成和 post-conditions的库。 (fluent 接口是通过使用的描述性的名称和方法链的可读性会最大化一个 API 设计样式）。下面是一个用CuttingEdge.Conditions的例子：

public ICollection GetData(Nullable<int> id, string xml, ICollection 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    
    Condition.Requires(col, "col")    
        .IsNotNull()          // throws ArgumentNullException on failure    
        .IsEmpty();           // throws ArgumentException on failure    
    // 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    
}