データが変更された場合、ほかのクラスにその変更を通知する必要がある際のクラス設計

Question

やりたいこと

C#と、WPFというWindowsアプリケーションを作成するためのフレームワークを用いて開発しているところです。

その際、「データが変更された場合、ほかのクラスに変更を通知する必要がある」というケースが出てきました。
例としてコードを挙げると以下の通りです。

public class Main
{
    public Main()
    {
        // dataを宣言、何らかの初期値が入る
        Data data = new Data(name, id);
        
        // dataを利用したクラスを4つ作成する。
        // ただし、これらのクラスはdataを書き換えることができる。
        // 変更が加わった際には、同じdataを利用している他のクラスに
        // 「データが変更された」ということを通知する必要がある。
        var a = new A(data);
        var b = new B(data);
        var c = new C(data);
        var d = new D(data);
    }
}

A,B,C,Dそれぞれのクラスは入力されたdataをいじくったとき、それをほかのクラスに通知する必要があります。
ただし、このdataが複数個そんざいすることは無く、必ずこのアプリケーション上で1つしか存在しないです。
この際のクラス設計について非常に悩んでいます。

現在考えている案

今のところ考えている案が下の2つになります。

1. デザインパターンの一つであるシングルトンとオブザーバーパターンをDataクラスに使用する。

やりたいことで挙げたように、「dataが複数個そんざいすることは無く、必ずこのアプリケーション上で1つしか存在しない」ことを利用し、Dataクラス本体を唯一のクラスであるシングルトンで書く。
かつ、シングルトンであるDataに変更が加わった場合、オブザーバーパターンをDataクラスとそれを利用しているA,B,C,Dに適用し、変更が加わったらそれを通知する。

2. A,B,C,DのクラスすべてにIDataChangeSenderなどのinterfaceを継承させ、変更が加わったら相互で通知させる。

IDataChangeSender、IDataChangeReceiverの2つのインターフェースを作成し、A,B,C,Dのすべてに適応させ、それぞれが変更を加えたら、「変更したのを新しく送るね」といった感じで引数としてdataを渡す。

これらの案に対して自分が思ったこと

1.に関して

もともとは1.で実装していたのですが、アプリケーション全体をリファクタリングしている最中に、「デザインパターンは悪」といった評価をネットで受けました。
また、「シングルトンをグローバル関数として使ってはいけない」ともかかれており、自分はそのような使い方をしていたため
直したほうがいいのかと、2を考えました。

2.に関して

現在は1から2の方法を実装している途中なのですが、インターフェースがごちゃごちゃになり、1.の時よりすっきりとコード全体を把握できなくなりそうと感じました。

改めて聞きたい事

このような「データが変更された場合、ほかのクラスにその変更を通知する必要がある際のクラス設計」に関して皆さんはどのようなアプローチをしますか?
また、1.2.の案についてなど思うところが知りたいです。
よろしくお願いします

Comments

[hihijiji]

MVVMパターンを検討してみてはいかがでしょう？
Prism Template Pack
https://marketplace.visualstudio.com/items?itemName=BrianLagunas.PrismTemplatePack
には全ての答えがあります。

Answer 1

こんばんは。

データが変更された場合、ほかのクラスにその変更を通知する

INotifyPropertyChangedという、もろそのもののインターフェイスが存在します。
WPFで開発しているとよくお世話になるものです。

インターフェイスを実装するか、あるいはPrismなどの実装を補助するフレームワークを利用することで変更通知が飛ぶようになります。

//using System.ComponentModel;
//using Prism.Mvvm;

// BindableBaseがINotifyPropertyChangedを実装してくれています。
public class Data : BindableBase
{
    private string _Value = string.Empty;
    public string Value
    {
        get => _Value;
        set => SetProperty(ref _Value, value);
    }
}

public class Observer
{
    Data data = new Data();
    
    public Observer()
    {
        data.PropertyChanged += (sender, e) =>
        {
            switch (e.PropertyName)
            {
                case nameof(Data.Value):
                    Console.WriteLine($"Valueプロパティの値が \"{data.Value}\" に変更されました");
                    break;
            }
        };
        
        data.Value = "hello"; // ここで変更通知が発火されます
    }
}

この他、Collectionの要素の変更を通知することができるObservableCollectionというものもあったりします。
詳しくは検索してみて下さい。

##(追記)参考：MVVMに沿った設計
WPFアプリはMVVMという設計思想に沿って設計するのが一般的となっています。
MVVMはModel-View-ViewModelの略で、

• ウィンドウやユーザーコントロールなど、画面への表示に直接関与するクラスをView
• ViewにBindingするプロパティを持つクラスをViewModel
• ロジックなどを持つクラスをModel

というように、クラスのメンバの役割によってクラスを分離し、コードを読みやすくすることが出来ます。

以下、MVVMパターンを適用して

• LabelにViewModelのValueを表示
• Buttonクリック時にViewModelのButtonClickedを実行

以上の機能を実装したサンプルです。

私がPrismerなのでPrismを利用して書きますが、各クラスは以下のような感じになります。
実行環境が手元に無いので、もしかしたら動かないかもしれません。動かなかった場合はごめんなさい。

###MainWindow (XAML)

<Window …略…>
    <StackPanel>
        <Label Content="{Binding Value}" />
        <Button Command="{Binding ButtonClicked}" />
    </StackPanel>
</Window>

###MainWindow (C#)

public class MainWindow : Window
{
    public MainWindow()
    {
        InitializeComponent();
        DataContext = new MainWindowViewModel(); // DataContextに指定したクラスの変更通知を受け取り、自動的に表示に反映するようになります。
    }
}

###ViewModel

//using Prism.Mvvm;
//using Prism.Commands;

// BindableBaseがINotifyPropertyChangedを実装してくれています。
// MainWindowなどのDataContextにこのクラスのインスタンスを指定して下さい。
public class MainWindowViewModel : BindableBase
{
    private string _Value = string.Empty;
    public string Value
    {
        get => _Value;
        set => SetProperty(ref _Value, value);
    }
    
    // MVVMでは、ボタンクリック時のメソッドなどもVMに書きます。
    // Xaml内でButtonに「Command="{Binding ButtonClicked}"」を設定すると使えるようになります。
    public DelegateCommand ButtonClicked { get; set; }
    
    public MainWindowViewModel()
    {
        ButtonClicked = new DelegateCommand(() => MessageBox.Show("ボタンが押されました"));
    }
}

MVVMパターンで開発する場合、変更通知はVM→V（とM→VM）で発生させることになります。
VがVMの変更通知を受け取る部分に関しては、XAMLコードをもとに自動的に処理してくれるので開発者はただVMにINotifyPropertyChangedを実装させてVのDataContextに指定するのみでOKです。
一方、VMがMの変更通知を受け取る部分に関しては、VMのコンストラクター内などでM.PropertyChanged += (sender, e) => { …略… };とすることになります。