参数验证最佳实践

Question

参数验证最佳实践

Use*_*ser 11 c# validation parameter-passing

想象一下,你有一个应用程序,它是你所有业务逻辑的某种前端.这个前端有很多依赖它的DLL,并且这些DLL中的方法可能在前端单次执行给定方法时重复调用.如果您的应用程序的用户不直接访问这些DLL,您应该......

1)冒险(小)性能命中并验证每种方法中的参数,即使您最终可以验证相同的参数大约5次; 要么

2)风险意外行为并假设,当您验证输入参数时,传入和传出内部代码的所有其他可能参数都是有效的(例如,既不为null也不为空)？

编辑:举个例子,假设你有一个正则表达式RegexA和一个方法

internal bool Matches(string expression)
{
    return RegexA.IsMatch(expression);
}

Run Code Online (Sandbox Code Playgroud)

IsMatch将在null参数上抛出异常,但不在空字符串上抛出异常.如果您事先知道空字符串永远不会与该正则表达式匹配,那么您if (String.IsNullOrEmpty(expression))以前是否应该使用它,即使知道它可能在IsMatch框架方法中被验证为无效？在这种情况下,您显然正在重复验证,但重复它还是冒风险更好？

Answer 1

Str*_*ior 12

除非参数的验证成本很高,否则我会选择#1.快速失败的行为使您可以在很短的时间内捕获错误,这将比在每个方法开始时编写一些保护语句节省更多的时间.

您可能感兴趣的一项技术是.NET的代码契约,它允许您创建准编译时检查,以确保没有人确认输入与预期模式匹配时没有人调用方法.

我个人尝试使用Code Contracts,发现我的需求有一点点开销.但是,我很欣赏语法,所以我创建了一个类来帮助这些保护语句,但这只能在运行时使用.它的工作原理如下:

public void ChangeUserName(int userId, string name)
{
    Require.ThatArgument(userId > 0);
    Require.ThatArgument(!string.IsNullOrWhitespace(name,
        () => "Usernames must be non-empty strings");
    var user = GetUser(userId);
    Require.That(user != null, 
        () => new UserDoesNotExistException("No user exists with ID " + userId));
    user.Name = name;
    ...
}

Run Code Online (Sandbox Code Playgroud)

Resharper的Annotations是一项有助于这些检查的最终技术.例如,请考虑以下方法:

[CanBeNull]
public User GetUser(int userId)
{
    var user =  ... // Get the user from the db
    return user;
}

Run Code Online (Sandbox Code Playgroud)

通过告诉Resharper该方法可能返回一个空值,它会告诉您user在尝试访问之前是否还没有进行空检查user.Name.另一个注释可用于告诉Resharper Require.That(user != null)构成空检查.您也可以像这样重写您的方法:

[NotNull]
public User GetUser(int userId)
{
    Require.ThatArgument(userId > 0);
    var user =  ... // Get the user from the db
    Require.That(user != null)
    return user;
}

Run Code Online (Sandbox Code Playgroud)

通过将此方法标记为NotNull,Resharper可以自动告诉您user != null将始终解析为,true因此您无需检查它.您可以使用各种有趣的东西来简化验证.