重载最佳实践

Question

我想使用两个静态方法来处理错误。其中一个传递异常对象，另一个仅在需要报告错误时使用，该错误将是基于文本的消息（字符串 errorMessage）。

这两种方法中的代码几乎相同，只是消息的构建方式和发送到日志文件的方式不同。我怎样才能重构这个，这样我就不会重复代码？

public static void ReportError(Exception exceptionRaised, string reference, string customMessage, bool sendEmail)
{
    // get filename
    // check if logfile exists, blah, blah
    // build up message from exception, reference & custom message using string builder
    // save message
    // email error (if set)
}

public static void ReportError(string errorMessage, string reference, bool sendEmail)
{
    // get filename
    // check if logfile exists, blah, blah
    // build up message from errorMessage & reference string builder
    // save message
    // email error (if set)
}

谢谢。

Answer 1

void report(Exception e)
{
  //convert exception to plain text
  string text = e.ToString();
  //re-use the other overload
  report(text);
}

void report(string text)
{
  ...etc...
}

更复杂的版本：

delegate string GetString();

public void report(Exception e)
{
  GetString getString = delegate() { return e.ToString(); }
  report(getText);
}

public void report(string text)
{
  GetString getString = delegate() { return text; }
  report(getText);
}

void report(GetString getString)
{
  ...etc...
  string text = getString();
  ...etc...
}

Answer 2

其他答案都很好，但我想我应该添加一些东西来避免我遇到的维护问题，这

public void report(string text)
{
   ...
   report(text,defaultvalue);
}

public void report(string text, string email)
{
   ...
   report(text,email,null);
}

public void report(string text, string email, List<string> errors)
{
   ...
}
...
etc.

往往是非常烦人的，当你必须重构所有这些方法只是因为你想要更改其中一种方法中的参数。

Answer 3

一个简单的解决方案是将重复的代码提取到它自己的方法中，如下所示：

public static void ReportError(Exception exceptionRaised, string reference, string customMessage, bool sendEmail)
{
    // build up message from exception, reference & custom message using string builder
    ProcessError(Message, SendEmail)
}

public static void ReportError(string errorMessage, string reference, bool sendEmail)
{
    // build up message from errorMessage & reference string builder
    ProcessError(Message, SendEmail)
}

private static void ProcessError(string message, bool sendEmail)
{
    // get filename
    // check if logfile exists, blah, blah
    // save message
    // email error (if set)
}

这当然不是最优雅的方法，但它是一个开始;-)

Answer 4

重载方法时，请确保第一个参数始终相同。否则有点混乱。在您的情况下，将异常作为最后一个参数。

public static void ReportError(string customMessage, string reference, bool sendEmail, Exception exceptionRaised) 

至于代码重复。让这两个方法都调用第三个受保护的方法来进行实际处理。
异常方法可以在调用第三个方法之前格式化异常并将其添加到消息参数中。

Answer 5

鉴于您所做的所有不同都是在第一个方法中构建自定义消息，因此更改您的第一个方法以通过纯文本错误消息方法传递自定义异常：

public static void ReportError(Exception exceptionRaised, string reference, 
    string customMessage, bool sendEmail)
{
    string errorMessage = BuildMessage(exceptionRaised, customMessage);
    ReportError(errorMessage, reference, sendEmail);
}

免责声明：不完全确定这是否有效。这取决于您如何构建错误消息。

编辑：

或者您可以添加第三个重载：

private static void ReportError(string completeException, bool sendEmail)
{
     // Do what needs to be done.
}

然后您的方法可以构建异常消息并传递该字符串和 sendEmail 布尔值到第三个重载。

Answer 6

您能否仅使用较少的参数来调用具有较多参数的重载，并传入 null 或“”作为自定义消息？

public static void ReportError(string errorMessage,
                               string reference,
                               bool sendEmail)
{
    ReportError(errorMessage, reference, null, sendEmail);
}

请注意，如果您使用的是 C# 4，则可以使用可选参数来执行此操作，而无需重载。