ドメイン駆動開発_フォルダー構成編_#46_インナーエクセプション

当サイトではアフィリエイト広告を利用しています。

NDDD

前回は例外の作り方のお話をしました。今回はインナーエクセプションというお話をします。

インナーエクセプションとは?

エラーの元になった例外の事です。Exceptionクラスの引数には,メッセージ以外にInnerExceptionという引数を設定でき,例外を生成するときに,元になった例外を設定しておくことができます。

なぜインナーエクセプションが必要か?

例えばCSVファイルを読み込むときに,いろんな例外が出る可能性があります。ファイルがなかったり,フォルダーがなかったり,アクセスしようとしているパソコンと通信できなかったりします。どんな形であれ,CSVを読めなかった場合は,「CSVの読み込みに失敗しました」というメッセージを出したい場合は,オリジナルの例外として,CsvReadExceptionなどを作成することで解決できます。しかし,本当の例外はネットワークのエラーかファイルのエラーかをログなどには書いておきたいので,CSVの読み込みに失敗したら,CsvReadExceptionを生成して通知するんだけど,元になった例外として,マイクロソフトの通知する例外も設定しておくと,後で調査しやすいなどの利点があります。

インナーエクセプションの使い方

MeasureFakeは無理矢理Nullを返していましたが,それは削除してください。

Fakeのデータを読み込むときに,各種例外が発生する可能性があります。ファイルなしや,フォルダーなし,データなし,valueの1番目に値がなければインデックスエラーなど,いろんな例外が予想されます。いちいち例外によって処理を分けるのは面倒なので,一括でFakeExceptionとして,なんだかわからないけど,とにかくFakeデータの取得に失敗したよという事だけをユーザーインタフェースで伝えるようにします。

FakeExceptionの作成

ドメイン層のExceptionsフォルダーに「FakeException」を新規で作成します。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace NDDD.Domain.Exceptions
{
    public sealed class FakeException : Exception
    {
        public FakeException(string message, Exception exception)
            : base(message, exception)
        {
        }
    }
}

コンストラクタでメッセージとInnerExceptionを受けます。それをそのまま継承しているExceptionに引き渡しています。

MeasureFakeにFakeExceptionを実装する

今作成したFakeExceptionをMeasureFakeで使用します。

using NDDD.Domain;
using NDDD.Domain.Entities;
using NDDD.Domain.Exceptions;
using NDDD.Domain.Repositories;
using System;

namespace NDDD.Infrastructure.Fake
{
    internal sealed class MeasureFake : IMeasureRepository
    {
        public MeasureEntity GetLatest()
        {
            try
            {
                var lines = System.IO.File.ReadAllLines(
                    Shared.FakePath + "MeasureFake.csv");
                var value = lines[0].Split(',');
                return new MeasureEntity(
                    Convert.ToInt32(value[0]),
                    Convert.ToDateTime(value[1]),
                    Convert.ToSingle(value[2]));
            }
            catch(Exception ex)
            {
                throw new FakeException(
                    "MeasureFakeの取得に失敗しました",
                    ex);
                //return new MeasureEntity(
                //    10,
                //    Convert.ToDateTime("2020/12/12 12:34:56"),
                //    123.341f);
            }
        }
    }
}

CatchしたときにFakeExceptionに変換していますが,引数で発生元の例外exを引き渡しています。これで,FakeExceptionだけど,発生元の例外を記憶した例外として通知されます。

MeasureFake.csvのファイルが無い状態にする

CドライブのNDDDFakeフォルダーのMeasureFake.csvファイルの名前をリネームして,ファイルが存在しない状態にします。今回の例ではファイル名の最初にアンダーバーを入れています。

動作の確認

この状態で実行してSearchボタンをクリックすると,FakeExceptionの例外メッセージが表示されることが確認できます。

ブレークポイントを使って確認

LatestViewのSearchボタンクリックイベントのcatchにブレークポイントを置いて,インナーエクセプションが入っていることを確認しましょう。

実行して,ウォッチで中を確認すると,ファイルが見つかりませんでした・・・的なメッセージがInnerExceptionに設定されていることが分かります。このメッセージをログに出力しておけば,エラーの調査が容易になります。こんな感じで,流れの中で発生する例外を自作の例外に置き換えて,インナーエクセプションに起点となった例外を入れることで,エラー処理が容易になります。