C#：为自定义异常重写 ToString() 方法

Question

我有一个自定义异常类，其中包含一些附加字段。我希望将这些写在ToString() 方法中，但是如果我实现自己的ToString()，我会丢失一些其他有用的东西（比如编写异常类型名称、内部异常数据和堆栈跟踪）。

针对此类异常实现您自己的ToString() 方法的最佳方式/模式是什么？理想情况下，它应该重用现有机制，但格式类似于默认的ToString() 实现。

更新：例如，将我的自定义字段添加或附加到 base.ToString() 文本并不理想，恕我直言

PimTool.Utilities.OERestServiceUnavailableException: test ---> System.InvalidOperationException: inner message
   --- End of inner exception stack trace ---
   at PimTool.Tests.Services.OE.OERestClientTests.ExceptionsLogging() in D:\svn\NewPimTool\PimTool.Tests\Services\OE\OERestClientTests.cs:line 178, 
   StatusCode=0, message='test', requestId='535345'

表示自定义字段写在（可能很长）异常描述的末尾。 另一方面，我希望异常类型是描述中写入的第一个信息。

更新 2：我已经为此实施了一个解决方案，请在下面寻找我自己的答案。

Answer 1

您可以通过查看异常属性手动将默认数据添加到ToString 返回的字符串中。比如下面会模拟异常的ToString方法默认返回的数据（假设没有内部异常）：

string.Format("{0}: {1}\r\n{2}", this.GetType().Name, this.Message, this.StackTrace);

或者，您可以简单地将base.ToString 返回的数据附加（或前置）到您要添加的信息中。

Answer 2

在覆盖调用 base.ToString() 中并根据您的需要修改生成的字符串...

Answer 3

您可以重写 ToString() 方法以包含您自己的自定义信息，并且仍然像这样调用默认的基本异常 ToString()：

public class MyException : Exception
{
    public string CustomField { get; set; }
    public override string ToString()
    {
        return CustomField + Environment.NewLine + base.ToString();
    }
}

Answer 4

如果您主要在调试器中查看它们，那么您可以使用[DebuggerDisplay] 属性来指定它们的格式，而无需触及现有的ToString 方法。

否则，只需重载ToString，并确保调用基类版本base.ToString()

Answer 5

好的，这就是我想出的。我已经实现了一个扩展类，它复制了格式化异常的原始机制，但有一个转折：一个自定义 Action 委托，它提供了一个用于格式化自定义字段的插件：

public static class ExceptionFormatterExtensions
{
    public static string ExceptionToString (
        this Exception ex, 
        Action<StringBuilder> customFieldsFormatterAction)
    {
        StringBuilder description = new StringBuilder();
        description.AppendFormat("{0}: {1}", ex.GetType().Name, ex.Message);

        if (customFieldsFormatterAction != null)
            customFieldsFormatterAction(description);

        if (ex.InnerException != null)
        {
            description.AppendFormat(" ---> {0}", ex.InnerException);
            description.AppendFormat(
                "{0}   --- End of inner exception stack trace ---{0}",
                Environment.NewLine);
        }

        description.Append(ex.StackTrace);

        return description.ToString();
    }
}

现在您可以在自己的 ToString() 实现中使用此方法，而无需复制格式化代码：

    public override string ToString()
    {
        return this.ExceptionToString(
            description =>
            {
                description.AppendFormat(
                    ", HttpStatusCode={0}, RequestId='{1}'", 
                    httpStatusCode, 
                    RequestId);
            });
    }

Answer 6

这一切都太过分了。您的异常应该只覆盖 Message 属性。

public override String Message {
    get {  
        return base.Message + String.Format(", HttpStatusCode={0}, RequestId='{1}'", 
                    httpStatusCode, 
                    RequestId);
    }
}

Exception 类的默认 ToString 方法基本上是“ClassName: Message --> InnerException.ToString() StackTrace”。因此，覆盖 Message 会将您的消息文本准确地放在应有的位置。

Answer 7

最简单的方法

public override string ToString()
{
    StringBuilder sb = new();
    var separator = new string[] { Environment.NewLine };
    var str = base.ToString().Split(separator, 2, StringSplitOptions.None);
    sb.AppendLine(str[0]);

    // Your properties

    sb.Append(str[1]);
    return sb.ToString();
}