ドメイン駆動開発_フォルダー構成編_#53_StaticValues

今回はStaticValuesというお話をします。StaticValuesという名前は私が勝手に言っている言葉なので，キャッシュなどと表現していただいても構いません。要はデータベース等から値を取ってきて，メモリ上に保持しておくエリアをStaticValuesというフォルダーに集めておくという考え方です。データベースの値なので，アプリケーションに１つでいいので，Staticで保持している値という言うことでStaticValueという名前にしています。例えばデータベースのマスターデータなどは，基本的に変化がないので，毎回データベースにアクセスするのは無駄な処理だったりします。そういう場合は，起動時に保持しておいて，そのままメモリ上の値を使うことがありますが，そのような場合に使用します。あとは，大量データにアクセスが必要な場合などは，一度だけ値を取得して，保持しておきたいケースなどがあります。

Sharedとの違い

メモリ上に保持するという点ではSharedクラスも同じですが，Sharedは，単体の値を保持する場合に使います。例えばデータベースの接続先や，ログインユーザー情報，設定ファイルの値等です。StaticValuesは例えば商品マスターの全件など，データベースの表をそのまま保持するイメージです。もちろんデータベースの表のままでなくても，結合した表の保持でもかまいません。

StaticValuesの必要性

StaticValuesフォルダーの狙いは，アプリケーションで保持している値を明確にするためです。StaticValuesフォルダーに書かずに，ドメイン層の適当な場所でstaticなListを宣言して，覚えておくことは可能ですが，各プログラマーが，勝手な場所で値を覚えてしまっては，アプリケーション全体で，どのような値を保持しているかが，管理できなくなります。同じような値を重複して保持したり，プログラム全体を読み返さないと理解できないプログラムになってしまいます。アプリケーション全体で，どのような値をメモリ上に保持しているかを明確にしておくのがいい実装といえます。

StaticValuesフォルダーの作成

Domainプロジェクトの直下に「StaticValues」フォルダーを作成します。このフォルダーの中に，メモリ上に覚えておく単位でクラスを作っておきます。商品マスターを覚えるのであれば，Productsクラスで１つにするなどです。

Measuresクラスの作成

例えば，計測値の直近値をエリアIDごとにメモリ上に保持しておくのであれば，MeasureEntityのリストを管理するMeasuresクラスをStaticValuesフォルダーに作成します。

StaticValuesフォルダーを右クリックして，新しいクラスを追加し，名前を「Measures」とします。

Measuresクラスの実装

Measuresクラスに次のように実装します。

using NDDD.Domain.Entities;
using NDDD.Domain.Repositories;
using NDDD.Domain.ValueObjects;
using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace NDDD.Domain.StaticValues
{
    public static class Measures
    {
        private static List _entities
            = new List();

        public static void Create(IMeasureRepository repository)
        {
            lock (((ICollection)_entities).SyncRoot)
            {
                _entities.Clear();
                _entities.AddRange(repository.GetLatests());
            }
        }

        public static MeasureEntity GetLatest(AreaId areaId)
        {
            lock (((ICollection)_entities).SyncRoot)
            {
                return _entities.Find(x => x.AreaId == areaId);
            }
        }
    }
}

• クラス自体をどこからでも使えて，アプリケーションでただ一つとするためにpublicでstaticなものにします。

• MeasureEntityのリストを保持するためにprivateで_entitiesを宣言します。
• Createメソッドでクリアーして，データベースより直近値のリストを作成し，AddRangeでリストに追加しています。GetLatestsのメソッドはまだないので，後程作成します。
• GetLatestメソッドにAreaIdを指定させて，FindでMeasureEntityを返却しています。これで，メモリ上の値を検索して外部から取得することができます。
• _entitiesにアクセスする部分は，非同期に取得される可能性があり，リストを作りかけの状態などでアクセスされるとバグになるので，Lockキーワードで処理中は他のスレッドからアクセスできないようにロックしています。この実装を忘れると，意味の解らないバグが生まれだすので，注意してください。

IMeasureRepositoryにGetLatestsメソッドを追加

次のようにGetLatestsメソッドを追加し，AreaIdごとの直近値のリストを返却できるようにします。

using NDDD.Domain.Entities;
using System.Collections.Generic;

namespace NDDD.Domain.Repositories
{
    public  interface IMeasureRepository
    {
        MeasureEntity GetLatest();

        IReadOnlyList GetLatests();
    }
}

MeasureFakeクラスにGetLatestsメソッドを追加

MeasureFakeクラスにGetLatestsメソッドを追加します。AreaIdごとの直近値に見立てたデータを返却するようにします。

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

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),
                    Convert.ToSingle(value));
            }
            catch(Exception ex)
            {
                throw new FakeException(
                    "MeasureFakeの取得に失敗しました",
                    ex);
                //return new MeasureEntity(
                //    10,
                //    Convert.ToDateTime("2020/12/12 12:34:56"),
                //    123.341f);
            }
        }

        public IReadOnlyList GetLatests()
        {
            var result = new List();
            result.Add(
                new MeasureEntity(
                    10,
                    Convert.ToDateTime("2020/12/12 12:34:56"),
                    123.341f));

            result.Add(
              new MeasureEntity(
                  20,
                  Convert.ToDateTime("2020/12/12 12:34:56"),
                  223.341f));
            result.Add(
              new MeasureEntity(
                  30,
                  Convert.ToDateTime("2020/12/12 12:34:56"),
                  323.341f));

            return result;
        }
    }
}

MeasureSqlServerクラスにGetLatestsメソッドを追加

MeasureSqlServerクラスにGetLatestsメソッドを追加します。コードを自動生成して，未実装の例外が通知されるようにしておきます。

using NDDD.Domain.Entities;
using NDDD.Domain.Repositories;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace NDDD.Infrastructure.SqlServer
{
    internal sealed class MeasureSqlServer : IMeasureRepository
    {
        public MeasureEntity GetLatest()
        {
            throw new NotImplementedException();
        }

        public IReadOnlyList GetLatests()
        {
            throw new NotImplementedException();
        }
    }
}

Measuresクラスへのアクセス

前回作成したLatestTimerクラスから，定期的に直近値を取得する処理を実装してみましょう。タイマー通知がされるたびに，MeasuresのCreateメソッドを呼びだし，リストを更新しています。Startメソッドの中身を_timer.Change(0, 10000);として，0ミリ秒後から10秒間隔で動作するようにしています。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Threading;
using NDDD.Domain.StaticValues;
using NDDD.Infrastructure;

namespace NDDD.WinForm.BackgroundWorkers
{
    internal static class LatestTimer
    {
        private static Timer _timer;
        private static bool _isWork = false;

        static LatestTimer()
        {
            _timer = new Timer(Callback);
        }

        internal static void Start()
        {
            _timer.Change(0, 10000);
        }

        internal static void Stop()
        {
            _timer.Change(Timeout.Infinite, Timeout.Infinite);
        }

        private static void Callback(object o)
        {
            if (_isWork)
            {
                return;
            }

            try
            {
                _isWork = true;
                Measures.Create(Factories.CreateMeasure());
            }
            finally
            {
                _isWork = false;
            }
        }
    }
}

LatestViewModelからのアクセス

LatestViewModelのSearchメソッドで，GetLatestで直近値検索している部分を，Measuresクラスのメモリ上の値を取得するように変更することができます。先ほどタイマークラスで10秒に1回Measuresクラスのリストを更新しているので，その10秒のタイムラグがあるデータでよい場合は次のようにして，メモリ上の値を取得することができます。

AreaIdの10は例です。このように記述すると，メモリ上の値を取得するため，データベースへのアクセスをなくすことができます。リアルタイムな値が必要な場合は使用できませんが，マスターの値など，変化のないものの場合は，活用できると思います。

タイマーの開始

ProgramクラスにLatestTimer.Start();を追記して，プログラム開始と同時にタイマーが動作するようにします。これで，10秒おきにMeasuresクラスのリストが更新されるようになります。

using NDDD.WinForm.BackgroundWorkers;
using NDDD.WinForm.Views;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using System.Windows.Forms;

namespace NDDD.WinForm
{
    static class Program
    {
        private static log4net.ILog _logger =
            log4net.LogManager.GetLogger(
                System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);

        ///
        /// アプリケーションのメイン エントリ ポイントです。
        /// 
        [STAThread]
        static void Main()
        {
            Application.EnableVisualStyles();
            Application.SetCompatibleTextRenderingDefault(false);

            _logger.Debug("デバッグのログ");
            _logger.Info("インフォのログ");
            _logger.Warn("警告のログ");
            _logger.Error("エラーのログ");
            _logger.Fatal("致命的なログ");

            LatestTimer.Start();

            Application.Run(new LoginView());
        }
    }
}

この状態でプログラムを実行すれば，Measuresクラスのリストが更新され，使用できることが確認できます。