使用Pitcher简化卫语句

Posted 2021-09-25 dotNET跨平台

什么是卫语句

在方法的开头，我们经常会添加一些检查代码，当检查条件为true时立刻从方法中返回。

这样的单独检查代码被称为“卫语句”。

例如，我们在添加用户时会检查用户名不能为空，年龄必须大于0：

public void AddUser(string name, int age)
{
    if (string.IsNullOrWhiteSpace(name))
    {
        throw new ArgumentException("用户名不能为空!", nameof(name));
    }

    if (age<=0)
    {
        throw new ArgumentOutOfRangeException(nameof(age), "年龄必须大于0!");
    }

    //正常业务逻辑
    ...
}

卫语句可以把我们的视线从异常处理中解放出来，集中精力到实现正常业务逻辑代码中。

Pitcher

但是，当这些检查代码过多时，会让代码显得杂乱无章，可读性较低。

这时，可以使用nuget包Pitcher来帮助我们优化代码。

根据条件抛出异常

示例代码如下:

public void AddUser(string name, int age)
{
    Throw.When(string.IsNullOrWhiteSpace(name), new ArgumentNullException(nameof(name)));
    Throw.When(age <= 0, new ArgumentOutOfRangeException(nameof(age)));

    //正常业务逻辑
    ...
}

简化参数检查

对于ArgumentNullException和ArgumentOutOfRangeException，可以使用更简化的方法。

示例代码如下:

Throw.ArgumentNull.WhenNullOrWhiteSpace(name, nameof(name));
Throw.ArgumentOutOfRange.WhenNegativeNumber(age, nameof(age));

泛型异常

对于没有参数的异常或者不关心参数的情况，可以使用Throw<T>。

示例代码如下:

Throw<InvalidOperationException>.When(age <= 0);

结论

使用Pitcher，可以让卫语句更简单易读。

如果你觉得这篇文章对你有所启发，请关注我的个人公众号”My IO“，记住我