web-dev-qa-db-ja.com

Exception.MessageとException.ToString（）

Exception.Messageを記録しているコードがあります。しかし、Exception.ToString()を使用する方が良いと述べている記事を読みました。後者の場合、エラーに関するより重要な情報を保持します。

これは本当ですか？すべてのコードロギングException.Messageを置き換えても安全ですか？

log4net のXMLベースのレイアウトも使用しています。 Exception.ToString()に問題を引き起こす可能性のある無効なXML文字が含まれている可能性はありますか？

c#.netexceptionexception-handling
183
JL.

Exception.Message には、例外に関連付けられたメッセージ（doh）のみが含まれます。例：

オブジェクト参照がオブジェクトインスタンスに設定されていません

Exception.ToString() メソッドは、例外タイプ、メッセージ（前から）、スタックトレース、ネストされた/内部の例外のこれらすべてを含む、より詳細な出力を提供します。より正確には、このメソッドは次を返します。

ToStringは、人間が理解することを目的とした現在の例外の表現を返します。例外にカルチャ依存データが含まれる場合、ToStringによって返される文字列表現は、現在のシステムカルチャを考慮する必要があります。返される文字列の形式には厳密な要件はありませんが、ユーザーが認識したオブジェクトの値を反映しようとする必要があります。

ToStringのデフォルト実装は、現在の例外をスローしたクラスの名前、メッセージ、内部例外でToStringを呼び出した結果、およびEnvironment.StackTraceを呼び出した結果を取得します。これらのメンバーのいずれかがnull参照（Visual BasicではNothing）である場合、その値は返される文字列に含まれません。

エラーメッセージがない場合、または空の文字列（ ""）である場合、エラーメッセージは返されません。内部例外の名前とスタックトレースは、それらがnull参照（Visual BasicではNothing）でない場合にのみ返されます。

248
Jørn Schou-Rode

すでに言われたことに加えて、do n't例外オブジェクトでToString()を使用してユーザーに表示します。 Messageプロパティで十分であるか、より高いレベルのカスタムメッセージである必要があります。

ロギングの目的に関しては、ほとんどのシナリオで、特にこの例外が発生した場所とコールスタックを頭に引っかかれたままになるため、Messageプロパティだけでなく、例外でToString()を必ず使用してください。だった。スタックトレースはあなたにそれをすべて伝えていただろう。

49
Wim Hollebrandse

@JornSchouRodeが指摘しているように、exception.ToString()を実行すると、単にexception.Messageプロパティを使用するよりも多くの情報が得られます。ただし、これでも次のような多くの情報が除外されます。

  1. すべての例外で見つかったDataコレクションプロパティ。
  2. 例外に追加された他のカスタムプロパティ。

この追加情報をキャプチャしたい場合があります。以下のコードは上記のシナリオを処理します。また、例外のプロパティをニースの順序で書き出します。 C＃6.0を使用していますが、必要に応じて古いバージョンに簡単に変換できます。 this 関連する回答も参照してください。

public static class ExceptionExtensions
{
    public static string ToDetailedString(this Exception exception)
    {
        if (exception == null)
        {
            throw new ArgumentNullException(nameof(exception));
        }

        return ToDetailedString(exception, ExceptionOptions.Default);
    }

    public static string ToDetailedString(this Exception exception, ExceptionOptions options)
    {
        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 with Serilog.Exceptions を使用することを検討してくださいSerilogは非常に高度なロギングフレームワークであり、執筆時点で大流行しています。

ヒント-人間が読めるスタックトレース

Ben.Demystifier NuGetパッケージを使用して、例外の人間が読めるスタックトレースを取得するか、Serilogを使用している場合は serilog-enrichers-demystify NuGetパッケージを使用できます。

18
Muhammad Rehan Saeed

@Wimは正しいと思います。ログファイルにはToString()を使用し（技術的な対象者を想定）、Messageを使用して、ユーザーに表示する必要があります。すべての例外の種類と発生（ArgumentExceptionsなどを考えてください）に対して、それでもユーザーには適さないと主張することができます。

また、StackTraceに加えて、ToString()には、他では得られない情報が含まれます。たとえば、フュージョンの出力。 enabled の場合、例外「メッセージ」にログメッセージが含まれます。

一部の例外タイプには、ToString()には追加情報（たとえば、カスタムプロパティから）が含まれますが、メッセージには含まれません。

9
Christian.K

必要な情報に依存します。スタックトレースと内部例外のデバッグには便利です。

    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";
    }
8
Carra

Log4netのXML形式に関しては、ログのex.ToString（）を心配する必要はありません。例外オブジェクト自体を渡すだけで、残りはlog4netによって事前設定されたXML形式ですべての詳細が提供されます。ときどき遭遇するのは改行の書式設定だけですが、それが生のファイルを読み取るときです。それ以外の場合、XMLの解析はうまく機能します。

3
Dillie-O

まあ、それはあなたがログに見たいものに依存していると思いますか？ ex.Messageが提供するものに満足している場合は、それを使用してください。それ以外の場合は、ex.toString（）を使用するか、スタックトレースを記録します。

0
Thorsten Dittmar