0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

MVVMで画面を開いたときの初期処理はどこに書く?|コンストラクタ・Loaded・OnAppearing・InitializeAsyncの使い分け【外伝G33】

0
Posted at

連載Index(読む順・公開済リンクが最新)
S00_門前の誓い_総合Index

MVVMで画面を作り始めると、次に迷いやすいのがこれです。

一覧の取得やAPI呼び出しは、画面を開いたタイミングでどこに書けばよいのか?

ViewModelのコンストラクタに書くのか。
WPFのLoadedに書くのか。
.NET MAUIのOnAppearingに書くのか。
それともInitializeAsyncのようなメソッドを作るのか。

結論から書くと、役割は次のように分けると崩れにくくなります。

処理 置き場所
画面が表示されたことを検知する View
初期読み込みを開始する ViewModel
API・DB・ファイルアクセス Service / Repository
読み込み中・エラー・表示データの状態管理 ViewModel
ダイアログ表示、画面遷移、画面固有の操作 View

つまり、WPFのLoadedやMAUIのOnAppearingは、あくまで「画面が表示された」という通知をViewModelへ渡す場所です。

実際のデータ取得処理までView側へ書くと、MVVMとして分けた意味が薄くなります。


この記事で扱う構成

今回は、ユーザー一覧を画面表示時に取得する例で整理します。

  • WPFまたは.NET MAUI
  • CommunityToolkit.Mvvm
  • 非同期で一覧を取得する
  • 読み込み中の状態を画面へ表示する
  • エラーを画面へ出す
  • 画面を閉じた時は処理をキャンセルできる

NuGetでは次を追加している前提です。

CommunityToolkit.Mvvm
Microsoft.Extensions.Logging.Abstractions

先に結論:判断基準

初期処理をどこへ置くかは、次の基準で決めると迷いにくくなります。

状況 基本方針
依存性を受け取る、初期値を設定するだけ ViewModelのコンストラクタ
画面表示時に一覧・API・DBを読み込む ViewModelのInitializeAsync
画面が表示されたことを検知する WPFのLoaded、MAUIのOnAppearing
画面を再表示するたびに最新化したい RefreshAsyncを呼ぶ
画面を閉じたら読み込みを止めたい CancellationTokenでキャンセル
画面遷移や確認ダイアログを出す Viewまたは画面遷移用Service

特に避けたいのは、ViewModelのコンストラクタで重い処理を始めることです。


コンストラクタに非同期処理を書かない方がよい理由

例えば、次のような書き方です。

public UserListViewModel(IUserService userService)
{
    _userService = userService;

    LoadUsersAsync();
}

一見すると短く書けますが、問題があります。

  • コンストラクタはawaitできない
  • 例外処理の置き場所が曖昧になる
  • 画面がまだ表示されていない段階で通信が始まる
  • テスト時にも勝手に通信が走る
  • DIコンテナで生成しただけで副作用が起きる
  • 画面を開くたびに何回呼ばれるのか追いにくい
  • キャンセルや再読み込みの設計を足しにくい

コンストラクタは、依存性の受け取りと、最低限の初期状態の設定に留めた方が安全です。

public UserListViewModel(IUserService userService)
{
    _userService = userService;

    Users = new ObservableCollection<UserSummary>();
    ErrorMessage = string.Empty;
}

「初期化」という言葉は広いですが、実務では次の二つを分けて考えるとよいです。

種類 内容
オブジェクトの初期化 コンストラクタで行う
画面表示後のデータ初期化 InitializeAsyncで行う

責務を分けた実装例

まず、一覧取得用のServiceを用意します。

public sealed class UserSummary
{
    public int Id { get; set; }

    public string Name { get; set; } = string.Empty;
}

public interface IUserService
{
    Task<IReadOnlyList<UserSummary>> GetUsersAsync(
        CancellationToken cancellationToken);
}

次にViewModelです。

ポイントは次の4つです。

  • 画面表示時の初期取得はInitializeAsync
  • 手動の再読み込みはRefreshAsync
  • 表示用状態はIsLoading、ErrorMessage、Users
  • 画面を閉じた場合に備えてキャンセルできる
using System.Collections.ObjectModel;
using CommunityToolkit.Mvvm.ComponentModel;
using CommunityToolkit.Mvvm.Input;
using Microsoft.Extensions.Logging;

public partial class UserListViewModel : ObservableObject
{
    private readonly IUserService _userService;
    private readonly ILogger<UserListViewModel> _logger;

    private CancellationTokenSource? _loadCancellationTokenSource;

    public UserListViewModel(
        IUserService userService,
        ILogger<UserListViewModel> logger)
    {
        _userService = userService;
        _logger = logger;
    }

    public ObservableCollection<UserSummary> Users { get; }
        = new ObservableCollection<UserSummary>();

    [ObservableProperty]
    private bool _isLoading;

    [ObservableProperty]
    private bool _isInitialized;

    [ObservableProperty]
    private string _errorMessage = string.Empty;

    [RelayCommand(CanExecute = nameof(CanInitialize))]
    private async Task InitializeAsync()
    {
        IsInitialized = await LoadCoreAsync();
    }

    [RelayCommand(CanExecute = nameof(CanRefresh))]
    private async Task RefreshAsync()
    {
        await LoadCoreAsync();
    }

    private bool CanInitialize()
    {
        return !IsInitialized && !IsLoading;
    }

    private bool CanRefresh()
    {
        return !IsLoading;
    }

    private async Task<bool> LoadCoreAsync()
    {
        if (IsLoading)
        {
            return false;
        }

        var currentCancellationTokenSource =
            new CancellationTokenSource();

        _loadCancellationTokenSource =
            currentCancellationTokenSource;

        try
        {
            IsLoading = true;
            ErrorMessage = string.Empty;

            var users = await _userService.GetUsersAsync(
                currentCancellationTokenSource.Token);

            Users.Clear();

            foreach (var user in users)
            {
                Users.Add(user);
            }

            return true;
        }
        catch (OperationCanceledException)
            when (currentCancellationTokenSource.IsCancellationRequested)
        {
            return false;
        }
        catch (Exception ex)
        {
            _logger.LogError(ex, "ユーザー一覧の取得に失敗しました。");

            ErrorMessage =
                "一覧を取得できませんでした。通信状態を確認して、もう一度試してください。";

            return false;
        }
        finally
        {
            if (ReferenceEquals(
                _loadCancellationTokenSource,
                currentCancellationTokenSource))
            {
                _loadCancellationTokenSource = null;
            }

            currentCancellationTokenSource.Dispose();

            IsLoading = false;
        }
    }

    public void CancelLoading()
    {
        _loadCancellationTokenSource?.Cancel();
    }

    partial void OnIsLoadingChanged(bool value)
    {
        InitializeCommand.NotifyCanExecuteChanged();
        RefreshCommand.NotifyCanExecuteChanged();
    }

    partial void OnIsInitializedChanged(bool value)
    {
        InitializeCommand.NotifyCanExecuteChanged();
    }
}

このViewModelでは、画面がどう表示されるかは知りません。

WPFなのか、MAUIなのか、ダイアログなのか、画面遷移なのかはView側の責務です。

ViewModelが持つのは、あくまで次の状態です。

一覧を読み込み中か
初期読み込み済みか
取得結果は何か
エラーがあるか
再読み込みできるか

WPFではLoadedからViewModelを呼ぶ

WPFでは、WindowまたはUserControlのLoadedを入口にします。

XAMLは次のようにします。

<Window x:Class="SampleApp.UserListWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="ユーザー一覧"
        Width="640"
        Height="420"
        Loaded="OnLoaded">

    <Grid Margin="16">
        <Grid.RowDefinitions>
            <RowDefinition Height="Auto" />
            <RowDefinition Height="*" />
            <RowDefinition Height="Auto" />
        </Grid.RowDefinitions>

        <StackPanel Orientation="Horizontal">
            <Button Width="110"
                    Content="再読み込み"
                    Command="{Binding RefreshCommand}" />

            <TextBlock Margin="12,0,0,0"
                       VerticalAlignment="Center"
                       Text="読み込み中..."
                       Visibility="{Binding IsLoading,
                                            Converter={StaticResource BooleanToVisibilityConverter}}" />
        </StackPanel>

        <DataGrid Grid.Row="1"
                  Margin="0,12,0,12"
                  ItemsSource="{Binding Users}"
                  IsReadOnly="True"
                  AutoGenerateColumns="True" />

        <TextBlock Grid.Row="2"
                   Foreground="Crimson"
                   TextWrapping="Wrap"
                   Text="{Binding ErrorMessage}" />
    </Grid>
</Window>

コードビハインドでは、画面表示の通知だけを渡します。

using System;
using System.Windows;

public partial class UserListWindow : Window
{
    private readonly UserListViewModel _viewModel;

    public UserListWindow(UserListViewModel viewModel)
    {
        InitializeComponent();

        _viewModel = viewModel;
        DataContext = _viewModel;
    }

    private async void OnLoaded(
        object sender,
        RoutedEventArgs e)
    {
        try
        {
            await _viewModel.InitializeCommand.ExecuteAsync(null);
        }
        catch
        {
            MessageBox.Show(
                "予期しないエラーが発生しました。",
                "エラー",
                MessageBoxButton.OK,
                MessageBoxImage.Error);
        }
    }

    protected override void OnClosed(EventArgs e)
    {
        _viewModel.CancelLoading();

        base.OnClosed(e);
    }
}

ここでasync voidを使っていますが、イベントハンドラは例外です。

避けたいのは、ViewModelやServiceの通常メソッドをasync voidにすることです。

場所 async void
WPFのLoadedイベント 可
ボタンクリックイベント 可
ViewModelの処理 不可。Taskにする
Serviceの処理 不可。Taskにする

WPFでLoadedに全部書かない

次のような書き方は、動くことはあります。

private async void OnLoaded(object sender, RoutedEventArgs e)
{
    LoadingPanel.Visibility = Visibility.Visible;

    try
    {
        var users = await _userService.GetUsersAsync(
            CancellationToken.None);

        UserGrid.ItemsSource = users;
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
    finally
    {
        LoadingPanel.Visibility = Visibility.Collapsed;
    }
}

ただし、このまま画面が増えると困ります。

  • 読み込み中表示が各画面で重複する
  • エラー文言の扱いが画面ごとにばらつく
  • テストでViewを起動しないと処理を確認できない
  • 再読み込みボタンの処理を別に書く必要がある
  • 別画面でも同じ一覧を使いたくなった時に再利用しにくい

Loadedは「きっかけ」、処理本体はViewModelへ置く方が保守しやすくなります。


.NET MAUIではOnAppearingを使う

.NET MAUIでは、画面が表示されるたびにOnAppearingが呼ばれます。

ただし、ここはWPFのLoadedより注意が必要です。

画面遷移で戻ってきた時にも呼ばれるため、毎回一覧を取り直したいのか、初回だけでよいのかを決める必要があります。

初回だけ読み込む例です。

public partial class UserListPage : ContentPage
{
    private readonly UserListViewModel _viewModel;

    public UserListPage(UserListViewModel viewModel)
    {
        InitializeComponent();

        _viewModel = viewModel;
        BindingContext = _viewModel;
    }

    protected override async void OnAppearing()
    {
        base.OnAppearing();

        if (_viewModel.IsInitialized)
        {
            return;
        }

        try
        {
            await _viewModel.InitializeCommand.ExecuteAsync(null);
        }
        catch
        {
            await DisplayAlert(
                "エラー",
                "予期しないエラーが発生しました。",
                "閉じる");
        }
    }

    protected override void OnDisappearing()
    {
        _viewModel.CancelLoading();

        base.OnDisappearing();
    }
}

毎回最新化したい画面なら、次のように切り替えます。

protected override async void OnAppearing()
{
    base.OnAppearing();

    try
    {
        await _viewModel.RefreshCommand.ExecuteAsync(null);
    }
    catch
    {
        await DisplayAlert(
            "エラー",
            "予期しないエラーが発生しました。",
            "閉じる");
    }
}

ただし、何でも毎回再読み込みすればよいわけではありません。

一覧が重い、通信量が大きい、API制限がある場合は、画面復帰のたびに再取得すると体験が悪くなります。


初回だけ読むか、毎回更新するかの判断基準

画面の種類 推奨
設定画面 初回だけ取得
マスタ一覧 初回取得+明示的な再読み込み
通知一覧 画面復帰時に更新を検討
在庫・受注・進捗一覧 業務要件次第で再取得
ダッシュボード 一定時間経過後のみ再取得
編集画面 基本は再取得しない。競合検知を別設計にする

例えば、前回取得から5分以上経過した時だけ更新するなら、ViewModelに最終取得時刻を持たせる方法があります。

private DateTimeOffset? _lastLoadedAt;

private bool ShouldRefresh()
{
    if (_lastLoadedAt is null)
    {
        return true;
    }

    return DateTimeOffset.Now - _lastLoadedAt.Value
        >= TimeSpan.FromMinutes(5);
}

ただし、業務システムでは「5分以内なら古くてもよいのか」が先に決まっている必要があります。

技術的に可能かより、画面で扱うデータの鮮度要件を確認する方が重要です。


よくある失敗パターン

1. ViewModelのコンストラクタでAPIを呼ぶ

public UserListViewModel(IUserService userService)
{
    _userService = userService;

    _ = LoadUsersAsync();
}

問題は、いつ始まったのか、失敗したのか、キャンセルできるのかが追いにくいことです。

特に_ =で処理を捨てる書き方は、例外を見失いやすくなります。


2. Loadedで処理を全部書く

private async void OnLoaded(object sender, RoutedEventArgs e)
{
    var users = await _userService.GetUsersAsync(
        CancellationToken.None);

    UserGrid.ItemsSource = users;
}

小さな画面なら動きますが、画面数が増えるほど重複します。

Viewに置くのは「表示された」という通知までにします。


3. 読み込み中の状態がない

通信中なのに画面が無反応だと、利用者はボタンを連打します。

結果として、二重送信、二重取得、二重登録の原因になります。

最低でも次は持たせた方がよいです。

IsLoading
ErrorMessage
再読み込みコマンドの実行可否

IsLoadingは見た目のためだけではありません。

処理の二重起動を抑えるための状態でもあります。


4. 例外を画面へそのまま出す

catch (Exception ex)
{
    ErrorMessage = ex.ToString();
}

開発中は便利ですが、利用者へ表示する文言としては不適切です。

内部ログには例外の詳細を残し、画面には状況と次の行動を書きます。

_logger.LogError(ex, "ユーザー一覧の取得に失敗しました。");

ErrorMessage =
    "一覧を取得できませんでした。通信状態を確認して、もう一度試してください。";

画面メッセージは、利用者が何をすればよいか分かることを優先します。


5. 画面を閉じても通信が続く

画面を閉じた後も通信やファイル読み込みが続くと、不要な処理が残ります。

特に画面遷移が多いアプリでは、キャンセルを考えておいた方がよいです。

protected override void OnClosed(EventArgs e)
{
    _viewModel.CancelLoading();

    base.OnClosed(e);
}

キャンセルしても、必ず処理が即座に止まるとは限りません。

呼び出しているAPI、DBドライバ、ファイル処理がCancellationTokenを受け取り、実際に対応している必要があります。


コードレビューで見る場所

レビュー時は、次を確認すると初期化処理の責務が崩れていないか判断しやすくなります。

確認項目 OKの状態
コンストラクタ DIと軽い初期値設定だけ
View 画面イベントをViewModelへ渡すだけ
ViewModel 状態、コマンド、エラー処理を持つ
Service API、DB、ファイルなど外部アクセスを持つ
非同期処理 Taskを返している
読み込み中 二重実行を抑えられる
エラー ログ詳細と画面文言が分かれている
キャンセル 画面離脱時に考慮されている
再表示時 初回のみか毎回更新かが決まっている

特に、「MVVMだからコードビハインドを一行も書かない」というルールには注意が必要です。

LoadedやOnAppearingでViewModelのコマンドを一回呼ぶ程度なら、責務は明確です。

無理にBehaviorや独自のライフサイクル通知基盤を増やして、初めて触る人が追えなくなる方が保守上の問題になることもあります。


まとめ

画面表示時の初期処理は、次の分け方が基本です。

View
  画面が表示されたことを検知する

ViewModel
  初期取得を開始する
  読み込み中・取得結果・エラーを管理する

Service
  API・DB・ファイルなど外部アクセスを行う

実装としては、次の形にしておくと画面が増えても崩れにくくなります。

コンストラクタ
  依存性の受け取りだけ

Loaded / OnAppearing
  InitializeCommandを呼ぶだけ

InitializeAsync
  初回のデータ取得

RefreshAsync
  明示的な再読み込み

LoadCoreAsync
  実際の取得、状態更新、例外処理、キャンセル対応

次にMVVMで迷いやすいのは、画面遷移時にパラメータをどう渡すか、編集画面で保存後に一覧をどう更新するかです。

このあたりも、InitializeAsyncとRefreshAsyncを分けておくと整理しやすくなります。

連載Index(読む順・公開済リンクが最新)
S00_門前の誓い_総合Index

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?