Answers:
Exception.Message
仅包含与异常关联的消息(doh)。例:
你调用的对象是空的
该Exception.ToString()
方法将给出更详细的输出,其中包含异常类型,消息(来自之前),堆栈跟踪以及所有这些嵌套/内部异常的东西。更准确地说,该方法返回以下内容:
ToString返回人类希望理解的当前异常的表示形式。如果异常包含对区域性敏感的数据,则ToString返回的字符串表示形式需要考虑当前的系统区域性。尽管对返回的字符串的格式没有确切的要求,但它应尝试反映用户所感知的对象的值。
ToString的默认实现获取引发当前异常的类的名称,消息,在内部异常上调用ToString的结果以及调用Environment.StackTrace的结果。如果这些成员中的任何一个为空引用(Visual Basic中为Nothing),则其值不包含在返回的字符串中。
如果没有错误消息,或者它是一个空字符串(“”),则不会返回任何错误消息。仅当内部异常的名称和堆栈跟踪不是空引用时才返回(Visual Basic中为Nothing)。
除了什么已经说过,不要使用ToString()
用于显示给用户的例外对象。仅该Message
属性就足够了,或者是更高级别的自定义消息。
就日志记录目的而言,一定ToString()
要在Exception上使用它,而不仅仅是Message
在大多数情况下使用该属性,就像在大多数情况下一样,您将不知所措,具体是发生此异常的位置以及调用堆栈是什么。stacktrace会告诉您所有这些。
调用不仅Exception.ToString()
为您提供了更多信息,还提供了更多信息Exception.Message
。但是,即使如此,仍然遗漏了大量信息,包括:
Data
集合属性上的所有异常发现。有时您想捕获这些额外的信息。下面的代码处理上述情况。它还以良好的顺序写出异常的属性。它使用的是C#7,但是如果需要的话,应该很容易转换为旧版本。另请参阅此相关答案。
public static class ExceptionExtensions
{
public static string ToDetailedString(this Exception exception) =>
ToDetailedString(exception, ExceptionOptions.Default);
public static string ToDetailedString(this Exception exception, ExceptionOptions options)
{
if (exception == null)
{
throw new ArgumentNullException(nameof(exception));
}
var stringBuilder = new StringBuilder();
AppendValue(stringBuilder, "Type", exception.GetType().FullName, options);
foreach (PropertyInfo property in exception
.GetType()
.GetProperties()
.OrderByDescending(x => string.Equals(x.Name, nameof(exception.Message), StringComparison.Ordinal))
.ThenByDescending(x => string.Equals(x.Name, nameof(exception.Source), StringComparison.Ordinal))
.ThenBy(x => string.Equals(x.Name, nameof(exception.InnerException), StringComparison.Ordinal))
.ThenBy(x => string.Equals(x.Name, nameof(AggregateException.InnerExceptions), StringComparison.Ordinal)))
{
var value = property.GetValue(exception, null);
if (value == null && options.OmitNullProperties)
{
if (options.OmitNullProperties)
{
continue;
}
else
{
value = string.Empty;
}
}
AppendValue(stringBuilder, property.Name, value, options);
}
return stringBuilder.ToString().TrimEnd('\r', '\n');
}
private static void AppendCollection(
StringBuilder stringBuilder,
string propertyName,
IEnumerable collection,
ExceptionOptions options)
{
stringBuilder.AppendLine($"{options.Indent}{propertyName} =");
var innerOptions = new ExceptionOptions(options, options.CurrentIndentLevel + 1);
var i = 0;
foreach (var item in collection)
{
var innerPropertyName = $"[{i}]";
if (item is Exception)
{
var innerException = (Exception)item;
AppendException(
stringBuilder,
innerPropertyName,
innerException,
innerOptions);
}
else
{
AppendValue(
stringBuilder,
innerPropertyName,
item,
innerOptions);
}
++i;
}
}
private static void AppendException(
StringBuilder stringBuilder,
string propertyName,
Exception exception,
ExceptionOptions options)
{
var innerExceptionString = ToDetailedString(
exception,
new ExceptionOptions(options, options.CurrentIndentLevel + 1));
stringBuilder.AppendLine($"{options.Indent}{propertyName} =");
stringBuilder.AppendLine(innerExceptionString);
}
private static string IndentString(string value, ExceptionOptions options)
{
return value.Replace(Environment.NewLine, Environment.NewLine + options.Indent);
}
private static void AppendValue(
StringBuilder stringBuilder,
string propertyName,
object value,
ExceptionOptions options)
{
if (value is DictionaryEntry)
{
DictionaryEntry dictionaryEntry = (DictionaryEntry)value;
stringBuilder.AppendLine($"{options.Indent}{propertyName} = {dictionaryEntry.Key} : {dictionaryEntry.Value}");
}
else if (value is Exception)
{
var innerException = (Exception)value;
AppendException(
stringBuilder,
propertyName,
innerException,
options);
}
else if (value is IEnumerable && !(value is string))
{
var collection = (IEnumerable)value;
if (collection.GetEnumerator().MoveNext())
{
AppendCollection(
stringBuilder,
propertyName,
collection,
options);
}
}
else
{
stringBuilder.AppendLine($"{options.Indent}{propertyName} = {value}");
}
}
}
public struct ExceptionOptions
{
public static readonly ExceptionOptions Default = new ExceptionOptions()
{
CurrentIndentLevel = 0,
IndentSpaces = 4,
OmitNullProperties = true
};
internal ExceptionOptions(ExceptionOptions options, int currentIndent)
{
this.CurrentIndentLevel = currentIndent;
this.IndentSpaces = options.IndentSpaces;
this.OmitNullProperties = options.OmitNullProperties;
}
internal string Indent { get { return new string(' ', this.IndentSpaces * this.CurrentIndentLevel); } }
internal int CurrentIndentLevel { get; set; }
public int IndentSpaces { get; set; }
public bool OmitNullProperties { get; set; }
}
大多数人将使用此代码进行日志记录。考虑将Serilog与我的Serilog.Exceptions NuGet包一起使用,该包还记录异常的所有属性,但在大多数情况下,它的执行速度更快且没有反射。Serilog是一个非常高级的日志记录框架,在撰写本文时非常流行。
您可以使用Ben.Demystifier NuGet程序包来获取人类可读的异常堆栈跟踪,或者使用serilog-enrichers-demystify NuGet程序包(如果您使用的是Serilog)。
取决于您需要的信息。对于调试堆栈跟踪和内部异常很有用:
string message =
"Exception type " + ex.GetType() + Environment.NewLine +
"Exception message: " + ex.Message + Environment.NewLine +
"Stack trace: " + ex.StackTrace + Environment.NewLine;
if (ex.InnerException != null)
{
message += "---BEGIN InnerException--- " + Environment.NewLine +
"Exception type " + ex.InnerException.GetType() + Environment.NewLine +
"Exception message: " + ex.InnerException.Message + Environment.NewLine +
"Stack trace: " + ex.InnerException.StackTrace + Environment.NewLine +
"---END Inner Exception";
}
Exception.ToString()
会给您带来什么,对吧?
StringBuilder
在这种情况下构造一个实例可能比两个新的字符串分配要昂贵,这很有争议,在这里效率更高。并不是说我们要处理迭代。马匹的课程。