Trace クラスによるログファイル出力

(2016/12/03 0:00:38 created.)

(2016/12/03 0:01:09 modified.)

Trace クラスはプリプロセスシンボル TRACE が定義されていない場合はコンパイル対象にはなりませんが、Release ビルド構成でもシンボル TRACE は定義されるため、リリース後のアプリケーションでもログ情報を残したいときなどに使用します。

Trace クラスでリスナーを追加する方法も前節の Debug クラスによる追加方法と同じで、Trace.Listeners プロパティを用い、TextWriterTraceListener クラスを追加するだけです。さらに、実は Debug.Listeners プロパティも Trace.Listeners プロパティも実体は同じインスタンスを参照していますので、どちらを操作しても同じ結果となります。

Trace クラスには Debug クラスと同様の Write()、WriteLine() メソッドの他に、TraceInformation()、TraceWarning()、TraceError() メソッドというものがあります。それぞれ情報、警告、エラーのためのメッセージ出力をおこなうもので、ただ WriteLine() メソッドでメッセージを出力するよりもトレースレベルなどの情報が付加された形でログが残せます。
ただし、その書式が決まってしまっているので、独自にカスタマイズした書式でログを残したい場合には向いていません。

独自にカスタマイズできるように工夫した DebugTrace クラスをサンプルコードとして掲載します。

Program.cs

```
namespace Tips_DebugTrace
```
```
{
```
```
    using System.Diagnostics;
```
```
    using System.IO;
```

    using System.Runtime.CompilerServices;

```
 
```
```
    /// <summary>
```

    /// デバッグ用トレースをおこなうクラスを表します。

```
    /// summary>
```
```
    public static class DebugTrace
```
```
    {
```
```
        /// <summary>
```
```
        /// ログファイル名
```
```
        /// summary>
```

        private static readonly string _logFilePath = "log.txt";

```
 
```
```
        /// <summary>
```

        /// ログファイル出力リスナー名

```
        /// summary>
```

        private static readonly string _listenerName = "LogFile";

```
 
```
```
        /// <summary>
```

        /// 初期化時にログファイルをクリアする

```
        /// summary>
```

        private static readonly bool _clearLogFileAtInitializing = true;

```
 
```
```
        #region 初期化
```
```
        /// <summary>
```

        /// 静的なコンストラクタです。

```
        /// summary>
```
```
        static DebugTrace()
```
```
        {
```
```
            Initialize();
```
```
        }
```
```
 
```
```
        /// <summary>
```

        /// 静的な初期化をおこないます。

        /// Debug 構成のみ有効です。

```
        /// summary>
```
```
        [Conditional("DEBUG")]
```

        private static void Initialize()

```
        {
```

            if (!string.IsNullOrWhiteSpace(_logFilePath))

```
            {
```

                if (_clearLogFileAtInitializing && File.Exists(_logFilePath))

```
                {
```

                    File.Delete(_logFilePath);

```
                }
```
```
 
```

                var fileListener = new TextWriterTraceListener(_logFilePath, _listenerName);

                Trace.Listeners.Add(fileListener);

```
                Trace.AutoFlush = true;
```
```
            }
```
```
        }
```
```
        #endregion 初期化
```
```
 
```
```
        #region 公開メソッド
```
```
        /// <summary>
```

        /// 情報メッセージを出力します。

```
        /// summary>
```

        /// <param name="message">メッセージを指定します。param>

        /// <param name="name">メソッド名を指定します。param>

        /// <param name="filePath">ソースファイルのフルパスを指定します。param>

        /// <param name="lineNumber">行番号を指定します。param>

```
        [Conditional("DEBUG")]
```

        public static void TraceInformation(string message, [CallerMemberName]string name = null, [CallerFilePath]string filePath = null, [CallerLineNumber]int lineNumber = 0)

```
        {
```

            WriteLine(message, "Information", name, filePath, lineNumber);

```
        }
```
```
 
```
```
        /// <summary>
```

        /// 警告メッセージを出力します。

```
        /// summary>
```

        /// <param name="message">メッセージを指定します。param>

        /// <param name="name">メソッド名を指定します。param>

        /// <param name="filePath">ソースファイルのフルパスを指定します。param>

        /// <param name="lineNumber">行番号を指定します。param>

```
        [Conditional("DEBUG")]
```

        public static void TraceWarning(string message, [CallerMemberName]string name = null, [CallerFilePath]string filePath = null, [CallerLineNumber]int lineNumber = 0)

```
        {
```

            WriteLine(message, "Warning", name, filePath, lineNumber);

```
        }
```
```
 
```
```
        /// <summary>
```

        /// エラーメッセージを出力します。

```
        /// summary>
```

        /// <param name="message">メッセージを指定します。param>

        /// <param name="name">メソッド名を指定します。param>

        /// <param name="filePath">ソースファイルのフルパスを指定します。param>

        /// <param name="lineNumber">行番号を指定します。param>

```
        [Conditional("DEBUG")]
```

        public static void TraceError(string message, [CallerMemberName]string name = null, [CallerFilePath]string filePath = null, [CallerLineNumber]int lineNumber = 0)

```
        {
```

            WriteLine(message, "Error", name, filePath, lineNumber);

```
        }
```
```
        #endregion 公開メソッド
```
```
 
```
```
        #region ヘルパ
```
```
        /// <summary>
```

        /// メッセージを出力するためのヘルパです。

```
        /// summary>
```

        /// <param name="message">メッセージを指定します。param>

        /// <param name="type">メッセージの種別を指定します。param>

        /// <param name="name">メソッド名を指定します。param>

        /// <param name="filePath">ソースファイルのフルパスを指定します。param>

        /// <param name="lineNumber">行番号を指定します。param>

```
        [Conditional("DEBUG")]
```

        private static void WriteLine(string message, string type, [CallerMemberName]string name = null, [CallerFilePath]string filePath = null, [CallerLineNumber]int lineNumber = 0)

```
        {
```

            var str = string.Format("{0}({1}): {4} :{2} {3}", filePath, lineNumber, name != null ? " [" + name + "]" : "", message, type);

```
            Trace.WriteLine(str);
```
```
        }
```
```
        #endregion ヘルパ
```
```
    }
```
```
}
```