NDDD

ドメイン駆動開発_フォルダー構成編_#50_ログの出力

これまで例外や,エラー処理の話をしてきましたが,今回はログの出力についてのお話をしていきます。現状ExceptionProcではエラーメッセージを表示していますが,ログも出したほうが,調査に使えるため,出したほうがいいですね。.NETプログラミングでのログ出力はLog4Netというツールを使うのが一般的です。今回はその使い方を見ていきましょう。

NugetからLog4Netの取得

NDDDのソリューションの部分を右クリックして,「ソリューションのNuGetパッケージの管理」を選択します。

NuGetの画面で,「参照」を選択し,「log4net」と検索窓に入れます。表示されたlog4netを選択し,右側のプロジェクト一覧のDomain,Infrastructure,WinFormの3つにチェックを入れてインストールを押下します。

AssemblyInfo.csへの追記

WinFormのPropertiesの下に,AssemblyInfo.csというファイルがあるので,ダブルクリックします。

AssemblyInfo.csの一番下に,次のように追記します。

log4netでログ出すために必要な記述です。おまじないだと思って書いてください。これを書くのを忘れて結構はまることはあります。

App.configの設定

WinFormの直下にある「App.config」ファイルをダブルクリックします。今は次のようになっていると思います。

Configurationの下に次のように追記します。

ここではログの容量や各種設定項目がありますが,このあたりの細かい解説は割愛します。ネットなどで確認してもらうと,色々出てくるので,アプリケーションの特性に合わせて設定してもらえればいいかと思います。

ログ出力の確認

ここまで出来たら設定は終わりです。これからはどのように使うかを解説します。まず,ログを出力したいクラスを表示して次のように_logger変数を宣言します。これはログを出力するすべてのクラスに記載する必要があります。今回はProgram.csに記載しています。

Program.csのMainメソッドのApplication.Runの前に_loggerに対して,Debug~Fatalまでの記載をしています。ログの書き方はシンプルです。それぞれのレベルに合わせて,ログに書きだしたい文字を設定してください。

ログ出力の確認

この状態で一度プログラムを実行します。

最初のLoginViewが表示された時点でProgram.csは通過しているので,そのまま終了してOKです。

それでは,実行ファイルのあるフォルダーを開いてください。Program.csのタブのところを右クリックして,「このアイテムのフォルダーを開く」を選択すると,WinFormプロジェクトのあるフォルダーまで簡単に表示できます。

開いたフォルダーの中の「bin」フォルダーを開きます。

binの中の「Debug」か「Release」の実行したほうのフォルダーを開きます。Debugモードで実行している場合は「Debug」フォルダーを開きます。

その中に「log」というフォルダーが作成されているはずです。

そのlogフォルダーを開くとログが確認できます。

このようにログが出力されていることが確認できます。WARNなどのログレベルが設定されていることも確認できます。

BaseFormでのログ出力

あとは,ログを出したいクラスで同じように記述すれば,ログが出せます。BaseFormのcatchでログを出したいので,BaseFormに_logger変数を宣言し,catchの部分でログを出力するようにします。

_logger.Error(ex.Message, ex);としていますが,第2引数にex設定することで,エラーの詳細がログに書き込まれます。以前解説したインナーエクセプションの内容なども出るため,ex.Messageだけでは判断できないもログに出力されます。

ExceptionProcに入ったら,すぐにログを書いたほうがいいでしょう。メッセージを出した後にログを出力するようにすると,メッセージを閉じるまでログが書かれませんし,その他の部分でエラーとなった場合は,何も書きこまれない事態になります。ログを優先的に書き込んだほうがいいです。

プログラムの実行

実行して,MeasureFakeの読み込みに失敗させます。

このような感じで,MeasureFake.csvファイルが存在していないことが,エラーログで解析できます。

BaseFormのログの追加

次のように,BaseFormのLoadとFormClosedイベントに画面名でログを書いておけば,ユーザーがどの画面を開いたのか,閉じたのかというのがログに書き込まれるので,解析する場合に役立ちます。

こんな感じで,表示した画面と閉じた画面がログに書き込まれます。BaseFormで実装しているため,今後は画面がいくら増えても,すべての画面が同じように動作してくれます。

NDDD

■動画でのレッスンをご希望の方はこちらからご確認ください

#01_プロジェクトの作成
#02_プロジェクトの追加
#03_依存関係
#04_ドメイン駆動開発でApplication層は必要?
#05_Domainのフォルダー構成
#06_Infrastructureのフォルダー構成
#07_WinFormのフォルダー構成
#08_Testsのフォルダー構成
#09_テスト駆動で実装するための事前準備
#10_テストコードとViewModelの追加
#11_テストコードを追加する
#12_ Repositoriesフォルダーの作成
#13_ Entitiesフォルダーの作成
#14_ Mockの作成
#15_フォーム画面の作成
#16_画面のコントロールデータバインドする
#17_Fakeを使ってタミーデータを画面に表示させる
#18_Fakeデータを画面に通知する
#19_PropertyChangedの方法を変更する
#20_Fakeとデータベースの値を切り替える方法
#21_Sharedクラスを作成する
#22_クラスを生成するファクトリークラスを作る
#23_#if DEBUGでFakeデータがリリースされないようにする
#24_DEBUGモードであることをわかりやすくしておく
#25_Factories以外から生成できないようにしておく
#26_Factoriesの呼び出しはViewModelで行う
#27_外部の設定ファイルの値で判断する
#28_Fakeデータを切り替える方法
#29_FakePathを設定ファイルとSharedに移す
#30_Fakeデータのバリエーション
#31_Shareクラスの活用方法
#32_ベースフォームを作る
#33_SharedにログインIDを記憶する
#34_BaseFormでログインユーザーを表示する
#35_ValueObject
#36_ValueObjectを作成する
#37_抽象クラスValueObjectを使用してイコールの問題の解消
#38_AreaIdにビジネスロジックを入れる
#39_AreaIdクラスをEntityに乗せる
#40_MeasureDateの作成
#41_MeasureValueの作成
#42_オブジェクト指向の自動化
#43_Repositoryの具象クラス
#44_例外処理
#45_例外の作成
#46_インナーエクセプション
#47_例外の欠点
#48_メッセージの区分
#49_エラー処理の共通化
#50_ログの出力
#51_タイマー処理はどこに置く?
#52_タイマークラスの作成
#53_StaticValues
#54_Logics
#55_Helpers
#56_Module
#57_トランザクションはどこでかける?
#58_特徴を見極める
#59_さいごに

■動画でのレッスンをご希望の方はこちらからご確認ください