MVVMで処理をループさせViewへ通知する際の実装方法

Question

前提

MVVMで、Viewのボタンを押したらその後一定間隔で対象機へポーリングし、実行結果をViewへ通知するような仕組みを作ろうとしています。
※MVVM初心者。

MVVMでやるとなった場合に、どこでタイマーを稼働させるべきなのか(Command？Model？)、Modelだったとした場合はModelへ更にViewModelのインスタンスを渡すようにするのか、通常の実装方法が分かりませんでした。
※後者ではできそうだとは思っています。

解決したいこと

• 一般的にどう実装するものなのか、教えていただきたいです。
  • どこでタイマーを稼働させるべきなのか(Command？Model？)
  • Modelだったとした場合はModelへ更にViewModelのインスタンスを渡すようにするのか

補足情報（FW/ツールのバージョンなど）

VS2022 .NET6

Answer 1

どこでタイマーを稼働させるべきなのか(Command？Model？)

それが一連の処理なら、ModelなりServiceなりになるんじゃないでしょうか（少なくともViewModelではないような）

Modelだったとした場合はModelへ更にViewModelのインスタンスを渡すようにするのか

MVVMでModelがViewModelを参照することはありません。

<Window
  x:Class="Qu1hlld0oo83bby.MainWindow"
  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  Width="800"
  Height="450">
  <StackPanel>
    <Button Command="{Binding StartPollingCommand}" Content="StartPolling（連打可）" />
    <Button Command="{Binding StartPolling2Command}" Content="StartPolling2（連打不可）" />
    <TextBlock Text="{Binding Model.Result}" />

    <Button Command="{Binding GetResultCommand}" Content="GetResult（連打不可）" />
    <TextBlock Text="{Binding Result}" />
  </StackPanel>
</Window>

using System;
using System.Threading;
using System.Threading.Tasks;
using System.Windows;
using CommunityToolkit.Mvvm.ComponentModel;
using CommunityToolkit.Mvvm.Input;

namespace Qu1hlld0oo83bby
{
    // ModelがINotifyPropertyChangedを実装し変更通知する
    public partial class Model : ObservableObject
    {
        [ObservableProperty]
        // ↓がソースジェネレータで生成されています
        //public string? Result { get => result; set => SetProperty(ref result, value); }
        private string? result;

        private int count;

        public void StartPolling()
        {
            for (var i = 0; i < 20; i++)
            {
                Thread.Sleep(100);
            }

            Result = $"{count++}";
        }
    }

    // 結果を取得できればいいだけのようなイメージでService
    public class Service
    {
        private int count;

        public async Task<string> GetResultAsync()
        {
            for (var i = 0; i < 20; i++)
            {
                await Task.Delay(TimeSpan.FromMilliseconds(100));
            }

            return $"{count++}";
        }
    }

    public partial class ViewModel : ObservableObject
    {
        public Model Model { get; } // ラップするのがめんどいので直公開ｗ

        [ObservableProperty]
        private string? result;

        private Service service;

        public ViewModel(Model model, Service service)
        {
            Model = model;
            this.service = service;
        }

        [RelayCommand]
        // ↓がソースジェネレータで生成されています
        //private RelayCommand? startPollingCommand;
        //public IRelayCommand StartPollingCommand => startPollingCommand ??= new RelayCommand(StartPolling);
        private void StartPolling()
        {
            Task.Run(() => Model.StartPolling()); // 投げっぱなし
        }

        [RelayCommand]
        private async Task StartPolling2Async()
        {
            await Task.Run(() => Model.StartPolling());
        }

        [RelayCommand]
        private async Task GetResultAsync()
        {
            Result = await service.GetResultAsync();
        }
    }

    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();

            DataContext = new ViewModel(new Model(), new Service());
        }
    }
}

NuGet Gallery | CommunityToolkit.Mvvm 8.0.0
MVVM Toolkit の概要 - .NET Community Toolkit | Microsoft Docs

---

タイミングが悪いことに、今現在VSがバグっていてエラーが出ますｗ（回避コードを追加してください）
CommunityToolKit.Mvvm source generators run twice on Visual Studio 17.2.6 · Issue #343 · CommunityToolkit/dotnet
.csproj

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>WinExe</OutputType>
    <TargetFramework>net6.0-windows</TargetFramework>
    <Nullable>enable</Nullable>
    <UseWPF>true</UseWPF>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="CommunityToolkit.Mvvm" Version="8.0.0" />
  </ItemGroup>

  <Target Name="RemoveDuplicateAnalyzers" BeforeTargets="CoreCompile">
    <!-- Work around https://github.com/dotnet/wpf/issues/6792 -->

    <ItemGroup>
      <FilteredAnalyzer Include="@(Analyzer->Distinct())" />
      <Analyzer Remove="@(Analyzer)" />
      <Analyzer Include="@(FilteredAnalyzer)" />
    </ItemGroup>
  </Target>
  
</Project>

---

この処理に「進捗報告する・キャンセル対応する」等があると、また話が変わってきます。
wpf iprogress - Google 検索

Comments

[locoJr.]

ご回答ありがとうございます。
今更ながらMVVMの勉強をしており、まずはFWを使わずに標準の実装方法でやっていました。
※参考サイト：https://resanaplaza.com/%e4%b8%96%e7%95%8c%e3%81%a7%e4%b8%80%e7%95%aa%e7%9f%ad%e3%81%84%e3%82%b5%e3%83%b3%e3%83%97%e3%83%ab%e3%81%a7%e8%a6%9a%e3%81%88%e3%82%8bmvvm%e5%85%a5%e9%96%80/

Prismなどはそのあとでやろうとしていましたが、「CommunityToolkit.Mvvm」とやらを使うとかなり記述が減らせそうですね。
一旦作り終わってから、このやり方でリファクタリングしてみようと思います。

また、INotifyPropertyChangedはModelにも実装して良いのですね。
ViewModelだけという縛りだと思っていました。

> この処理に「進捗報告する・キャンセル対応する」等があると、また話が変わってきます。
すみません、質問時に具体的にどの結果をバインドしたいのか記述するべきでした。
今回は単純な処理結果をバインドしたいわけではなく、「都度タイマーElapsedイベントでモデル側の処理を実行させ、非同期で実行結果(bool)と実行結果詳細(複数のプロパティ)をバインドさせる」ことをしたいです。
※非同期や後者(適切でないと仰った、ModelからViewModelへの通知)での実装はできております。

ただ、INotifyPropertyChangedをModelにも実装すればいけそうですね。
提示いただいた内容は、MVVMから逸脱はしない感じですか？
※ModelがModel+ViewModelになっている？

[TN8001]

> 今更ながらMVVMの勉強をしており、まずはFWを使わずに標準の実装方法でやっていました。

INotifyPropertyChanged・ICommand実装についてはフレームワークというほどのものでもなく、実装できていれば何でもいいです^^（自分で書くのはだるいのと文字制限もあるので既存のものを使用しました）

その辺のブログのコードでもいいですし、↓この辺りを使ってもいいでしょう。
[TemplateStudio/Observable.cs at main · microsoft/TemplateStudio](https://github.com/microsoft/TemplateStudio/blob/main/code/SharedFunctionality.UI/Mvvm/Observable.cs)
[TemplateStudio/RelayCommand.cs at main · microsoft/TemplateStudio](https://github.com/microsoft/TemplateStudio/blob/main/code/SharedFunctionality.UI/Mvvm/RelayCommand.cs)

Prism.Coreにも入っています（BindableBase・DelegateCommand）
[NuGet Gallery | Prism.Core 8.1.97](https://www.nuget.org/packages/Prism.Core/)

今回.NET6とのことでしたので、高パフォーマンスなCommunityToolkit.Mvvmを採用しました。
[dotnet/ObservableObject.cs at main · CommunityToolkit/dotnet](https://github.com/CommunityToolkit/dotnet/blob/main/CommunityToolkit.Mvvm/ComponentModel/ObservableObject.cs)
[dotnet/RelayCommand.cs at main · CommunityToolkit/dotnet](https://github.com/CommunityToolkit/dotnet/blob/main/CommunityToolkit.Mvvm/Input/RelayCommand.cs)

> また、INotifyPropertyChangedはModelにも実装して良いのですね。
> ViewModelだけという縛りだと思っていました。

Livet作者の尾上さんの記事
[MVVMのModelにまつわる誤解 - the sea of fertility](https://ugaya40.hateblo.jp/entry/model-mistake)

ReactiveProperty作者の河合さんの記事
[neue cc - ReactiveProperty ver 0.3.0.0 - MとVMのバインディングという捉え方](https://neue.cc/2011/11/20_354.html)

どちらもModelにも使っています。
過去（WPF初期のころ）議論があったようですが、現在は「使ってもよい」という共通認識だと思います。

> 今回は単純な処理結果をバインドしたいわけではなく、「都度タイマーElapsedイベントでモデル側の処理を実行させ、非同期で実行結果(bool)と実行結果詳細(複数のプロパティ)をバインドさせる」ことをしたいです。

Model層ならSystem.Timers.Timerで問題ないです（「DispatcherTimerでなくてよい」という意味）

> ただ、INotifyPropertyChangedをModelにも実装すればいけそうですね。

そうですね。

> 提示いただいた内容は、MVVMから逸脱はしない感じですか？
> ※ModelがModel+ViewModelになっている？

どうでしょうね。
わたしはMVVM原理主義者ではないので厳格に守る気はさらさらないのですが、「Modelの直公開」なんかは怒る人もいるかもしれませんｗ
ラップすること自体は（めんどくさいだけで）簡単ですけど、「コードが増えるだけでそれ意味あんの？」感がしてしまって（ReactivePropertyを使えれば簡単＆省コードで済みます）

ちゃんとMVVMしようとするほどコードが膨れ上がるので、規模が小さいうちはある程度の妥協は気にしてません^^;

重要視しているのはテスタビリティですね（単体テストができない（しにくい）のは、何かがおかしいとみて間違いないです）
別に100%も狙いませんしViewもテストしませんが、大事なとことか異常系はしっかり押さえたいです。
疎結合やDIなんかは、必要になってから意識するような感じです。

ちょっとしたツール程度しか作らない趣味グラマなんで、プロの方のご意見は違うかもしれません^^;

[locoJr.]

たくさん教えていただき、ありがとうございます。
INotifyPropertyChanged・ICommand実装などでは、色々なパターン(実装コード)があるのですね。

ModelでINotifyPropertyChangedが使える(使うのがアンチパターンではない)と聞けて良かったです！
※わざわざViewModelへプロパティを設定するなど、『無駄なコード感』があったためです。

今回は、Model層にSystem.Timers.Timerをセットし、処理することにしました。

「ReactiveProperty」←この辺の単語も、後日リファクタ時に確認してみます！

そうですね、重要な処理や異常系はテスト必須ですね。
自分も100%は現実的ではないと考えていますので、基本的なパスを通す&ある程度のパスを通すようにしています。

選択肢を提示していただいたり、ご自分の場合ならどうするかなど、大変勉強になりました。
ありがとうございます。
一旦初期段階の実装が完了したため、いただいた情報よりリファクタを進めてみます。

本当にありがとうございました！！