函数的命名和结构

Question

这是我第一次在这里发布问题，所以如果我做错了什么，请纠正我。我只是很难找到命名函数的正确方法。 我应该首先说我正在开发一个 Windows Phone 项目，并且使用的语言是 C#。 我有一个名为 Ride 的类，如下所示：

public class Ride
{
  public Destination {get; set;}
  public Arrival {get;set;}
  .... 
  public bool IsValid(ErrorLevel level = ErrorLevel.Throw)
  {
    try{
     if(something_is_not_valid)
        throw new SomeException("some message that should be displayed");
     return true; //if it gets here it means it's valid
    }
    catch{Exception){
      if(level == ErrorLevel.Throw) //if I want to throw the exception
         throw;
      return false; //return false, because it's not valid
    }
  }
}

我想了解您对 IsValid 函数的看法。我在我的代码中这样使用它：

public void DoSomethingWithARideOnlyIfItsValid(Ride ride){
   try{
     ride.IsValid();
     //if it gets here, it means
     //that the function didn't throw an error
     rideManager.DoSomething(ride);
   }
   catch(Exception ex){
     MessageBox.Show(ex.Message);
   }
}

所以 IsValid 函数可以接收可以是 Throw 或 Return 的 ErrorLevel 参数。在某些情况下，我只想查看函数返回什么，并将 ErrorLevel.Return 作为参数发送，但在大多数情况下，如果验证失败，我希望它与消息一起引发异常，以便我可以直接展示给用户。太臭了……所以我做错了什么。我想过将名称更改为 Validate，但这并没有让它变得更好。 另一种解决方案是使用一个属性 IsValid，它只会返回 true 或 false，以及一个函数 Validate()，如果出现问题，它将返回一条消息，以便我可以将其显示给用户。你有什么其他的建议？ 谢谢！

Answer 1

我会创建一个类

public class ReturnClass
{
    public ReturnClass()
    {
        IsOk = true;
    }

    public bool IsOk { get; set; }
    public string ErrorText { get; set; }
}

然后做ReturnClass类型的Validate函数的返回值。在 validate 函数中，如果发生错误，将 IsOk 设置为 false，并将错误文本写入属性 ErrorText。

Answer 2

我认为你应该摆脱所有 ErrorLevel 的东西。它使代码复杂化，并且很难说出该方法的作用。

IsValid() 对我来说似乎应该返回一个是/否的答案，并且只有在出现问题时才抛出异常。

public class Ride
{
    public Destination {get; set;}
    public Arrival {get;set;}
    .... 

    public bool IsValid()
    {
        if (Arrival == null)
        {
            throw new ArgumentException("Arrival");
        }

        return DoSomethingToValidateDestionationAndArrival();
    }
}

然后你的调用者看起来像：

public void DoSomethingWithARideOnlyIfItsValid(Ride ride)
{
    try
    {
        if (ride.IsValid() == false)
         {
             throw new Exception("The ride is invalid");
         }

         //if it gets here, it means
         //that the function didn't throw an error
         rideManager.DoSomething(ride);
    }
    catch(Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

现在您可以访问导致错误的真正异常（是参数错误，表明程序有问题），还是用户提供的无效 Ride。代码也更容易阅读。

Answer 3

IsValid 真的必须有 try;catch 吗？难道它不只是抛出，因为 IsValid 的任何调用方法都应该尝试一下；抓住它，因为你想用消息框显示错误。

public class Ride
{
  public Destination {get; set;}
  public Arrival {get;set;}
  .... 
  public void Validate(ErrorLevel level = ErrorLevel.Throw)
  {
     if(level == ErrorLevel.Throw) //if I want to throw the exception
         throw;
     if(something_is_not_valid)
        throw new SomeException("some message that should be displayed");
  }
}

然后在调用者上做这样的事情？

public void DoSomethingWithARideOnlyIfItsValid(Ride ride){
   try{
     ride.Validate();
     rideManager.DoSomething(ride);
   }
   catch(SomeException ex){
      //...
   }
   catch(Exception ex){
     MessageBox.Show(ex.Message);
   }
}

或者说真的，DoSomething(ride) 真的是做什么的？是为了省钱吗？它只是验证什么？这取决于上下文。你在验证什么？检查属性是否为空？如果是这种情况，那么您可以将它们移动到属性的设置器中，因为它们具有支持字段并将验证移动到 DoSomething(ride);