ドメイン駆動開発_フォルダー構成編_#45_例外の作成

前回は例外についてのお話をしました。今回は例外の作り方について解説していきます。

Exceptionsフォルダーの作成

Domainプロジェクトを右クリックして，「追加」「新しいフォルダー」を選択します。

フォルダーの名前をExceptionsとします。

任意のExceptionの作成

それでは実際にExceptionを作成していきます。今回の例では，GetLatestを呼び出した先で，データが0件だった場合の例外を作ります。

Exceptionsフォルダーを右クリックして，「追加」「クラス」の順に選択します。

クラス名を「DataNotExistsExeption」とします。名前は任意の名前でOKですが，語尾に「Exeption」と付けたほうが命名規約上わかりやすいでしょう。データが存在しないときは，この例外が通知されるという事にします。

例外の実装

DataNotExistsExeptionに次のように実装します。

using System;

namespace NDDD.Domain.Exceptions
{
    public sealed class DataNotExistsException : Exception
    {
        public DataNotExistsException():
            base("データがありません")
        {
        }
    }
}

例外は必ずExceptionクラスを継承します。そうすると，マイクロソフトが作成した例外と自分で作った例外を同じように扱うことができます。引数なしのコンストラクタを１つ作り，継承しているExceptionに“データありません”というメッセージを引き渡しています。ここは，メッセージを引数で受けてそのまま引き渡しても構いません。

例外の通知

それでは例外を使ってみましょう。今回はRepositoryの具象クラスの解説で作成したMeasureRepositoryでデータを取得したときに，データがなかった場合は例外通知としてみましょう。

using NDDD.Domain.Entities;
using NDDD.Domain.Exceptions;

namespace NDDD.Domain.Repositories
{
    public sealed class MeasureRepository
    {
        private IMeasureRepository _repository;

        public MeasureRepository(IMeasureRepository repository)
        {
            _repository = repository;
        }

        public MeasureEntity GetLatest()
        {
            var val1 = _repository.GetLatest();
            if(val1 == null)
            {
                throw new DataNotExistsExeption();
            }

            System.Threading.Thread.Sleep(1000);
            var val2 = _repository.GetLatest();
            System.Threading.Thread.Sleep(1000);
            var val3 = _repository.GetLatest();

            var sum = 
                val1.MeasureValue.Value +
                val2.MeasureValue.Value + 
                val3.MeasureValue.Value;

            var ave = sum / 3f;
            return new MeasureEntity(
                val3.AreaId.Value, 
                val3.MeasureDate.Value,
                ave);
        }
    }
}

SQLを実行したときに，GetLatestでNullが帰るように実装すると想定して，Nullの場合にDataNotExistsExeptionを通知しています。

ViewModelでの例外

このように実装すると，ViewModelのGetLatestを呼び出した部分で例外となります。

先述した通り，成功したとき以外は，次の行に行かないような実装となります。

Searchボタンクリックイベントでキャッチする

LatestViewのSearchボタンクリックイベントでは，catchしてメッセージを表示します。

using NDDD.WinForm.ViewModels;
using System;
using System.Windows.Forms;

namespace NDDD.WinForm.Views
{
    public partial class LatestView : BaseForm
    {
        private LatestViewModel _viewModel = new LatestViewModel();
        public LatestView()
        {
            InitializeComponent();
          
            AreaIdTextBox.DataBindings.Add("Text", _viewModel, nameof(_viewModel.AreaIdText));
            MeasureDateTextBox.DataBindings.Add("Text", _viewModel, nameof(_viewModel.MeasureDateText));
            MeasureValueTextBox.DataBindings.Add("Text", _viewModel, nameof(_viewModel.MeasureValueText));
        }

        private void SearchButton_Click(object sender, System.EventArgs e)
        {
            try
            {
                _viewModel.Search();
            }
            catch(Exception ex)
            {
                MessageBox.Show(ex.Message);
            }
        }
    }
}

MessageBox.Showでメッセージを表示しています。

FakeでNullを返す

データなしのテストをするためにMeasureFakeでは強制的にNullを返却するように変更します。

using NDDD.Domain;
using NDDD.Domain.Entities;
using NDDD.Domain.Ripositories;
using System;

namespace NDDD.Infrastructure.Fake
{
    internal sealed class MeasureFake : IMeasureRepository
    {
        public MeasureEntity GetLatest()
        {
            return null;

            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),
                    Convert.ToSingle(value));
            }
            catch
            {
                ////Fakeファイルがない場合はデフォルト値を返す
                return new MeasureEntity(10, Convert.ToDateTime("2020/12/12 12:34:56"), 123.341f);
            }
        }
    }
}

プログラムの実行

「データがありません」のメッセージが表示されることが確認できます。このような感じで，エラーを例外で表現していきます。