对于可能忘记分配值的属性的Guard子句

时间:2015-07-07 15:29:32

标签: c# enums guard-clause

我们有一条消息正在传递给方法。

class Message
{
    public int     TransactionId    { get; set; }
    public bool    IsCredit         { get; set; } // Debit when false
    public decimal Amount           { get; set; }
}

class ServiceBus
{
    public IService TheService { get; set; }

    public void SomethingHappen()
    {       
        var message = new Message
        {
            TransactionId = 7,
            Amount        = 6
            // forgot to assign IsCredit
        };
        TheService.DoSomething(message);
    }
}

class Service
{
    public void DoSomething(Message message)
    {
        // Before proceeding with anything else, wanted to put 
        // a guard clause if something was not assigned, e.g., IsCredit             
    }
}

无法检查IsCredit是否忘记分配值,因为未分配的布尔值默认为false,这意味着它是借记,IsCredit = false;的分配无法被检测为未分配,因为它表示借记代替。

所以我建议使用以值1开头的DrCrFlag

public enum DrCrFlag 
{
    Debit  = 1,
    Credit = 2
}

这样,DoSomething方法可以有guard clause,只需检查枚举是否为零,就可以检查是否忘记分配消息的IsCredit属性。

public void DoSomething(Message message)
{
    // Before proceeding with anything else, wanted to put 
    // a guard clause if something was forgotten to be assigned, e.g., IsCredit             
    if (message.DrCrFlag == 0) throw new ArgumentException("DrCrFlag is unassigned");
}

但是,可以在依赖布尔属性的客户端应用程序上破坏数据协定。因此无法将布尔值更改为DrCrFlag。

然后我建议使用一个可以为空的布尔值,它也可以破坏现有的客户端应用程序,但是他们欢迎将布尔值更改为可以为空的布尔值,而不是将布尔值更改为枚举。

这可以实施:

class Message
{
    public int     TransactionId    { get; set; }
    public bool?   IsCredit         { get; set; } // Debit when false
    public decimal Amount           { get; set; }
}

public void DoSomething(Message message)
{
    // Before proceeding with anything else, wanted to put 
    // a guard clause if something was forgotten to be assigned, e.g., IsCredit             
    if (message.IsCredit == null) throw new ArgumentException("IsCredit is unassigned");
}

这是防范未分配变量的正确方法吗?

所有操作都应验证传递给它的值吗?

1 个答案:

答案 0 :(得分:0)

另一种方法是声明类型为<span>的私有成员mIsCredit。然后在你的getter中,你可以检查私有变量的值,如果它是bool?则抛出异常。这样,您的公共财产将保持null类型。